autocomplete - Figは、端末にオートコンプリートを追加します。

(Fig adds autocomplete to your terminal.)

Created at: 2020-09-29 10:21:06
Language: TypeScript
License: MIT

イチジクのロゴ イチジクのロゴ


バッジ:macOS バッジ:サインアップ(パブリックベータ) バッジ:ドキュメント バッジ:寄稿者 バッジ:Discordサーバーに参加する バッジ:Twitterでフォロー

Figは、端末にオートコンプリートを追加します。

入力すると、Figは、macOS上の既存の端末にサブコマンド、オプション、およびコンテキストに関連する引数をポップアップ表示します。

⚡️インストール

  • macOS
    • 自作
      brew install --cask fig
    • DMG:当社のWebサイトからダウンロード:fig.io
  • Windows / Linux

注:ダウンロードしたら、アプリを起動してFig!を設定します。


ターミナルでのFigのビジュアルオートコンプリートのデモ


👋「完了仕様」とは何ですか?

完了仕様は、CLIツールのおよびを指定する宣言型スキーマです。Figはこれらのスキーマを使用して提案を生成します。

subcommands
options
args


😎3分以内に最初の仕様を投稿する

以下の手順を使用するか、スタートガイドに従ってください:fig.io/docs

前提条件:

  • macOS用のFigをダウンロード
  • ノードとNPM(またはヤーン)

手順

  1. このリポジトリをフォークするには、ここをクリックしてください。

  2. フォークされたリポジトリのクローンを作成し、サンプルスペックを作成します

    # Replace `YOUR_GITHUB_USERNAME` with your own github username
    git clone https://github.com/YOUR_GITHUB_USERNAME/autocomplete.git fig-autocomplete
    cd fig-autocomplete
    
    # Add withfig/autocomplete as a remote
    git remote add upstream https://github.com/withfig/autocomplete.git
    
    # Install packages
    npm install
    
    # Create an example spec (call it "abc")
    npm run create-spec abc
    
    # Turn on "dev mode"
    npm run dev
  3. 次に、ターミナルに移動して、と入力し

    abc[space]
    ます。サンプルスペックが表示されます。😊

その他の知っておくべきこと

  • src/
    フォルダ内のTypeScriptで仕様を編集します
  • build/
    保存時に、スペックはフォルダにコンパイルされます
  • 開発モードでは、スペックが
    build
    フォルダーから読み取られ、ジェネレーターはすべてのキーストロークを実行します。

🏠ローカルスクリプトを補完する

Figのオートコンプリートを独自のツールにも使用できます。プライベート補完を作成する方法は次のとおりです。

# Make sure you're in your home directory
cd ~

# Create your .fig/autocomplete folder
npx @withfig/autocomplete-tools init
cd ~/.fig/autocomplete

# Create your completions!
npm run create-spec xyz
npm run build

プロジェクトスクリプトの補完を作成したり、公式仕様にカスタム提案を追加したりすることもできます。詳細については、fig.io / docs / guides/private-autocompleteをご覧ください。


📦その他の利用可能なpackage.jsonコマンド

# Typecheck all specs in the src/ folder
npm test

# Compile typescripts specs from src/ folder to build/ folder
npm run build

# Lint and fix issues
npm run lint:fix

🔥貢献

私たちは以下のための貢献を望んでいます:

  • 新しい完成仕様
  • 既存の完了仕様のエラー(たとえば、サブコマンド、オプション、または引数の欠落)
  • 引数提案のジェネレータ
  • より良い説明、アイコンなど
  • テーマ

投稿できない場合は、お気軽に問題を開いてください。

😊助けが必要?

私たちのコミュニティに参加する
不和のロゴ

🧑‍💻チーム/エンタープライズ

Figを使用してオートコンプリートの内部CLIツールを追加したいですか?または、職場でFigを使用したいが、セキュリティ/コンプライアンスの懸念がある。

セットアップのお手伝いをさせていただきます。[email protected]にメールしてください

🙋‍♀️よくある質問

Figはどの端末で動作しますか?

Figは、ネイティブのmacOSターミナルアプリ、iTermTabbyHyperKittyWezTerm、およびAlacrittyで動作します。また、 VSCodeJetBrains IDEAndroid Studio、およびNovaの統合端末でも機能します。

別の端末が含まれているのを見たいですか?課題追跡システムを確認して、サポートを追加してください。

Figはどのように機能しますか?

Figは、MacのAccessibility APIを使用してウィンドウを配置し、シェルと統合して入力内容を読み取ります。

FigはWindowsまたはLinuxで動作しますか?

まだ、Figは今のところMacOSでのみ利用可能です。WindowsLinuxのサポートが進行中です!

Figをダウンロードするにはどうすればよいですか?

または、 fig.io /

brew install fig
downloadでアプリをダウンロードします。次に、Figアプリを起動します!

Figを使用して、チームの内部スクリプトとCLIツールのオートコンプリートを作成できますか?

はい!オートコンプリート仕様の作成を開始する方法については、ガイドをご覧ください。

PRを提出するにはどうすればよいですか?

寄稿方法ガイドをご覧ください。Figの200人以上の貢献者の多くは、Figに最初のオープンソースの貢献をしました!

イチジクは私には効きません!

Discordサーバーに参加して、デバッグします。セットアップでFigを修正すると、他の人にも修正されます。🙂

私たちは何かを逃しましたか?

[email protected]に連絡するか、 Discordでチャットしてください。


寄稿者

200人以上の寄稿者のプロフィールアイコンのグリッド