feat(completion): print completion code to stdout #7597

KSXGitHub · 2024-01-30T17:12:57Z

Resolves #3083

Unlike install-completion which would write files to the filesystem for you, completion only prints the code for completion to stdout. It is the responsibility of the user to convert the code in the stdout to a completion file and source them from their login shell.

Usage Example: Create completion script for ZSH and source them from .zshrc

pnpm completion zsh > ~/pnpm-completion.zsh
echo 'source "$HOME/pnpm-completion.zsh"' >> ~/.zshrc

Resolves #3083

zkochan · 2024-01-30T17:36:28Z

The referenced issue mentions that helm and kubectl use the completion command. So, let's also name it pnpm completion.

zkochan · 2024-01-30T17:38:36Z

actually, that would conflict with the completion command that is called by the tabtab script. I wonder if we should rename that command too. We can do these breaking changes as this will be released in pnpm v9.

KSXGitHub · 2024-01-30T17:39:06Z

The referenced issue mentions that helm and kubectl use the completion command. So, let's also name it pnpm completion.

I suspect pnpm completion is already used. How else would the completion scripts be able to work if not through pnpm completion?

KSXGitHub · 2024-01-30T17:42:14Z

actually, that would conflict with the completion command that is called by the tabtab script. I wonder if we should rename that command too. We can do these breaking changes as this will be released in pnpm v9.

I'm fine either way. generate-completion is symmetrical to the other commands install-completion and uninstall-completion. Besides, this command is only called once per user per setup.

zkochan · 2024-01-30T23:48:12Z

npm has a completion command for doing exactly the same thing. And for getting the list of completions it uses npm completion --.

But it is also not super important, so I don't know.

KSXGitHub · 2024-01-31T04:14:06Z

@zkochan I guess we can redirect pnpm completion -- $SHELL to pnpm generate-completion $SHELL for convenience. By "redirect", I mean child_process.spawnSync.

KSXGitHub · 2024-01-31T04:19:21Z

But should we though? Overloading functionalities doesn't look maintainable in the long run.

KSXGitHub · 2024-01-31T04:25:05Z

Besides, I think pnpm generate-completion $SHELL is clearer and more explicit than pnpm completion -- $SHELL. I do not know how npm users know npm completion -- $SHELL is the way to get completion code, but this behavior doesn't look intuitive to me. And if the user forgets to provide $SHELL argument for pnpm generate-completion, a helpful error message would appear and tell the user what they did wrong, instead of an empty output like the case of pnpm completion.

zkochan · 2024-01-31T08:58:00Z

No, npm uses npm completion $SHELL to generate completion code (like helm and kubectl). npm completion -- is called by the completion script to generate the list of completions.

KSXGitHub · 2024-01-31T09:04:34Z

npm completion -- is called by the completion script to generate the list of completions.

So this would still requires changes on tabtab codebase after all. The tabtab codebase is kind of a mess right now, tests failing left and right.

zkochan · 2024-01-31T09:07:04Z

I guess, the command that tabtab executes can be renamed to something else, like pnpm list-completions for instance.

* switch to provided type declarations * fix typings * update tests * update bundle scripts

KSXGitHub

@zkochan I require your inputs.

pnpm/src/cmd/complete.ts

KSXGitHub · 2024-02-01T12:06:11Z

I have renamed generate-completion to just completion.

pnpm/src/cmd/completion.ts

pnpm/src/pnpm.ts

Just `pnpm completion` is enough

KSXGitHub · 2024-02-05T18:27:44Z

The commands install-completion and uninstall-completion have been removed (ed658a6).

zkochan

I don't think 2 plugins packages are needed. All the completion related commands can be in one package.

completion/plugin-commands-completion-server/src/getOptionType.ts

KSXGitHub · 2024-02-06T05:56:05Z

I have merged plugin-commands-completion-server into plugin-commands-completion.

zkochan

The changesets don't describe all the changes.

zkochan · 2024-02-06T09:56:01Z

pnpm/src/pnpm.ts

