From 6ffdf8e008bb1bb052afdb56684917075424a056 Mon Sep 17 00:00:00 2001 From: Marco Eidinger Date: Mon, 10 Jun 2024 16:40:03 -0700 Subject: feat(swiftpm): update completion for Swift 5.9 (#12044) --- plugins/swiftpm/README.md | 2 +- plugins/swiftpm/_swift | 258 ++++++++++++++++++++-------------------------- 2 files changed, 114 insertions(+), 146 deletions(-) (limited to 'plugins/swiftpm') diff --git a/plugins/swiftpm/README.md b/plugins/swiftpm/README.md index 223a607c1..e5b4752e4 100644 --- a/plugins/swiftpm/README.md +++ b/plugins/swiftpm/README.md @@ -2,7 +2,7 @@ ## Description -This plugin provides a few utilities that make you faster on your daily work with the [Swift Package Manager](https://github.com/apple/swift-package-manager), as well as autocompletion for Swift 5.7. +This plugin provides a few utilities that make you faster on your daily work with the [Swift Package Manager](https://github.com/apple/swift-package-manager), as well as autocompletion for Swift 5.9. To start using it, add the `swiftpm` plugin to your `plugins` array in `~/.zshrc`: diff --git a/plugins/swiftpm/_swift b/plugins/swiftpm/_swift index 51c9fffa0..f9a603f58 100644 --- a/plugins/swiftpm/_swift +++ b/plugins/swiftpm/_swift @@ -57,6 +57,8 @@ _swift_run() { '--config-path[Specify the shared configuration directory path]:config-path:_files -/' '--security-path[Specify the shared security directory path]:security-path:_files -/' '--scratch-path[Specify a custom scratch directory path (default .build)]:scratch-path:_files -/' + '--pkg-config-path[Specify alternative path to search for pkg-config `.pc` files. Use the option multiple times to + specify more than one path.]:pkg-config-path:_files -/' '--enable-dependency-cache[Use a shared cache when fetching dependencies]' '--disable-dependency-cache[Use a shared cache when fetching dependencies]' '--enable-build-manifest-caching' @@ -64,13 +66,18 @@ _swift_run() { '--manifest-cache[Caching mode of Package.swift manifests (shared: shared cache, local: package'"'"'s build directory, none: disabled]:manifest-cache:' '(--verbose -v)'{--verbose,-v}'[Increase verbosity to include informational output]' '(--very-verbose --vv)'{--very-verbose,--vv}'[Increase verbosity to include debug output]' + '(--quiet -q)'{--quiet,-q}'[Decrease verbosity to only include error output.]' '--disable-sandbox[Disable using the sandbox when executing subprocesses]' - '--enable-netrc[Load credentials from a .netrc file]' - '--disable-netrc[Load credentials from a .netrc file]' - '--netrc-file[Specify the .netrc file path.]:netrc-file:_files' + '--netrc[Use netrc file even in cases where other credential stores are preferred]' + '--enable-netrc[Load credentials from a netrc file]' + '--disable-netrc[Load credentials from a netrc file]' + '--netrc-file[Specify the netrc file path]:netrc-file:_files' '--enable-keychain[Search credentials in macOS keychain]' '--disable-keychain[Search credentials in macOS keychain]' '--resolver-fingerprint-checking:resolver-fingerprint-checking:' + '--resolver-signing-entity-checking:resolver-signing-entity-checking:' + '--enable-signature-validation[Validate signature of a signed package release downloaded from registry]' + '--disable-signature-validation[Validate signature of a signed package release downloaded from registry]' '--enable-prefetching' '--disable-prefetching' '(--force-resolved-versions --disable-automatic-resolution --only-use-versions-from-resolved-file)'{--force-resolved-versions,--disable-automatic-resolution,--only-use-versions-from-resolved-file}'[Only use versions from the Package.resolved file and fail resolution if it is out-of-date]' @@ -78,6 +85,7 @@ _swift_run() { '--disable-scm-to-registry-transformation[disable source control to registry transformation]' '--use-registry-identity-for-scm[look up source control dependencies in the registry and use their registry identity when possible to help deduplicate across the two origins]' '--replace-scm-with-registry[look up source control dependencies in the registry and use the registry to retrieve them instead of source control when possible]' + '--default-registry-url[Default registry URL to use, instead of the registries.json configuration file]:default-registry-url:' '(--configuration -c)'{--configuration,-c}'[Build with configuration]:configuration:(debug release)' '-Xcc[Pass flag through to all C compiler invocations]:Xcc:' '-Xswiftc[Pass flag through to all Swift compiler invocations]:Xswiftc:' @@ -86,7 +94,7 @@ _swift_run() { '--triple:triple:' '--sdk:sdk:_files -/' '--toolchain:toolchain:_files -/' - '--sanitize[Turn on runtime checks for erroneous behavior, possible values: address, thread, undefined, scudo]:sanitize:' + '--sanitize[Turn on runtime checks for erroneous behavior, possible values: address, thread, undefined, scudo]:sanitize:(address thread undefined scudo)' '--auto-index-store[Enable or disable indexing-while-building feature]' '--enable-index-store[Enable or disable indexing-while-building feature]' '--disable-index-store[Enable or disable indexing-while-building feature]' @@ -94,8 +102,8 @@ _swift_run() { '(--jobs -j)'{--jobs,-j}'[The number of jobs to spawn in parallel during the build process]:jobs:' '--emit-swift-module-separately' '--use-integrated-swift-driver' + '--explicit-target-dependency-import-check:explicit-target-dependency-import-check:' '--experimental-explicit-module-build' - '--print-manifest-job-graph[Write the command graph for the build manifest as a graphviz file]' '--build-system:build-system:(native xcode)' '--enable-dead-strip[Disable/enable dead code stripping by the linker]' '--disable-dead-strip[Disable/enable dead code stripping by the linker]' @@ -125,6 +133,8 @@ _swift_build() { '--config-path[Specify the shared configuration directory path]:config-path:_files -/' '--security-path[Specify the shared security directory path]:security-path:_files -/' '--scratch-path[Specify a custom scratch directory path (default .build)]:scratch-path:_files -/' + '--pkg-config-path[Specify alternative path to search for pkg-config `.pc` files. Use the option multiple times to + specify more than one path.]:pkg-config-path:_files -/' '--enable-dependency-cache[Use a shared cache when fetching dependencies]' '--disable-dependency-cache[Use a shared cache when fetching dependencies]' '--enable-build-manifest-caching' @@ -132,13 +142,18 @@ _swift_build() { '--manifest-cache[Caching mode of Package.swift manifests (shared: shared cache, local: package'"'"'s build directory, none: disabled]:manifest-cache:' '(--verbose -v)'{--verbose,-v}'[Increase verbosity to include informational output]' '(--very-verbose --vv)'{--very-verbose,--vv}'[Increase verbosity to include debug output]' + '(--quiet -q)'{--quiet,-q}'[Decrease verbosity to only include error output.]' '--disable-sandbox[Disable using the sandbox when executing subprocesses]' - '--enable-netrc[Load credentials from a .netrc file]' - '--disable-netrc[Load credentials from a .netrc file]' - '--netrc-file[Specify the .netrc file path.]:netrc-file:_files' + '--netrc[Use netrc file even in cases where other credential stores are preferred]' + '--enable-netrc[Load credentials from a netrc file]' + '--disable-netrc[Load credentials from a netrc file]' + '--netrc-file[Specify the netrc file path]:netrc-file:_files' '--enable-keychain[Search credentials in macOS keychain]' '--disable-keychain[Search credentials in macOS keychain]' '--resolver-fingerprint-checking:resolver-fingerprint-checking:' + '--resolver-signing-entity-checking:resolver-signing-entity-checking:' + '--enable-signature-validation[Validate signature of a signed package release downloaded from registry]' + '--disable-signature-validation[Validate signature of a signed package release downloaded from registry]' '--enable-prefetching' '--disable-prefetching' '(--force-resolved-versions --disable-automatic-resolution --only-use-versions-from-resolved-file)'{--force-resolved-versions,--disable-automatic-resolution,--only-use-versions-from-resolved-file}'[Only use versions from the Package.resolved file and fail resolution if it is out-of-date]' @@ -146,6 +161,7 @@ _swift_build() { '--disable-scm-to-registry-transformation[disable source control to registry transformation]' '--use-registry-identity-for-scm[look up source control dependencies in the registry and use their registry identity when possible to help deduplicate across the two origins]' '--replace-scm-with-registry[look up source control dependencies in the registry and use the registry to retrieve them instead of source control when possible]' + '--default-registry-url[Default registry URL to use, instead of the registries.json configuration file]:default-registry-url:' '(--configuration -c)'{--configuration,-c}'[Build with configuration]:configuration:(debug release)' '-Xcc[Pass flag through to all C compiler invocations]:Xcc:' '-Xswiftc[Pass flag through to all Swift compiler invocations]:Xswiftc:' @@ -154,7 +170,7 @@ _swift_build() { '--triple:triple:' '--sdk:sdk:_files -/' '--toolchain:toolchain:_files -/' - '--sanitize[Turn on runtime checks for erroneous behavior, possible values: address, thread, undefined, scudo]:sanitize:' + '--sanitize[Turn on runtime checks for erroneous behavior, possible values: address, thread, undefined, scudo]:sanitize:(address thread undefined scudo)' '--auto-index-store[Enable or disable indexing-while-building feature]' '--enable-index-store[Enable or disable indexing-while-building feature]' '--disable-index-store[Enable or disable indexing-while-building feature]' @@ -162,8 +178,8 @@ _swift_build() { '(--jobs -j)'{--jobs,-j}'[The number of jobs to spawn in parallel during the build process]:jobs:' '--emit-swift-module-separately' '--use-integrated-swift-driver' + '--explicit-target-dependency-import-check:explicit-target-dependency-import-check:' '--experimental-explicit-module-build' - '--print-manifest-job-graph[Write the command graph for the build manifest as a graphviz file]' '--build-system:build-system:(native xcode)' '--enable-dead-strip[Disable/enable dead code stripping by the linker]' '--disable-dead-strip[Disable/enable dead code stripping by the linker]' @@ -171,6 +187,7 @@ _swift_build() { '--no-static-swift-stdlib[Link Swift stdlib statically]' '--build-tests[Build both source and test targets]' '--show-bin-path[Print the binary output path]' + '--print-manifest-job-graph[Write the command graph for the build manifest as a graphviz file]' '--target[Build the specified target]:target:' '--product[Build the specified product]:product:' '--version[Show the version.]' @@ -190,6 +207,8 @@ _swift_test() { '--config-path[Specify the shared configuration directory path]:config-path:_files -/' '--security-path[Specify the shared security directory path]:security-path:_files -/' '--scratch-path[Specify a custom scratch directory path (default .build)]:scratch-path:_files -/' + '--pkg-config-path[Specify alternative path to search for pkg-config `.pc` files. Use the option multiple times to + specify more than one path.]:pkg-config-path:_files -/' '--enable-dependency-cache[Use a shared cache when fetching dependencies]' '--disable-dependency-cache[Use a shared cache when fetching dependencies]' '--enable-build-manifest-caching' @@ -197,13 +216,18 @@ _swift_test() { '--manifest-cache[Caching mode of Package.swift manifests (shared: shared cache, local: package'"'"'s build directory, none: disabled]:manifest-cache:' '(--verbose -v)'{--verbose,-v}'[Increase verbosity to include informational output]' '(--very-verbose --vv)'{--very-verbose,--vv}'[Increase verbosity to include debug output]' + '(--quiet -q)'{--quiet,-q}'[Decrease verbosity to only include error output.]' '--disable-sandbox[Disable using the sandbox when executing subprocesses]' - '--enable-netrc[Load credentials from a .netrc file]' - '--disable-netrc[Load credentials from a .netrc file]' - '--netrc-file[Specify the .netrc file path.]:netrc-file:_files' + '--netrc[Use netrc file even in cases where other credential stores are preferred]' + '--enable-netrc[Load credentials from a netrc file]' + '--disable-netrc[Load credentials from a netrc file]' + '--netrc-file[Specify the netrc file path]:netrc-file:_files' '--enable-keychain[Search credentials in macOS keychain]' '--disable-keychain[Search credentials in macOS keychain]' '--resolver-fingerprint-checking:resolver-fingerprint-checking:' + '--resolver-signing-entity-checking:resolver-signing-entity-checking:' + '--enable-signature-validation[Validate signature of a signed package release downloaded from registry]' + '--disable-signature-validation[Validate signature of a signed package release downloaded from registry]' '--enable-prefetching' '--disable-prefetching' '(--force-resolved-versions --disable-automatic-resolution --only-use-versions-from-resolved-file)'{--force-resolved-versions,--disable-automatic-resolution,--only-use-versions-from-resolved-file}'[Only use versions from the Package.resolved file and fail resolution if it is out-of-date]' @@ -211,6 +235,7 @@ _swift_test() { '--disable-scm-to-registry-transformation[disable source control to registry transformation]' '--use-registry-identity-for-scm[look up source control dependencies in the registry and use their registry identity when possible to help deduplicate across the two origins]' '--replace-scm-with-registry[look up source control dependencies in the registry and use the registry to retrieve them instead of source control when possible]' + '--default-registry-url[Default registry URL to use, instead of the registries.json configuration file]:default-registry-url:' '(--configuration -c)'{--configuration,-c}'[Build with configuration]:configuration:(debug release)' '-Xcc[Pass flag through to all C compiler invocations]:Xcc:' '-Xswiftc[Pass flag through to all Swift compiler invocations]:Xswiftc:' @@ -219,7 +244,7 @@ _swift_test() { '--triple:triple:' '--sdk:sdk:_files -/' '--toolchain:toolchain:_files -/' - '--sanitize[Turn on runtime checks for erroneous behavior, possible values: address, thread, undefined, scudo]:sanitize:' + '--sanitize[Turn on runtime checks for erroneous behavior, possible values: address, thread, undefined, scudo]:sanitize:(address thread undefined scudo)' '--auto-index-store[Enable or disable indexing-while-building feature]' '--enable-index-store[Enable or disable indexing-while-building feature]' '--disable-index-store[Enable or disable indexing-while-building feature]' @@ -227,29 +252,77 @@ _swift_test() { '(--jobs -j)'{--jobs,-j}'[The number of jobs to spawn in parallel during the build process]:jobs:' '--emit-swift-module-separately' '--use-integrated-swift-driver' + '--explicit-target-dependency-import-check:explicit-target-dependency-import-check:' '--experimental-explicit-module-build' - '--print-manifest-job-graph[Write the command graph for the build manifest as a graphviz file]' '--build-system:build-system:(native xcode)' '--enable-dead-strip[Disable/enable dead code stripping by the linker]' '--disable-dead-strip[Disable/enable dead code stripping by the linker]' '--static-swift-stdlib[Link Swift stdlib statically]' '--no-static-swift-stdlib[Link Swift stdlib statically]' '--skip-build[Skip building the test target]' + '--test-product[Test the specified product.]:test-product:' '--parallel[Run the tests in parallel.]' '--num-workers[Number of tests to execute in parallel.]:num-workers:' '(--list-tests -l)'{--list-tests,-l}'[Lists test methods in specifier format]' - '--show-codecov-path[Print the path of the exported code coverage JSON file]' + '(--show-codecov-path --show-code-coverage-path --show-coverage-path)'{--show-codecov-path,--show-code-coverage-path,--show-coverage-path}'[Print the path of the exported code coverage JSON file]' '(-s --specifier)'{-s,--specifier}':specifier:' '--filter[Run test cases matching regular expression, Format: . or ./]:filter:' '--skip[Skip test cases matching regular expression, Example: --skip PerformanceTests]:skip:' '--xunit-output[Path where the xUnit xml file should be generated.]:xunit-output:_files -/' - '--test-product[Test the specified product.]:test-product:' '--enable-testable-imports[Enable or disable testable imports. Enabled by default.]' '--disable-testable-imports[Enable or disable testable imports. Enabled by default.]' '--enable-code-coverage[Enable code coverage]' '--disable-code-coverage[Enable code coverage]' '--version[Show the version.]' '(-help -h --help)'{-help,-h,--help}'[Show help information.]' + '(-): :->command' + '(-)*:: :->arg' + ) + _arguments -w -s -S $args[@] && ret=0 + case $state in + (command) + local subcommands + subcommands=( + 'list:Lists test methods in specifier format' + 'generate-linuxmain:Generate LinuxMain.swift (deprecated)' + ) + _describe "subcommand" subcommands + ;; + (arg) + case ${words[1]} in + (list) + _swift_test_list + ;; + (generate-linuxmain) + _swift_test_generate-linuxmain + ;; + esac + ;; + esac + + return ret +} + +_swift_test_list() { + integer ret=1 + local -a args + args+=( + '--skip-build[Skip building the test target]' + '--test-product[Test the specified product.]:test-product:' + '--version[Show the version.]' + '(-help -h --help)'{-help,-h,--help}'[Show help information.]' + ) + _arguments -w -s -S $args[@] && ret=0 + + return ret +} + +_swift_test_generate-linuxmain() { + integer ret=1 + local -a args + args+=( + '--version[Show the version.]' + '(-help -h --help)'{-help,-h,--help}'[Show help information.]' ) _arguments -w -s -S $args[@] && ret=0 @@ -265,6 +338,8 @@ _swift_package() { '--config-path[Specify the shared configuration directory path]:config-path:_files -/' '--security-path[Specify the shared security directory path]:security-path:_files -/' '--scratch-path[Specify a custom scratch directory path (default .build)]:scratch-path:_files -/' + '--pkg-config-path[Specify alternative path to search for pkg-config `.pc` files. Use the option multiple times to + specify more than one path.]:pkg-config-path:_files -/' '--enable-dependency-cache[Use a shared cache when fetching dependencies]' '--disable-dependency-cache[Use a shared cache when fetching dependencies]' '--enable-build-manifest-caching' @@ -272,13 +347,18 @@ _swift_package() { '--manifest-cache[Caching mode of Package.swift manifests (shared: shared cache, local: package'"'"'s build directory, none: disabled]:manifest-cache:' '(--verbose -v)'{--verbose,-v}'[Increase verbosity to include informational output]' '(--very-verbose --vv)'{--very-verbose,--vv}'[Increase verbosity to include debug output]' + '(--quiet -q)'{--quiet,-q}'[Decrease verbosity to only include error output.]' '--disable-sandbox[Disable using the sandbox when executing subprocesses]' - '--enable-netrc[Load credentials from a .netrc file]' - '--disable-netrc[Load credentials from a .netrc file]' - '--netrc-file[Specify the .netrc file path.]:netrc-file:_files' + '--netrc[Use netrc file even in cases where other credential stores are preferred]' + '--enable-netrc[Load credentials from a netrc file]' + '--disable-netrc[Load credentials from a netrc file]' + '--netrc-file[Specify the netrc file path]:netrc-file:_files' '--enable-keychain[Search credentials in macOS keychain]' '--disable-keychain[Search credentials in macOS keychain]' '--resolver-fingerprint-checking:resolver-fingerprint-checking:' + '--resolver-signing-entity-checking:resolver-signing-entity-checking:' + '--enable-signature-validation[Validate signature of a signed package release downloaded from registry]' + '--disable-signature-validation[Validate signature of a signed package release downloaded from registry]' '--enable-prefetching' '--disable-prefetching' '(--force-resolved-versions --disable-automatic-resolution --only-use-versions-from-resolved-file)'{--force-resolved-versions,--disable-automatic-resolution,--only-use-versions-from-resolved-file}'[Only use versions from the Package.resolved file and fail resolution if it is out-of-date]' @@ -286,6 +366,7 @@ _swift_package() { '--disable-scm-to-registry-transformation[disable source control to registry transformation]' '--use-registry-identity-for-scm[look up source control dependencies in the registry and use their registry identity when possible to help deduplicate across the two origins]' '--replace-scm-with-registry[look up source control dependencies in the registry and use the registry to retrieve them instead of source control when possible]' + '--default-registry-url[Default registry URL to use, instead of the registries.json configuration file]:default-registry-url:' '(--configuration -c)'{--configuration,-c}'[Build with configuration]:configuration:(debug release)' '-Xcc[Pass flag through to all C compiler invocations]:Xcc:' '-Xswiftc[Pass flag through to all Swift compiler invocations]:Xswiftc:' @@ -294,7 +375,7 @@ _swift_package() { '--triple:triple:' '--sdk:sdk:_files -/' '--toolchain:toolchain:_files -/' - '--sanitize[Turn on runtime checks for erroneous behavior, possible values: address, thread, undefined, scudo]:sanitize:' + '--sanitize[Turn on runtime checks for erroneous behavior, possible values: address, thread, undefined, scudo]:sanitize:(address thread undefined scudo)' '--auto-index-store[Enable or disable indexing-while-building feature]' '--enable-index-store[Enable or disable indexing-while-building feature]' '--disable-index-store[Enable or disable indexing-while-building feature]' @@ -302,8 +383,8 @@ _swift_package() { '(--jobs -j)'{--jobs,-j}'[The number of jobs to spawn in parallel during the build process]:jobs:' '--emit-swift-module-separately' '--use-integrated-swift-driver' + '--explicit-target-dependency-import-check:explicit-target-dependency-import-check:' '--experimental-explicit-module-build' - '--print-manifest-job-graph[Write the command graph for the build manifest as a graphviz file]' '--build-system:build-system:(native xcode)' '--enable-dead-strip[Disable/enable dead code stripping by the linker]' '--disable-dead-strip[Disable/enable dead code stripping by the linker]' @@ -325,25 +406,19 @@ _swift_package() { 'update:Update package dependencies' 'describe:Describe the current package' 'init:Initialize a new package' - '_format:' 'diagnose-api-breaking-changes:Diagnose API-breaking changes to Swift modules in a package' - 'experimental-api-diff:Deprecated - use `swift package diagnose-api-breaking-changes` instead' 'dump-symbol-graph:Dump Symbol Graph' - 'dump-pif:' 'dump-package:Print parsed Package.swift as JSON' 'edit:Put a package in editable mode' 'unedit:Remove a package from editable mode' 'config:Manipulate configuration of the package' 'resolve:Resolve package dependencies' - 'fetch:' 'show-dependencies:Print the resolved dependency graph' 'tools-version:Manipulate tools version of the current package' - 'generate-xcodeproj:Generates an Xcode project. This command will be deprecated soon.' 'compute-checksum:Compute the checksum for a binary artifact.' 'archive-source:Create a source archive for the package' 'completion-tool:Completion tool (for shell completions)' 'plugin:Invoke a command plugin or perform other actions on command plugins' - 'default-command:' ) _describe "subcommand" subcommands ;; @@ -367,21 +442,12 @@ _swift_package() { (init) _swift_package_init ;; - (_format) - _swift_package__format - ;; (diagnose-api-breaking-changes) _swift_package_diagnose-api-breaking-changes ;; - (experimental-api-diff) - _swift_package_experimental-api-diff - ;; (dump-symbol-graph) _swift_package_dump-symbol-graph ;; - (dump-pif) - _swift_package_dump-pif - ;; (dump-package) _swift_package_dump-package ;; @@ -397,18 +463,12 @@ _swift_package() { (resolve) _swift_package_resolve ;; - (fetch) - _swift_package_fetch - ;; (show-dependencies) _swift_package_show-dependencies ;; (tools-version) _swift_package_tools-version ;; - (generate-xcodeproj) - _swift_package_generate-xcodeproj - ;; (compute-checksum) _swift_package_compute-checksum ;; @@ -421,9 +481,6 @@ _swift_package() { (plugin) _swift_package_plugin ;; - (default-command) - _swift_package_default-command - ;; esac ;; esac @@ -498,7 +555,7 @@ _swift_package_init() { integer ret=1 local -a args args+=( - '--type[Package type: empty | library | executable | system-module | manifest]:type:' + '--type[Package type:]:type:' '--name[Provide custom package name]:name:' '--version[Show the version.]' '(-help -h --help)'{-help,-h,--help}'[Show help information.]' @@ -508,19 +565,6 @@ _swift_package_init() { return ret } -_swift_package__format() { - integer ret=1 - local -a args - args+=( - ':swift-format-flags:' - '--version[Show the version.]' - '(-help -h --help)'{-help,-h,--help}'[Show help information.]' - ) - _arguments -w -s -S $args[@] && ret=0 - - return ret -} - _swift_package_diagnose-api-breaking-changes() { integer ret=1 local -a args @@ -539,19 +583,6 @@ _swift_package_diagnose-api-breaking-changes() { return ret } -_swift_package_experimental-api-diff() { - integer ret=1 - local -a args - args+=( - ':args:' - '--version[Show the version.]' - '(-help -h --help)'{-help,-h,--help}'[Show help information.]' - ) - _arguments -w -s -S $args[@] && ret=0 - - return ret -} - _swift_package_dump-symbol-graph() { integer ret=1 local -a args @@ -561,19 +592,8 @@ _swift_package_dump-symbol-graph() { '--minimum-access-level[Include symbols with this access level or more. Possible values: private | fileprivate | internal | public | open]:minimum-access-level:(private fileprivate internal public open)' '--skip-inherited-docs[Skip emitting doc comments for members inherited through classes or default implementations.]' '--include-spi-symbols[Add symbols with SPI information to the symbol graph.]' - '--version[Show the version.]' - '(-help -h --help)'{-help,-h,--help}'[Show help information.]' - ) - _arguments -w -s -S $args[@] && ret=0 - - return ret -} - -_swift_package_dump-pif() { - integer ret=1 - local -a args - args+=( - '--preserve-structure[Preserve the internal structure of PIF]' + '--emit-extension-block-symbols[Emit extension block symbols for extensions to external types or directly associate members and conformances with the extended nominal.]' + '--omit-extension-block-symbols[Emit extension block symbols for extensions to external types or directly associate members and conformances with the extended nominal.]' '--version[Show the version.]' '(-help -h --help)'{-help,-h,--help}'[Show help information.]' ) @@ -614,7 +634,7 @@ _swift_package_unedit() { integer ret=1 local -a args args+=( - '--force[Unedit the package even if it has uncommitted and unpushed changes]' + '--force[Unedit the package even if it has uncommited and unpushed changes]' ':package-name:' '--version[Show the version.]' '(-help -h --help)'{-help,-h,--help}'[Show help information.]' @@ -666,9 +686,8 @@ _swift_package_config_set-mirror() { integer ret=1 local -a args args+=( - '--package-url[The package dependency url]:package-url:' - '--original-url[The original url]:original-url:' - '--mirror-url[The mirror url]:mirror-url:' + '--original[The original url or identity]:original:' + '--mirror[The mirror url or identity]:mirror:' '--version[Show the version.]' '(-help -h --help)'{-help,-h,--help}'[Show help information.]' ) @@ -681,9 +700,8 @@ _swift_package_config_unset-mirror() { integer ret=1 local -a args args+=( - '--package-url[The package dependency url]:package-url:' - '--original-url[The original url]:original-url:' - '--mirror-url[The mirror url]:mirror-url:' + '--original[The original url or identity]:original:' + '--mirror[The mirror url or identity]:mirror:' '--version[Show the version.]' '(-help -h --help)'{-help,-h,--help}'[Show help information.]' ) @@ -696,8 +714,7 @@ _swift_package_config_get-mirror() { integer ret=1 local -a args args+=( - '--package-url[The package dependency url]:package-url:' - '--original-url[The original url]:original-url:' + '--original[The original url or identity]:original:' '--version[Show the version.]' '(-help -h --help)'{-help,-h,--help}'[Show help information.]' ) @@ -722,22 +739,6 @@ _swift_package_resolve() { return ret } -_swift_package_fetch() { - integer ret=1 - local -a args - args+=( - '--version[The version to resolve at]:version:' - '--branch[The branch to resolve at]:branch:' - '--revision[The revision to resolve at]:revision:' - ':package-name:' - '--version[Show the version.]' - '(-help -h --help)'{-help,-h,--help}'[Show help information.]' - ) - _arguments -w -s -S $args[@] && ret=0 - - return ret -} - _swift_package_show-dependencies() { integer ret=1 local -a args @@ -766,25 +767,6 @@ _swift_package_tools-version() { return ret } -_swift_package_generate-xcodeproj() { - integer ret=1 - local -a args - args+=( - '--xcconfig-overrides[Path to xcconfig file]:xcconfig-overrides:_files' - '--output[Path where the Xcode project should be generated]:output:_files -/' - '--legacy-scheme-generator[Use the legacy scheme generator]' - '--watch[Watch for changes to the Package manifest to regenerate the Xcode project]' - '--skip-extra-files[Do not add file references for extra files to the generated Xcode project]' - '--enable-code-coverage[Enable code coverage]' - '--disable-code-coverage[Enable code coverage]' - '--version[Show the version.]' - '(-help -h --help)'{-help,-h,--help}'[Show help information.]' - ) - _arguments -w -s -S $args[@] && ret=0 - - return ret -} - _swift_package_compute-checksum() { integer ret=1 local -a args @@ -831,6 +813,7 @@ _swift_package_plugin() { '--list[List the available command plugins]' '--allow-writing-to-package-directory[Allow the plugin to write to the package directory]' '--allow-writing-to-directory[Allow the plugin to write to an additional directory]:allow-writing-to-directory:' + '--allow-network-connections:allow-network-connections:(none local all docker unixDomainSocket)' ':command:' ':arguments:' '--version[Show the version.]' @@ -841,21 +824,6 @@ _swift_package_plugin() { return ret } -_swift_package_default-command() { - integer ret=1 - local -a args - args+=( - '--allow-writing-to-package-directory[Allow the plugin to write to the package directory]' - '--allow-writing-to-directory[Allow the plugin to write to an additional directory]:allow-writing-to-directory:' - ':remaining:' - '--version[Show the version.]' - '(-help -h --help)'{-help,-h,--help}'[Show help information.]' - ) - _arguments -w -s -S $args[@] && ret=0 - - return ret -} - _swift_help() { integer ret=1 local -a args -- cgit v1.2.3-70-g09d2 From efafef8495f030501e0df59ccb76a598bbce3ae1 Mon Sep 17 00:00:00 2001 From: Marc Cornellà Date: Fri, 9 Aug 2024 09:44:46 +0200 Subject: docs: improve several plugin READMEs and add one for `ssh` plugin --- plugins/aliases/README.md | 4 +-- plugins/ansible/README.md | 2 -- plugins/arduino-cli/README.md | 1 + plugins/asdf/README.md | 6 ++-- plugins/chucknorris/README.md | 2 +- plugins/dbt/README.md | 6 ++-- plugins/fancy-ctrl-z/README.md | 12 ++++++- plugins/gatsby/README.md | 2 +- plugins/isodate/README.md | 4 +-- plugins/jira/README.md | 46 ++++++++++++------------ plugins/kube-ps1/README.md | 3 +- plugins/per-directory-history/README.md | 3 +- plugins/pipenv/README.md | 4 +-- plugins/spring/README.md | 14 +++----- plugins/ssh/README.md | 16 +++++++++ plugins/suse/README.md | 8 +++-- plugins/swiftpm/README.md | 2 -- plugins/vagrant-prompt/README.md | 31 ++++++++++++++-- plugins/vagrant-prompt/vagrant-prompt.plugin.zsh | 17 --------- plugins/vim-interaction/README.md | 16 ++++----- plugins/xcode/README.md | 2 -- plugins/yii2/README.md | 4 +-- plugins/zsh-interactive-cd/README.md | 8 ++++- 23 files changed, 123 insertions(+), 90 deletions(-) create mode 100644 plugins/ssh/README.md (limited to 'plugins/swiftpm') diff --git a/plugins/aliases/README.md b/plugins/aliases/README.md index 14f9c5c53..5a7e7dfc6 100644 --- a/plugins/aliases/README.md +++ b/plugins/aliases/README.md @@ -1,7 +1,5 @@ # Aliases cheatsheet -**Maintainer:** [@hqingyi](https://github.com/hqingyi) - With lots of 3rd-party amazing aliases installed, this plugin helps list the shortcuts that are currently available based on the plugins you have enabled. @@ -13,6 +11,8 @@ plugins=(aliases) Requirements: Python needs to be installed. +**Maintainer:** [@hqingyi](https://github.com/hqingyi) + ## Usage - `als`: show all aliases by group diff --git a/plugins/ansible/README.md b/plugins/ansible/README.md index dd0e1ce03..6a06962ee 100644 --- a/plugins/ansible/README.md +++ b/plugins/ansible/README.md @@ -1,7 +1,5 @@ # ansible plugin -## Introduction - The `ansible plugin` adds several aliases for useful [ansible](https://docs.ansible.com/ansible/latest/index.html) commands and [aliases](#aliases). To use it, add `ansible` to the plugins array of your zshrc file: diff --git a/plugins/arduino-cli/README.md b/plugins/arduino-cli/README.md index 91bda9067..821d72bbf 100644 --- a/plugins/arduino-cli/README.md +++ b/plugins/arduino-cli/README.md @@ -1,6 +1,7 @@ # Arduino CLI plugin This plugin adds completion for the [arduino-cli](https://github.com/arduino/arduino-cli) tool. + To use it, add `arduino-cli` to the plugins array in your zshrc file: ```zsh diff --git a/plugins/asdf/README.md b/plugins/asdf/README.md index f047860e2..4af69a75c 100644 --- a/plugins/asdf/README.md +++ b/plugins/asdf/README.md @@ -1,7 +1,5 @@ ## asdf -**Maintainer:** [@RobLoach](https://github.com/RobLoach) - Adds integration with [asdf](https://github.com/asdf-vm/asdf), the extendable version manager, with support for Ruby, Node.js, Elixir, Erlang and more. ### Installation @@ -28,3 +26,7 @@ asdf install nodejs latest asdf global nodejs latest asdf local nodejs latest ``` + +### Maintainer + +- [@RobLoach](https://github.com/RobLoach) diff --git a/plugins/chucknorris/README.md b/plugins/chucknorris/README.md index b51875de9..0562b3b59 100644 --- a/plugins/chucknorris/README.md +++ b/plugins/chucknorris/README.md @@ -1,6 +1,6 @@ # chucknorris -Chuck Norris fortunes plugin for Oh My Zsh. Perfectly suitable as MOTD. +Fortunes plugin for Chuck Norris for Oh My Zsh. Perfectly suitable as MOTD. To use it add `chucknorris` to the plugins array in you zshrc file. diff --git a/plugins/dbt/README.md b/plugins/dbt/README.md index e05d79cc3..74ae631cd 100644 --- a/plugins/dbt/README.md +++ b/plugins/dbt/README.md @@ -1,13 +1,11 @@ # dbt plugin -## Introduction - The `dbt plugin` adds several aliases for useful [dbt](https://docs.getdbt.com/) commands and [aliases](#aliases). To use it, add `dbt` to the plugins array of your zshrc file: -``` +```zsh plugins=(... dbt) ``` @@ -26,4 +24,4 @@ plugins=(... dbt) ## Maintainer -### [msempere](https://github.com/msempere) +- [msempere](https://github.com/msempere) diff --git a/plugins/fancy-ctrl-z/README.md b/plugins/fancy-ctrl-z/README.md index 82a4fd75e..7766c51eb 100644 --- a/plugins/fancy-ctrl-z/README.md +++ b/plugins/fancy-ctrl-z/README.md @@ -1,4 +1,14 @@ -# Use Ctrl-Z to switch back to Vim +# fancy-ctrl-z + +Allows pressing Ctrl-Z again to switch back to a background job. + +To use it, add `fancy-ctrl-z` to the plugins array in your zshrc file: + +```zsh +plugins=(... fancy-ctrl-z) +``` + +## Motivation I frequently need to execute random commands in my shell. To achieve it I pause Vim by pressing Ctrl-z, type command and press fg to switch back to Vim. diff --git a/plugins/gatsby/README.md b/plugins/gatsby/README.md index 36846a228..cc1bd392e 100644 --- a/plugins/gatsby/README.md +++ b/plugins/gatsby/README.md @@ -1,6 +1,6 @@ # gatsby autocomplete plugin -* Adds autocomplete options for all gatsby commands. +Adds autocomplete options for all gatsby commands. ## Requirements diff --git a/plugins/isodate/README.md b/plugins/isodate/README.md index 1ec75b2d4..5329310c2 100644 --- a/plugins/isodate/README.md +++ b/plugins/isodate/README.md @@ -1,7 +1,5 @@ # Isodate plugin -**Maintainer:** [@Frani](https://github.com/frani) - This plugin adds completion for the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), as well as some aliases for common Date commands. @@ -11,6 +9,8 @@ To use it, add `isodate` to the plugins array in your zshrc file: plugins=(... isodate) ``` +**Maintainer:** [@Frani](https://github.com/frani) + ## Aliases | Alias | Command | Description | diff --git a/plugins/jira/README.md b/plugins/jira/README.md index 1c6930298..7cfb81b19 100644 --- a/plugins/jira/README.md +++ b/plugins/jira/README.md @@ -1,16 +1,18 @@ -# Jira plugin # +# Jira plugin -CLI support for JIRA interaction +This plugin provides command line tools for interacting with Atlassian's [JIRA](https://www.atlassian.com/software/jira) bug tracking software. -## Description ## +To use it, add `jira` to the plugins array in your zshrc file: -This plugin provides command line tools for interacting with Atlassian's [JIRA](https://www.atlassian.com/software/jira) bug tracking software. +```zsh +plugins=(... jira) +``` The interaction is all done through the web. No local installation of JIRA is necessary. In this document, "JIRA" refers to the JIRA issue tracking server, and `jira` refers to the command this plugin supplies. -## Usage ## +## Usage This plugin supplies one command, `jira`, through which all its features are exposed. Most forms of this command open a JIRA page in your web browser. @@ -18,19 +20,19 @@ This plugin supplies one command, `jira`, through which all its features are exp `jira help` or `jira usage` will print the below usage instructions -| Command | Description | -| :------------ | :-------------------------------------------------------- | -| `jira` | Performs the default action | -| `jira new` | Opens a new Jira issue dialogue | -| `jira ABC-123` | Opens an existing issue | -| `jira ABC-123 m` | Opens an existing issue for adding a comment | -| `jira dashboard [rapid_view]` | Opens your JIRA dashboard | -| `jira mine` | Queries for your own issues | -| `jira tempo` | Opens your JIRA Tempo | -| `jira reported [username]` | Queries for issues reported by a user | -| `jira assigned [username]` | Queries for issues assigned to a user | -| `jira branch` | Opens an existing issue matching the current branch name | -| `jira help` | Prints usage instructions | +| Command | Description | +| :---------------------------- | :------------------------------------------------------- | +| `jira` | Performs the default action | +| `jira new` | Opens a new Jira issue dialogue | +| `jira ABC-123` | Opens an existing issue | +| `jira ABC-123 m` | Opens an existing issue for adding a comment | +| `jira dashboard [rapid_view]` | Opens your JIRA dashboard | +| `jira mine` | Queries for your own issues | +| `jira tempo` | Opens your JIRA Tempo | +| `jira reported [username]` | Queries for issues reported by a user | +| `jira assigned [username]` | Queries for issues assigned to a user | +| `jira branch` | Opens an existing issue matching the current branch name | +| `jira help` | Prints usage instructions | ### Jira Branch usage notes @@ -43,7 +45,7 @@ This is also checks if the prefix is in the name, and adds it if not, so: "MP-12 -#### Debugging usage #### +#### Debugging usage These calling forms are for developers' use, and may change at any time. @@ -51,7 +53,7 @@ These calling forms are for developers' use, and may change at any time. jira dumpconfig # displays the effective configuration ``` -## Setup ## +## Setup The URL for your JIRA instance is set by `$JIRA_URL` or a `.jira_url` file. @@ -68,7 +70,7 @@ echo "https://jira.atlassian.com" >> .jira-url (Note: The current implementation only looks in the current directory for `.jira-url` and `.jira-prefix`, not up the path, so if you are in a subdirectory of your project, it will fall back to your default JIRA URL. This will probably change in the future though.) -### Variables ### +### Variables * `$JIRA_URL` - Your JIRA instance's URL * `$JIRA_NAME` - Your JIRA username; used as the default user for `assigned`/`reported` searches @@ -79,6 +81,6 @@ echo "https://jira.atlassian.com" >> .jira-url * `$JIRA_TEMPO_PATH` - Your JIRA tempo url path; defaults to "/secure/Tempo.jspa" -### Browser ### +### Browser Your default web browser, as determined by how `open_command` handles `http://` URLs, is used for interacting with the JIRA instance. If you change your system's URL handler associations, it will change the browser that `jira` uses. diff --git a/plugins/kube-ps1/README.md b/plugins/kube-ps1/README.md index dd49eff39..be3c184be 100644 --- a/plugins/kube-ps1/README.md +++ b/plugins/kube-ps1/README.md @@ -1,5 +1,4 @@ -kube-ps1: Kubernetes prompt for bash and zsh -============================================ +# kube-ps1: Kubernetes prompt for bash and zsh A script that lets you add the current Kubernetes context and namespace configured on `kubectl` to your Bash/Zsh prompt strings (i.e. the `$PS1`). diff --git a/plugins/per-directory-history/README.md b/plugins/per-directory-history/README.md index 11150b059..2816c11ba 100644 --- a/plugins/per-directory-history/README.md +++ b/plugins/per-directory-history/README.md @@ -1,5 +1,4 @@ -per-directory-history plugin ----------------------------- +# per-directory-history plugin This plugin adds per-directory history for zsh, as well as a global history, and the ability to toggle between them with a keyboard shortcut. This is a diff --git a/plugins/pipenv/README.md b/plugins/pipenv/README.md index e78ef0e3b..429b6f186 100644 --- a/plugins/pipenv/README.md +++ b/plugins/pipenv/README.md @@ -1,6 +1,6 @@ # Pipenv -## Installation +This plugin provides some features to simplify the use of [Pipenv](https://pipenv.pypa.io/) while working on ZSH. In your `.zshrc` file, add `pipenv` to the plugins section @@ -10,8 +10,6 @@ plugins=(... pipenv ...) ## Features -This plugin provides some features to simplify the use of Pipenv while working on ZSH. - - Adds completion for pipenv - Auto activates and deactivates pipenv shell - Adds short aliases for common pipenv commands diff --git a/plugins/spring/README.md b/plugins/spring/README.md index 816181326..b93402000 100644 --- a/plugins/spring/README.md +++ b/plugins/spring/README.md @@ -1,16 +1,12 @@ # Spring Boot oh-my-zsh plugin -oh-my-zsh Spring Boot plugin -## Spring Boot autocomplete plugin +Adds autocomplete options for all [Spring Boot](https://spring.io/projects/spring-boot) commands. -- Adds autocomplete options for all spring boot commands. +To use it, add `spring` to the plugins array in your zshrc file: -## Manual Install - - $ cd ~/.oh-my-zsh/plugins - $ git clone git@github.com:linux-china/oh-my-zsh-spring-boot-plugin.git spring - -Adjust your .zshrc file and add spring to plugins=(...) +```zsh +plugins=(... spring) +``` ## Tips diff --git a/plugins/ssh/README.md b/plugins/ssh/README.md new file mode 100644 index 000000000..3dd32ec76 --- /dev/null +++ b/plugins/ssh/README.md @@ -0,0 +1,16 @@ +# ssh plugin + +This plugin provides host completion based off of your `~/.ssh/config` file, and adds +some utility functions to work with SSH keys. + +To use it, add `ssh` to the plugins array in your zshrc file: + +```zsh +plugins=(... ssh) +``` + +## Functions + +- `ssh_rmhkey`: remove host key from known hosts based on a host section name from `.ssh/config`. +- `ssh_load_key`: load SSH key into agent. +- `ssh_unload_key`: remove SSH key from agent. diff --git a/plugins/suse/README.md b/plugins/suse/README.md index f37ec1695..e1e3aad29 100644 --- a/plugins/suse/README.md +++ b/plugins/suse/README.md @@ -1,8 +1,6 @@ # suse -**Maintainer**: [r-darwish](https://github.com/r-darwish) - -Alias for Zypper according to the official Zypper's alias +Aliases for [Zypper](https://en.opensuse.org/Portal:Zypper) according to the official Zypper's alias To use it add `suse` to the plugins array in you zshrc file. @@ -10,6 +8,8 @@ To use it add `suse` to the plugins array in you zshrc file. plugins=(... suse) ``` +**Maintainer**: [r-darwish](https://github.com/r-darwish) + ## Main commands | Alias | Commands | Description | @@ -79,6 +79,7 @@ Related: [#9798](https://github.com/ohmyzsh/ohmyzsh/pull/9798). | zrr | `sudo zypper rr` | remove repositories | ## Services commands + | Alias | Commands | Description | | ----- | ------------------ | -------------------------------------------------------------- | | zas | `sudo zypper as` | adds a service specified by URI to the system | @@ -88,6 +89,7 @@ Related: [#9798](https://github.com/ohmyzsh/ohmyzsh/pull/9798). | zls | `zypper ls` | list services defined on the system | ## Package Locks Management commands + | Alias | Commands | Description | | ----- | ---------------- | ----------------------------------- | | zal | `sudo zypper al` | add a package lock | diff --git a/plugins/swiftpm/README.md b/plugins/swiftpm/README.md index e5b4752e4..babbf4d66 100644 --- a/plugins/swiftpm/README.md +++ b/plugins/swiftpm/README.md @@ -1,7 +1,5 @@ # Swift Package Manager -## Description - This plugin provides a few utilities that make you faster on your daily work with the [Swift Package Manager](https://github.com/apple/swift-package-manager), as well as autocompletion for Swift 5.9. To start using it, add the `swiftpm` plugin to your `plugins` array in `~/.zshrc`: diff --git a/plugins/vagrant-prompt/README.md b/plugins/vagrant-prompt/README.md index dd0ca363b..0720f4bde 100644 --- a/plugins/vagrant-prompt/README.md +++ b/plugins/vagrant-prompt/README.md @@ -1,6 +1,33 @@ +# vagrant-prompt + This plugin prompts the status of the Vagrant VMs. It supports single-host and multi-host configurations as well. -Look inside the source for documentation about custom variables. +To use it, add `vagrant-prompt` to the plugins array in your zshrc file: + +```zsh +plugins=(... vagrant-prompt) +``` + +**Alberto Re ** + +## Usage + +To display Vagrant info on your prompt add the `vagrant_prompt_info` to the +`$PROMPT` or `$RPROMPT` variable in your theme. Example: + +```zsh +PROMPT='%{$fg[$NCOLOR]%}%B%n%b%{$reset_color%}:%{$fg[blue]%}%B%c/%b%{$reset_color%} $(vagrant_prompt_info)$(svn_prompt_info)$(git_prompt_info)%(!.#.$) ' +``` + +`vagrant_prompt_info` makes use of some custom variables. This is an example +definition: -Alberto Re +```zsh +ZSH_THEME_VAGRANT_PROMPT_PREFIX="%{$fg_bold[blue]%}[" +ZSH_THEME_VAGRANT_PROMPT_SUFFIX="%{$fg_bold[blue]%}]%{$reset_color%} " +ZSH_THEME_VAGRANT_PROMPT_RUNNING="%{$fg_no_bold[green]%}●" +ZSH_THEME_VAGRANT_PROMPT_POWEROFF="%{$fg_no_bold[red]%}●" +ZSH_THEME_VAGRANT_PROMPT_SUSPENDED="%{$fg_no_bold[yellow]%}●" +ZSH_THEME_VAGRANT_PROMPT_NOT_CREATED="%{$fg_no_bold[white]%}○" +``` diff --git a/plugins/vagrant-prompt/vagrant-prompt.plugin.zsh b/plugins/vagrant-prompt/vagrant-prompt.plugin.zsh index d7c76c3c9..29f4038c5 100644 --- a/plugins/vagrant-prompt/vagrant-prompt.plugin.zsh +++ b/plugins/vagrant-prompt/vagrant-prompt.plugin.zsh @@ -1,20 +1,3 @@ -# vim:ft=zsh ts=2 sw=2 sts=2 -# -# To display Vagrant infos on your prompt add the vagrant_prompt_info to the -# $PROMPT variable in your theme. Example: -# -# PROMPT='%{$fg[$NCOLOR]%}%B%n%b%{$reset_color%}:%{$fg[blue]%}%B%c/%b%{$reset_color%} $(vagrant_prompt_info)$(svn_prompt_info)$(git_prompt_info)%(!.#.$) ' -# -# `vagrant_prompt_info` makes use of some custom variables. This is an example -# definition: -# -# ZSH_THEME_VAGRANT_PROMPT_PREFIX="%{$fg_bold[blue]%}[" -# ZSH_THEME_VAGRANT_PROMPT_SUFFIX="%{$fg_bold[blue]%}]%{$reset_color%} " -# ZSH_THEME_VAGRANT_PROMPT_RUNNING="%{$fg_no_bold[green]%}●" -# ZSH_THEME_VAGRANT_PROMPT_POWEROFF="%{$fg_no_bold[red]%}●" -# ZSH_THEME_VAGRANT_PROMPT_SUSPENDED="%{$fg_no_bold[yellow]%}●" -# ZSH_THEME_VAGRANT_PROMPT_NOT_CREATED="%{$fg_no_bold[white]%}○" - function vagrant_prompt_info() { local vm_states vm_state if [[ -d .vagrant && -f Vagrantfile ]]; then diff --git a/plugins/vim-interaction/README.md b/plugins/vim-interaction/README.md index c2b45f1d8..437b48d99 100644 --- a/plugins/vim-interaction/README.md +++ b/plugins/vim-interaction/README.md @@ -1,5 +1,13 @@ # Vim Interaction # +The idea for this script is to give you some decent interaction with a running +GVim session. Normally you'll be running around your filesystem doing any +number of amazing things and you'll need to load some files into GVim for +editing, inspecting, destruction, or other bits of mayhem. This script lets you +do that. + +## Usage + The plugin presents a function called `callvim` whose usage is: usage: callvim [-b cmd] [-a cmd] [file ... fileN] @@ -9,14 +17,6 @@ The plugin presents a function called `callvim` whose usage is: file The file to edit ... fileN The other files to add to the argslist -## Rationale ## - -The idea for this script is to give you some decent interaction with a running -GVim session. Normally you'll be running around your filesystem doing any -number of amazing things and you'll need to load some files into GVim for -editing, inspecting, destruction, or other bits of mayhem. This script lets you -do that. - ## Aliases ## There are a few aliases presented as well: diff --git a/plugins/xcode/README.md b/plugins/xcode/README.md index 27d6a228b..ac79f728d 100644 --- a/plugins/xcode/README.md +++ b/plugins/xcode/README.md @@ -1,7 +1,5 @@ # Xcode -## Description - This plugin provides a few utilities that can help you on your daily use of Xcode and iOS development. To start using it, add the `xcode` plugin to your `plugins` array in `~/.zshrc`: diff --git a/plugins/yii2/README.md b/plugins/yii2/README.md index 345b66eb6..e6c71f23e 100644 --- a/plugins/yii2/README.md +++ b/plugins/yii2/README.md @@ -1,7 +1,7 @@ # Yii2 autocomplete plugin -* Adds autocomplete commands and subcommands for yii. +Adds autocomplete commands and subcommands for [yii](https://www.yiiframework.com/). ## Requirements -Autocomplete works from directory where your `yii` file contains. +Autocomplete works from directory where your `yii` file is contained. diff --git a/plugins/zsh-interactive-cd/README.md b/plugins/zsh-interactive-cd/README.md index 4bffbf04a..29812a295 100644 --- a/plugins/zsh-interactive-cd/README.md +++ b/plugins/zsh-interactive-cd/README.md @@ -1,5 +1,7 @@ # zsh-interactive-cd +This plugin provides an interactive way to change directories in zsh using fzf. + ## Demo ![demo](demo.gif) @@ -8,7 +10,11 @@ 1. Install [fzf](https://github.com/junegunn/fzf) by following its [installation instruction](https://github.com/junegunn/fzf#installation). -2. Source `zsh-interactive-cd.plugin.zsh` in `.zshrc`. +2. Add `zsh-interactive-cd` to your plugin list in `~/.zshrc`: + + ```zsh + plugins=(... zsh-interactive-cd) + ``` ## Usage -- cgit v1.2.3-70-g09d2 From d78275fdbb876cee9c55f5c2731b8c1fac7be6d2 Mon Sep 17 00:00:00 2001 From: Alexander Cyon Date: Sun, 1 Sep 2024 21:01:27 +0200 Subject: chore: fix typos (#12647) --- plugins/bedtools/_bedtools | 2 +- plugins/brew/brew.plugin.zsh | 2 +- plugins/docker/docker.plugin.zsh | 2 +- plugins/emoji/update_emoji.py | 4 ++-- plugins/gem/gem.plugin.zsh | 2 +- plugins/history-substring-search/history-substring-search.zsh | 4 ++-- plugins/hitchhiker/fortunes/hitchhiker | 2 +- plugins/lpass/_lpass | 2 +- plugins/python/python.plugin.zsh | 2 +- plugins/rails/_rails | 4 ++-- plugins/swiftpm/_swift | 2 +- plugins/zsh-navigation-tools/README.md | 2 +- plugins/zsh-navigation-tools/doc/n-preview | 2 +- 13 files changed, 16 insertions(+), 16 deletions(-) (limited to 'plugins/swiftpm') diff --git a/plugins/bedtools/_bedtools b/plugins/bedtools/_bedtools index ef6c4179a..15e3dc2ff 100644 --- a/plugins/bedtools/_bedtools +++ b/plugins/bedtools/_bedtools @@ -47,7 +47,7 @@ case $state in "random[Generate random intervals in a genome.]" \ "reldist[Calculate the distribution of relative distances b/w two files.]" \ "sample[Sample random records from file using reservoir sampling.]" \ - "shuffle[Randomly redistrubute intervals in a genome.]" \ + "shuffle[Randomly redistribute intervals in a genome.]" \ "slop[Adjust the size of intervals.]" \ "sort[Order the intervals in a file.]" \ "subtract[Remove intervals based on overlaps b/w two files.]" \ diff --git a/plugins/brew/brew.plugin.zsh b/plugins/brew/brew.plugin.zsh index a138a4827..4dab6f413 100644 --- a/plugins/brew/brew.plugin.zsh +++ b/plugins/brew/brew.plugin.zsh @@ -24,7 +24,7 @@ if (( ! $+commands[brew] )); then fi if [[ -z "$HOMEBREW_PREFIX" ]]; then - # Maintain compatability with potential custom user profiles, where we had + # Maintain compatibility with potential custom user profiles, where we had # previously relied on always sourcing shellenv. OMZ plugins should not rely # on this to be defined due to out of order processing. export HOMEBREW_PREFIX="$(brew --prefix)" diff --git a/plugins/docker/docker.plugin.zsh b/plugins/docker/docker.plugin.zsh index 19269427e..16db77df6 100644 --- a/plugins/docker/docker.plugin.zsh +++ b/plugins/docker/docker.plugin.zsh @@ -39,7 +39,7 @@ if (( ! $+commands[docker] )); then return fi -# Standarized $0 handling +# Standardized $0 handling # https://zdharma-continuum.github.io/Zsh-100-Commits-Club/Zsh-Plugin-Standard.html 0="${${ZERO:-${0:#$ZSH_ARGZERO}}:-${(%):-%N}}" 0="${${(M)0:#/*}:-$PWD/$0}" diff --git a/plugins/emoji/update_emoji.py b/plugins/emoji/update_emoji.py index 18b3c060d..9e115a7fa 100644 --- a/plugins/emoji/update_emoji.py +++ b/plugins/emoji/update_emoji.py @@ -1,6 +1,6 @@ """ Update Emoji.py -Refeshes OMZ emoji database based on the latest Unicode spec +Refreshes OMZ emoji database based on the latest Unicode spec """ import re import json @@ -95,7 +95,7 @@ def name_to_omz(_name, _group, _subgroup, _status): shortname = snake_case(_name) # Special treatment by status # Enables us to have every emoji combination, - # even the one that are not officially sanctionned + # even the one that are not officially sanctioned # and are implemented by, say, only one vendor if _status == "unqualified": shortname += "_unqualified" diff --git a/plugins/gem/gem.plugin.zsh b/plugins/gem/gem.plugin.zsh index b8a49fb56..58716594d 100644 --- a/plugins/gem/gem.plugin.zsh +++ b/plugins/gem/gem.plugin.zsh @@ -23,7 +23,7 @@ if is-at-least 5.5; then fi { - # Standarized $0 handling + # Standardized $0 handling # https://zdharma-continuum.github.io/Zsh-100-Commits-Club/Zsh-Plugin-Standard.html 0="${${ZERO:-${0:#$ZSH_ARGZERO}}:-${(%):-%N}}" 0="${${(M)0:#/*}:-$PWD/$0}" diff --git a/plugins/history-substring-search/history-substring-search.zsh b/plugins/history-substring-search/history-substring-search.zsh index 2137b7950..9f0e0b0d5 100644 --- a/plugins/history-substring-search/history-substring-search.zsh +++ b/plugins/history-substring-search/history-substring-search.zsh @@ -295,8 +295,8 @@ _history-substring-search-begin() { fi # - # Escape and join query parts with wildcard character '*' as seperator - # `(j:CHAR:)` join array to string with CHAR as seperator + # Escape and join query parts with wildcard character '*' as separator + # `(j:CHAR:)` join array to string with CHAR as separator # local search_pattern="${(j:*:)_history_substring_search_query_parts[@]//(#m)[\][()|\\*?#<>~^]/\\$MATCH}*" diff --git a/plugins/hitchhiker/fortunes/hitchhiker b/plugins/hitchhiker/fortunes/hitchhiker index 94cc1c835..6620a2a4f 100644 --- a/plugins/hitchhiker/fortunes/hitchhiker +++ b/plugins/hitchhiker/fortunes/hitchhiker @@ -42,7 +42,7 @@ - Zaphod. % -"`In those days spirits were brave, the stakes were high, men were REAL men, women were REAL women, and small furry creatures from Alpha Centauri were REAL small furry creatures from Aplha Centauri.'" +"`In those days spirits were brave, the stakes were high, men were REAL men, women were REAL women, and small furry creatures from Alpha Centauri were REAL small furry creatures from Alpha Centauri.'" - The Book getting all nostalgic. % diff --git a/plugins/lpass/_lpass b/plugins/lpass/_lpass index 621a7bcd7..e312fb9a3 100644 --- a/plugins/lpass/_lpass +++ b/plugins/lpass/_lpass @@ -78,7 +78,7 @@ _lpass() { has_sync=1 ;; status) - _arguments : '(-q --quiet)'{-q,--quiet}'[Supress output to stdout]' + _arguments : '(-q --quiet)'{-q,--quiet}'[Suppress output to stdout]' has_color=1 ;; sync) diff --git a/plugins/python/python.plugin.zsh b/plugins/python/python.plugin.zsh index 6d7f440aa..811745257 100644 --- a/plugins/python/python.plugin.zsh +++ b/plugins/python/python.plugin.zsh @@ -74,7 +74,7 @@ function vrun() { } # Create a new virtual environment using the specified name. -# If none specfied, use $PYTHON_VENV_NAME +# If none specified, use $PYTHON_VENV_NAME function mkv() { local name="${1:-$PYTHON_VENV_NAME}" local venvpath="${name:P}" diff --git a/plugins/rails/_rails b/plugins/rails/_rails index 48fd1909e..dbd843c80 100644 --- a/plugins/rails/_rails +++ b/plugins/rails/_rails @@ -366,10 +366,10 @@ _rails_generate() { ;| (controller|job|model|resource|scaffold) opts+=( - '--parent=[The parent class for the generated controler]:parent class' + '--parent=[The parent class for the generated controller]:parent class' ) ;| - (controler|mailer|resource|scaffold|scaffold_controller) + (controller|mailer|resource|scaffold|scaffold_controller) opts+=( '(-e --template-engine)'{-e,--template-engine=}'[Template engine to be invoked]:engine:(erb)' ) diff --git a/plugins/swiftpm/_swift b/plugins/swiftpm/_swift index f9a603f58..358d1dcae 100644 --- a/plugins/swiftpm/_swift +++ b/plugins/swiftpm/_swift @@ -634,7 +634,7 @@ _swift_package_unedit() { integer ret=1 local -a args args+=( - '--force[Unedit the package even if it has uncommited and unpushed changes]' + '--force[Unedit the package even if it has uncommitted and unpushed changes]' ':package-name:' '--version[Show the version.]' '(-help -h --help)'{-help,-h,--help}'[Show help information.]' diff --git a/plugins/zsh-navigation-tools/README.md b/plugins/zsh-navigation-tools/README.md index 4dc9cdba2..6d6c22f4f 100644 --- a/plugins/zsh-navigation-tools/README.md +++ b/plugins/zsh-navigation-tools/README.md @@ -185,7 +185,7 @@ Result is stored as `$reply[REPLY]` (`$` isn't needed before `REPLY` because of arithmetic context inside `[]`). The returned array might be different from input arguments as `n-list` can process them via incremental search or uniq mode. `$REPLY` is the index in that possibly processed array. If `$REPLY` -equals `-1` it means that no selection have been made (user quitted via `q` +equals `-1` it means that no selection have been made (user quit via `q` key). To set up entries that can be jumped to with `[`,`]` keys add their indices to diff --git a/plugins/zsh-navigation-tools/doc/n-preview b/plugins/zsh-navigation-tools/doc/n-preview index 2d8eea3fb..bcbbb88c7 100644 --- a/plugins/zsh-navigation-tools/doc/n-preview +++ b/plugins/zsh-navigation-tools/doc/n-preview @@ -170,7 +170,7 @@ while (( 1 )); do elif [ -n "$keypad" ]; then final_key="$keypad" else - _vpreview_status_msg "Inproper input detected" + _vpreview_status_msg "Improper input detected" zcurses refresh status fi -- cgit v1.2.3-70-g09d2