Merge pull request #1067 from tmccombs/clap-derive

Clap derive

.github/workflows/CICD.yml

@@ -1,7 +1,7 @@
 name: CICD
 
 env:
-  MIN_SUPPORTED_RUST_VERSION: "1.57.0"
+  MIN_SUPPORTED_RUST_VERSION: "1.60.0"
   CICD_INTERMEDIATES_DIR: "_cicd-intermediates"
 
 on:
@@ -181,6 +181,11 @@ jobs:
         command: test
         args: --locked --target=${{ matrix.job.target }} ${{ steps.test-options.outputs.CARGO_TEST_OPTIONS}}
 
+    - name: Generate completions
+      id: completions
+      shell: bash
+      run: make completions
+
     - name: Create tarball
       id: package
       shell: bash
@@ -193,7 +198,6 @@ jobs:
         PKG_STAGING="${{ env.CICD_INTERMEDIATES_DIR }}/package"
         ARCHIVE_DIR="${PKG_STAGING}/${PKG_BASENAME}/"
         mkdir -p "${ARCHIVE_DIR}"
-        mkdir -p "${ARCHIVE_DIR}/autocomplete"
 
         # Binary
         cp "${{ steps.strip.outputs.BIN_PATH }}" "$ARCHIVE_DIR"
@@ -205,10 +209,7 @@ jobs:
         cp "README.md" "LICENSE-MIT" "LICENSE-APACHE" "CHANGELOG.md" "$ARCHIVE_DIR"
 
         # Autocompletion files
-        cp 'target/${{ matrix.job.target }}/release/build/${{ env.PROJECT_NAME }}'*/out/'${{ env.PROJECT_NAME }}.bash' "$ARCHIVE_DIR/autocomplete/"
-        cp 'target/${{ matrix.job.target }}/release/build/${{ env.PROJECT_NAME }}'*/out/'${{ env.PROJECT_NAME }}.fish' "$ARCHIVE_DIR/autocomplete/"
-        cp 'target/${{ matrix.job.target }}/release/build/${{ env.PROJECT_NAME }}'*/out/'_${{ env.PROJECT_NAME }}.ps1' "$ARCHIVE_DIR/autocomplete/"
-        cp 'contrib/completion/_fd' "$ARCHIVE_DIR/autocomplete/"
+        cp -r autocomplete "${ARCHIVE_DIR}"
 
         # base compressed package
         pushd "${PKG_STAGING}/" >/dev/null
@@ -256,9 +257,9 @@ jobs:
         gzip -n --best "${DPKG_DIR}/usr/share/man/man1/${{ env.PROJECT_NAME }}.1"
 
         # Autocompletion files
-        install -Dm644 'target/${{ matrix.job.target }}/release/build/${{ env.PROJECT_NAME }}'*/out/'${{ env.PROJECT_NAME }}.bash' "${DPKG_DIR}/usr/share/bash-completion/completions/${{ env.PROJECT_NAME }}"
-        install -Dm644 'target/${{ matrix.job.target }}/release/build/${{ env.PROJECT_NAME }}'*/out/'${{ env.PROJECT_NAME }}.fish' "${DPKG_DIR}/usr/share/fish/vendor_completions.d/${{ env.PROJECT_NAME }}.fish"
-        install -Dm644 'contrib/completion/_fd' "${DPKG_DIR}/usr/share/zsh/vendor-completions/_${{ env.PROJECT_NAME }}"
+        install -Dm644 'autocomplete/fd.bash' "${DPKG_DIR}/usr/share/bash-completion/completions/${{ env.PROJECT_NAME }}"
+        install -Dm644 'autocomplete/fd.fish' "${DPKG_DIR}/usr/share/fish/vendor_completions.d/${{ env.PROJECT_NAME }}.fish"
+        install -Dm644 'autocomplete/_fd' "${DPKG_DIR}/usr/share/zsh/vendor-completions/_${{ env.PROJECT_NAME }}"
 
         # README and LICENSE
         install -Dm644 "README.md" "${DPKG_DIR}/usr/share/doc/${DPKG_BASENAME}/README.md"

.gitignore

@@ -1,2 +1,3 @@
 target/