@@ -15,8 +15,13 @@ const argv = process.argv.slice(2)
    break
  }
  case 'install-completion': {


you said you'll remove install-completion and uninstall-completion from the commands.

I converted them to plugins then forgot to remove them here. When I remove them, I completely forgot to remove the switch block.

feat(completion): generate-completion

0b16c50

Resolves #3083

KSXGitHub requested a review from zkochan as a code owner January 30, 2024 17:12

KSXGitHub mentioned this pull request Jan 30, 2024

Should not modify user shell dotfiles #3083

Closed

KSXGitHub added 2 commits January 31, 2024 00:18

feat: better error message

56a4743

test: generate-completion

934f91c

KSXGitHub added 2 commits January 31, 2024 18:00

feat(completion): add powershell

137cd50

chore(deps): update @pnpm/tabtab to 0.3.0

6863f3d

* switch to provided type declarations * fix typings * update tests * update bundle scripts

KSXGitHub commented Jan 31, 2024

View reviewed changes

pnpm/src/cmd/complete.ts Outdated Show resolved Hide resolved

pnpm/src/cmd/complete.ts Outdated Show resolved Hide resolved

KSXGitHub mentioned this pull request Feb 1, 2024

feat(protocol): change the completion entry pnpm/tabtab#18

Merged

KSXGitHub added 4 commits February 1, 2024 17:22

refactor: remove unnecessary ??

d66fccc

refactor: replace a type def with provided types

c4e0872

chore(deps): update @pnpm/tabtab to 0.4.0

81f8140

feat(cli): rename completion command

2de84b8

KSXGitHub changed the title ~~feat(completion): generate-completion~~ feat(completion): print completion code to stdout Feb 1, 2024

zkochan reviewed Feb 1, 2024

View reviewed changes

pnpm/src/cmd/completion.ts Show resolved Hide resolved

pnpm/src/pnpm.ts Outdated Show resolved Hide resolved

KSXGitHub added 3 commits February 2, 2024 15:31

chore(deps): update @pnpm/tabtab to 0.4.1

3cb6ba4

refactor: use tabtab's new features

f88b7ee

fix: pass shell

4aabed3

KSXGitHub added 2 commits February 2, 2024 22:26

chore(deps): update @pnpm/tabtab to 0.5.1

2dc404a

fix: remove unused import

411e45a

KSXGitHub force-pushed the print-completions-instead-modification-3083 branch 2 times, most recently from 8f03869 to 6ae45a0 Compare February 4, 2024 18:18

KSXGitHub marked this pull request as draft February 4, 2024 18:21

KSXGitHub force-pushed the print-completions-instead-modification-3083 branch 7 times, most recently from 64406ed to 061bd0b Compare February 5, 2024 11:47

refactor: move completion to plugins

738c090

KSXGitHub force-pushed the print-completions-instead-modification-3083 branch from 061bd0b to 738c090 Compare February 5, 2024 18:21

feat: remove {install,uninstall}-completion

ed658a6

Just `pnpm completion` is enough

KSXGitHub marked this pull request as ready for review February 5, 2024 18:28

zkochan reviewed Feb 6, 2024

View reviewed changes

completion/plugin-commands-completion-server/src/getOptionType.ts Outdated Show resolved Hide resolved

KSXGitHub added 4 commits February 6, 2024 12:37

test: fix

b59e603

refactor: direct import

72aa976

refactor: move tests to next to the lib

786d72e

refactor: merge 2 packages into 1

fa4390e

KSXGitHub requested a review from zkochan February 6, 2024 05:55

chore(git): merge from main

36c2d23

zkochan reviewed Feb 6, 2024

View reviewed changes

fix: update changeset and remove install-completion

e836fbf

zkochan approved these changes Feb 6, 2024

View reviewed changes

zkochan merged commit 004addf into main Feb 6, 2024
13 of 14 checks passed

zkochan deleted the print-completions-instead-modification-3083 branch February 6, 2024 22:18

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(completion): print completion code to stdout #7597

feat(completion): print completion code to stdout #7597

KSXGitHub commented Jan 30, 2024 •

edited

zkochan commented Jan 30, 2024

zkochan commented Jan 30, 2024

KSXGitHub commented Jan 30, 2024

KSXGitHub commented Jan 30, 2024

zkochan commented Jan 30, 2024 •

edited

KSXGitHub commented Jan 31, 2024

KSXGitHub commented Jan 31, 2024

KSXGitHub commented Jan 31, 2024

zkochan commented Jan 31, 2024

KSXGitHub commented Jan 31, 2024

zkochan commented Jan 31, 2024

KSXGitHub left a comment

KSXGitHub commented Feb 1, 2024

KSXGitHub commented Feb 5, 2024

zkochan left a comment

KSXGitHub commented Feb 6, 2024

zkochan left a comment

zkochan Feb 6, 2024

KSXGitHub Feb 7, 2024

feat(completion): print completion code to stdout #7597

feat(completion): print completion code to stdout #7597

Conversation

KSXGitHub commented Jan 30, 2024 • edited

zkochan commented Jan 30, 2024

zkochan commented Jan 30, 2024

KSXGitHub commented Jan 30, 2024

KSXGitHub commented Jan 30, 2024

zkochan commented Jan 30, 2024 • edited

KSXGitHub commented Jan 31, 2024

KSXGitHub commented Jan 31, 2024

KSXGitHub commented Jan 31, 2024

zkochan commented Jan 31, 2024

KSXGitHub commented Jan 31, 2024

zkochan commented Jan 31, 2024

KSXGitHub left a comment

Choose a reason for hiding this comment

KSXGitHub commented Feb 1, 2024

KSXGitHub commented Feb 5, 2024

zkochan left a comment

Choose a reason for hiding this comment

KSXGitHub commented Feb 6, 2024

zkochan left a comment

Choose a reason for hiding this comment

zkochan Feb 6, 2024

Choose a reason for hiding this comment

KSXGitHub Feb 7, 2024

Choose a reason for hiding this comment

KSXGitHub commented Jan 30, 2024 •

edited

zkochan commented Jan 30, 2024 •

edited