feat(g-plane/pnpm-shell-completion): scaffold g-plane/pnpm-shell-completion

[elecdeer]

pnpm-shell-completion: a shell plugin designed to enhance the command-line experience with pnpm by providing tab-completion features.

This shell plugin calls a Rust-based executable to provide completion functionality. Managing shell plugins is outside the scope of aqua. However, since the executable to be used may vary depending on the environment, it is convenient to be able to install it with aqua.

Check List

• Read CONTRIBUTING.md
  • Read OSS Contribution Guide
• All commits are signed
  • This repository enables Require signed commits, so all commits must be signed
• Avoid force push
• Do only one thing in one Pull Request

How to confirm if this package works well

# Any repository that uses pnpm will do.
$ git clone https://github.com/pnpm/pnpm.git

$ cd pnpm

# This simulates a call from script.
# https://github.com/g-plane/pnpm-shell-completion/blob/main/pnpm-shell-completion.plugin.zsh
$ FEATURE=scripts pnpm-shell-completion
test-pkgs-main
make-lcov
pretest
prepare
watch
compile
compile-only
preinstall
remove-temp-dir
test-main
update-manifests
meta-updater
make-release-description
dev-setup
test-branch
spellcheck
lint:meta
bump
test-pkgs-branch
changeset
lint:ts
copy-artifacts
lint
release

[suzuki-shunsuke]

Thank you for your contribution!

I'm not familiar with this tool, but I'm wondering if aqua can support this tool.

This tool requires to execute a script install.sh, but aqua doesn't support it.

zsh https://github.com/g-plane/pnpm-shell-completion?tab=readme-ov-file#manual

./install.zsh $ZSH_CUSTOM/plugins

fish https://github.com/g-plane/pnpm-shell-completion?tab=readme-ov-file#manual-install

fish ./install.fish ${any path that has been added in your $PATH variable}

I checked the content of tarball.

pnpm-shell-completion_aarch64-apple-darwin.tar.gz

$ tar xvzf pnpm-shell-completion_aarch64-apple-darwin.tar.gz 
x LICENSE
x README.md
x install.fish
x install.zsh
x pnpm-shell-completion
x pnpm-shell-completion.plugin.zsh
x pnpm.fish

install.zsh

set -x

if [ -z "$1" ]; then
    echo "Plugins directory not specified, please pass your zsh plugins directory as a parameter."
    exit 1
fi

if [ ! -d $1/pnpm-shell-completion ]; then
    mkdir $1/pnpm-shell-completion
fi

cp ./pnpm-shell-completion.plugin.zsh $1/pnpm-shell-completion
cp ./pnpm-shell-completion $1/pnpm-shell-completion

The install script creates the plugin directory and copies pnpm-shell-completion into it, which aqua doesn't support it.

[elecdeer]

I am aware that Aqua does not support executing shell scripts.

In the install.sh, file copying is performed, but this is not crucial for the functioning of this plugin. In reality, as long as pnpm-shell-completion.plugin.zsh and pnpm-shell-completion exist in the same directory, and the .plugin.zsh is sourced from .zshrc or similar, it will work.

The former is handled by aqua i -a, and the latter can be fulfilled by adding the following script to .zshrc:

local plugin_path_dir=$(dirname $(aqua which pnpm-shell-completion))
local plugin_path="${plugin_path_dir}/pnpm-shell-completion.plugin.zsh"
source $plugin_path

I think there are other packages, like starship/starship, that require loading additional shell scripts in addition to using aqua i.

What do you think?

[suzuki-shunsuke]

I see. Thank you for your explanation.
I think it looks good.
ebed885 I added the guide.

[suzuki-shunsuke]

v4.213.0 is out 🎉
https://github.com/aquaproj/aqua-registry/releases/tag/v4.213.0