feat: Recognize changes to remote URLs & support revision option

.github/workflows/lint.yml

@@ -47,6 +47,8 @@ jobs:
       - uses: actions-rust-lang/setup-rust-toolchain@v1
 
       - uses: EmbarkStudios/cargo-deny-action@v1
+        with:
+          rust-version: "1.84.0"
 
   audit:
     runs-on: ubuntu-latest

CHANGELOG.md

@@ -2,6 +2,15 @@
 
 ## Unreleased
 
+### Added
+
+- Support `[[items]] revision` property that accepts a tag, branch, or commit SHA1.
+
+### Changed
+
+- `tinty update` now keeps the items' `origin` remote URLs up-to-date.
+- The item repositories are now checked out to a specific commit SHA1 in "detached HEAD" mode.
+
 ### Fixed
 
 - Fix bug where period preceeding extension is still added to generated files even when an extension doesn't exist

Cargo.toml

@@ -27,3 +27,5 @@ toml = "0.8.19"
 url = "2.5.4"
 xdg = "2.5.2"
 home = "0.5.11"
+rand = "0.8.5"
+regex = "1.7"

README.md

@@ -260,6 +260,7 @@ themes across different applications seamlessly.
 |------------------------|----------|----------|---------------------------------------------------------------|---------|--------------------------------------------|
 | `name`                 | `string` | Required | A unique name for the item being configured.                  | - | `name = "vim"`                             |
 | `path`                 | `string` | Required | The file system path or URL to the theme template repository. Paths beginning with `~/` map to home dir. | - | `path = "https://github.com/tinted-tmux"` |
+| `revision`             | `string` | Optional | The Git revision to use.<br> Accepts a branch name, a tag, or a commit SHA1 | `main` | `revision = "1.2.0"` |
 | `themes-dir`           | `string` | Required | The directory within the repository where theme files are located. | - | `themes-dir = "colors"`                    |
 | `hook`                 | `string` | Optional | A command to be executed after the theme is applied. Useful for reloading configurations. `%f` template variable maps to the path of the applied theme file. | None    | `hook = "source ~/.vimrc"` |
 | `theme-file-extension` | `string` | Optional | Define a custom theme file extension that isn't `/\.*$/`. Tinty looks for themes named `base16-uwunicorn.*` (for example), but when the theme file isn't structured that way, this option can help specify the pattern. | - | `theme-file-extension = ".module.css"` |

src/config.rs