+/autocomplete/
 **/*.rs.bk

Cargo.toml

@@ -30,8 +30,6 @@ name = "fd"
 path = "src/main.rs"
 
 [build-dependencies]
-clap = { version = "3.1", features = ["cargo"] }
-clap_complete = "3.1"
 version_check = "0.9"
 
 [dependencies]
@@ -52,10 +50,11 @@ normpath = "0.3.2"
 chrono = "0.4"
 once_cell = "1.15.0"
 crossbeam-channel = "0.5.6"
+clap_complete = {version = "4.0", optional = true}
 
 [dependencies.clap]
-version = "3.1"
-features = ["suggestions", "color", "wrap_help", "cargo", "unstable-grouped"]
+version = "4.0.12"
+features = ["suggestions", "color", "wrap_help", "cargo", "unstable-grouped", "derive"]
 
 [target.'cfg(unix)'.dependencies]
 users = "0.11.0"
@@ -85,4 +84,6 @@ codegen-units = 1
 
 [features]
 use-jemalloc = ["jemallocator"]
-default = ["use-jemalloc"]
+completions = ["clap_complete"]
+base = ["use-jemalloc"]
+default = ["use-jemalloc", "completions"]

Makefile

@@ -0,0 +1,37 @@
+PROFILE=release
+EXE=target/$(PROFILE)/fd
+prefix=/usr/local
+bindir=$(prefix)/bin
+datadir=$(prefix)/share
+exe_name=fd
+
+$(EXE): Cargo.toml src/**/*.rs
+	cargo build --profile $(PROFILE)
+
+.PHONY: completions
+completions: autocomplete/fd.bash autocomplete/fd.fish autocomplete/fd.ps1 autocomplete/_fd
+
+comp_dir=@mkdir -p autocomplete
+
+autocomplete/fd.bash: $(EXE)
+	$(comp_dir)
+	$(EXE) --gen-completions bash > $@
+
+autocomplete/fd.fish: $(EXE)
+	$(comp_dir)
+	$(EXE) --gen-completions fish > $@
+
+autocomplete/fd.ps1: $(EXE)
+	$(comp_dir)
+	$(EXE) --gen-completions powershell > $@
+
+autocomplete/_fd: contrib/completion/_fd
+	$(comp_dir)
+	cp $< $@
+
+install: $(EXE) completions
+	install -Dm755 $(EXE) $(DESTDIR)$(bindir)/fd
+	install -Dm644 autocomplete/fd.bash $(DESTDIR)/$(datadir)/bash-completion/completions/$(exe_name)
+	install -Dm644 autocomplete/fd.fish $(DESTDIR)/$(datadir)/fish/vendor_completions.d/$(exe_name).fish
+	install -Dm644 autocomplete/_fd $(DESTDIR)/$(datadir)/zsh/site-functions/_$(exe_name)
+	install -Dm644 doc/fd.1 $(DESTDIR)/$(datadir)/man/man1/$(exe_name).1

build.rs

@@ -1,13 +1,5 @@
-use std::fs;
-
-use clap_complete::{generate_to, Shell};
-use Shell::*;
-//use clap_complete::shells::Shel{Bash, Fish, PowerShell, Elvish};
-
-include!("src/app.rs");
-
 fn main() {
-    let min_version = "1.57";
+    let min_version = "1.60";
 
     match version_check::is_min_version(min_version) {
         Some(true) => {}
@@ -17,17 +9,4 @@ fn main() {
             std::process::exit(1);
         }
     }
-
-    let var = std::env::var_os("SHELL_COMPLETIONS_DIR").or_else(|| std::env::var_os("OUT_DIR"));
-    let outdir = match var {
-        None => return,
-        Some(outdir) => outdir,
-    };
-    fs::create_dir_all(&outdir).unwrap();
-
-    let mut app = build_app();
-    // NOTE: zsh completions are hand written in contrib/completion/_fd
-    for shell in [Bash, PowerShell, Fish, Elvish] {
-        generate_to(shell, &mut app, "fd", &outdir).unwrap();
-    }
 }

clippy.toml

@@ -1 +1 @@
-msrv = "1.57.0"
+msrv = "1.60.0"