provide installation utilities
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 35/100
- issue の種類
- 機能追加
- 明瞭さ
- 説明が足りない
- 活発さ
- 静か
- 技術スタック
- typescript
- 領域
- cli
調査の方向性
まず、tab が現在どのようにシェル補完を公開しているか、また利用する CLI が my-cli init や my-cli complete --install のようなコマンドを通じてそれらをどのように統合するかを調べます。この issue で示されているサポート対象のインストールおよびシェルのケースを、スタンドアロン、グローバルな npm、プロジェクトローカルのインストールを含めて定義します。完了とは、インストールユーティリティのスコープと動作について合意し、実装したうえで、サポート対象の各ケースを検証できることを意味します。
索引モデルが issue の本文から書いたものです。
説明
CLIs using tab will ideally provide a bit of functionality to help the user install completions. Since we'll all be recreating the same logic, it seems to me like it should be built into tab itself. It should probably be provided as a utility function which can be either invoked within a larger setup flow (my-cli init) or as specific command (my-cli complete --install)
I haven't dug in too deep yet, but I'm imagining this would:
- detect the current shell (if not passed in explicitly)
- check if the completions are already installed
- either install or update the completion setup
In the process of figuring this out for our CLI (https://varlock.dev), I also realized that the way the CLI is installed can affect how it must be set up. Our tool can be installed as a standalone binary via curl or brew, as a global node_module (npm i -g), or within a project's node_modules. The installation utilities should also probably take care of detecting how the cli is installed and warn (or error?) if the tool is not on the user's PATH.
Supporting completions for locally installed packages invoked via package manager (pnpm exec my-cli) is something I'd love to see happen, but I'm guessing it's just not possible unless the package managers themselves support it?
- 主要言語
- TypeScript
- スター
- 280
- フォーク
- 11
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
bombshell-dev/tab のほかの issue
-
An option is resolved from the root before the matched command, so a short name means one thing for the whole line対応中かも @AmirSa12 が 4 日前に担当しました。 オープン
難易度 4/5 3〜5日 初心者へのやさしさ 56/100
bombshell-dev/tab#153 · コメント 6 件 ·
-
enhancement
難易度 3/5 1〜2日 初心者へのやさしさ 55/100
bombshell-dev/tab#127 · コメント 2 件 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 55/100
bombshell-dev/tab#118 ·
-
難易度 4/5 3〜5日 初心者へのやさしさ 48/100
bombshell-dev/tab#107 · コメント 3 件 ·
-
documentation enhancement
難易度 5/5 1週間以上 初心者へのやさしさ 30/100
bombshell-dev/tab#106 · コメント 1 件 ·
bombshell-dev/tab の issue をすべて見る
似ている issue
-
[Docs] README: FAQ setup command, IDA in the intro, Node badge対応中かも @akram1089 が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
メンテナーはふだん 1 日以内に返信
-
[Feature]: [P3] engine-rs: the package source hash should ignore line endings and untracked filesオープン
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
maniator/verticopolis#880 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
siyuan-note/siyuan#20353 ·
メンテナーはふだん 1 日以内に返信
-
afk-ok area:data-quality importer size:S
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
enorm-labs/event-junkie#3027 ·
メンテナーはふだん 1 日以内に返信