@@ -29,11 +29,13 @@ pub struct ConfigItem {
     pub supported_systems: Option<Vec<SchemeSystem>>,
     #[serde(rename = "theme-file-extension")]
     pub theme_file_extension: Option<String>,
+    pub revision: Option<String>,
 }
 
 impl fmt::Display for ConfigItem {
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
         let hook = self.hook.clone().unwrap_or_default();
+        let revision = self.revision.clone().unwrap_or_default();
         let default_supported_systems = vec![SchemeSystem::default()];
         let system_text = self
             .supported_systems
@@ -52,6 +54,9 @@ impl fmt::Display for ConfigItem {
         if !hook.is_empty() {
             writeln!(f, "hook = \"{}\"", hook)?;
         }
+        if !revision.is_empty() {
+            writeln!(f, "revision = \"{}\"", revision)?;
+        }
         writeln!(f, "supported-systems = [{}]", system_text)?;
         write!(f, "themes-dir = \"{}\"", self.themes_dir)
     }
@@ -108,6 +113,7 @@ impl Config {
             hook: Some(BASE16_SHELL_HOOK.to_string()),
             supported_systems: Some(vec![SchemeSystem::Base16]), // DEFAULT_SCHEME_SYSTEM
             theme_file_extension: None,
+            revision: None,
         };
 
         // Add default `item` if no items exist

src/constants.rs

@@ -7,3 +7,4 @@ pub const CUSTOM_SCHEMES_DIR_NAME: &str = "custom-schemes";
 pub const CURRENT_SCHEME_FILE_NAME: &str = "current_scheme";
 pub const DEFAULT_SCHEME_SYSTEM: &str = "base16";
 pub const SCHEME_EXTENSION: &str = "yaml";
+pub const SCHEMES_REPO_REVISION: &str = "spec-0.11";

src/operations/install.rs

@@ -1,5 +1,5 @@
 use crate::config::Config;
-use crate::constants::{REPO_DIR, SCHEMES_REPO_NAME, SCHEMES_REPO_URL};
+use crate::constants::{REPO_DIR, SCHEMES_REPO_NAME, SCHEMES_REPO_REVISION, SCHEMES_REPO_URL};
 use crate::utils::git_clone;
 use anyhow::{anyhow, Result};
 use std::fs::{remove_file as remove_symlink, symlink_metadata};
@@ -11,10 +11,11 @@ fn install_git_url(
     data_item_path: &Path,
     item_name: &str,
     item_git_url: &str,
+    revision: Option<&str>,
     is_quiet: bool,
 ) -> Result<()> {
     if !data_item_path.is_dir() {
-        git_clone(item_git_url, data_item_path)?;
+        git_clone(item_git_url, data_item_path, revision)?;
 
         if !is_quiet {
             println!("{} installed", item_name);
@@ -86,6 +87,7 @@ pub fn install(config_path: &Path, data_path: &Path, is_quiet: bool) -> Result<(
                 &data_item_path,
                 item.name.as_str(),
                 item.path.as_str(),
+                item.revision.as_deref(),
                 is_quiet,
             )?,
             Err(_) => install_dir(&data_item_path, item.name.as_str(), &item_path, is_quiet)?,
@@ -98,6 +100,7 @@ pub fn install(config_path: &Path, data_path: &Path, is_quiet: bool) -> Result<(
         &schemes_repo_path,
         SCHEMES_REPO_NAME,
         SCHEMES_REPO_URL,
+        Some(SCHEMES_REPO_REVISION),
         is_quiet,
     )?;
 

src/operations/update.rs

@@ -1,16 +1,28 @@
-use crate::constants::{REPO_DIR, SCHEMES_REPO_NAME, SCHEMES_REPO_URL};
-use crate::utils::{git_diff, git_pull};
+use crate::constants::{REPO_DIR, SCHEMES_REPO_NAME, SCHEMES_REPO_REVISION, SCHEMES_REPO_URL};
+use crate::utils::{git_is_working_dir_clean, git_update};
 use crate::{config::Config, constants::REPO_NAME};
 use anyhow::{Context, Result};
 use std::path::Path;
 
-fn update_item(item_name: &str, item_url: &str, item_path: &Path, is_quiet: bool) -> Result<()> {
+fn update_item(
+    item_name: &str,
+    item_url: &str,
+    item_path: &Path,
+    revision: Option<&str>,
+    is_quiet: bool,
+) -> Result<()> {
     if item_path.is_dir() {
-        let is_diff = git_diff(item_path)?;
+        let is_clean = git_is_working_dir_clean(item_path)?;
 
-        if !is_diff {
-            git_pull(item_path)
-                .with_context(|| format!("Error pulling {} from {}", item_name, item_url))?;
+        if is_clean {
+            git_update(item_path, item_url, revision).with_context(|| {
+                format!(
+                    "Error updating {} to {}@{}",
+                    item_name,
+                    item_url,
+                    revision.unwrap_or("main")
+                )
+            })?;
 
             if !is_quiet {
                 println!("{} up to date", item_name);
@@ -36,7 +48,13 @@ pub fn update(config_path: &Path, data_path: &Path, is_quiet: bool) -> Result<()
     for item in items {
         let item_path = hooks_path.join(&item.name);
 
-        update_item(item.name.as_str(), item.path.as_str(), &item_path, is_quiet)?;
+        update_item(
+            item.name.as_str(),
+            item.path.as_str(),
+            &item_path,
+            item.revision.as_deref(),
+            is_quiet,
+        )?;
     }
 
     let schemes_repo_path = hooks_path.join(SCHEMES_REPO_NAME);
@@ -45,6 +63,7 @@ pub fn update(config_path: &Path, data_path: &Path, is_quiet: bool) -> Result<()
         SCHEMES_REPO_NAME,
         SCHEMES_REPO_URL,
         &schemes_repo_path,
+        Some(SCHEMES_REPO_REVISION),
         is_quiet,
     )?;