forked from withfig/autocomplete
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge remote-tracking branch 'origin/master' into feat/git_add_priori…
…ty_based_on_current_files
- Loading branch information
Showing
553 changed files
with
588,502 additions
and
67,987 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,10 +5,10 @@ contact_links: | |
| name: Not an autocomplete issue? | ||
| url: "https://github.com/withfig/fig/issues/new/choose" | ||
| - about: "Fig's support knowledge base" | ||
| name: "💬 Forum" | ||
| url: "https://forum.withfig.com" | ||
| - about: "Get instant support from the Fig Community Slack" | ||
| name: "👋 Slack" | ||
| name: "💬 User Support" | ||
| url: "https://fig.io/support" | ||
| - about: "Get instant support from the Fig Community Discord" | ||
| name: "👋 Discord" | ||
| url: "https://fig.io/community" | ||
| - about: "Get support from the Fig team at [email protected]" | ||
| name: "📩 Email" | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -11,19 +11,24 @@ jobs: | |
| update_page: | ||
| runs-on: "ubuntu-latest" | ||
| env: | ||
| UPDATE_SITE_TOKEN: ${{ secrets.UPDATE_DOCS_TOKEN }} | ||
| UPDATE_SITE_TOKEN: ${{ secrets.UPDATE_PRIVATE_DOCS_TOKEN }} | ||
| steps: | ||
| - uses: actions/checkout@v2 | ||
| - name: update submodules | ||
| run: | | ||
| git clone https://withfig-bot:[email protected]/withfig/docs.git | ||
| cd docs | ||
| git clone https://withfig-bot:[email protected]/withfig/public-site-nextjs.git | ||
| cd public-site-nextjs | ||
| curl https://docs-generator.cstrnt.workers.dev/ > autocomplete/api.md | ||
| curl https://fig.io/api/docs/parseDocs -o newDocs.zip | ||
| git config user.email "[email protected]" | ||
| unzip -o newDocs.zip -d docs/autocomplete/schemas/ | ||
| rm -f newDocs.zip | ||
| git config user.email "[email protected]" | ||
| git config user.name "Figbot" | ||
| git add autocomplete/api.md | ||
| git commit -m "added updates to docs" | ||
| git add docs/autocomplete/schemas/ | ||
| git commit -m "added updates to docs" --allow-empty | ||
| git push origin main --force | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,5 +6,8 @@ dist | |
| build | ||
| npm-debug.log | ||
| .env | ||
|
|
||
| .idea/ | ||
| .vscode | ||
| specs | ||
| .idea/ | ||
| .vscode | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| { | ||
| "recommendations": ["dbaeumer.vscode-eslint", "esbenp.prettier-vscode"] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| { | ||
| "editor.defaultFormatter": "esbenp.prettier-vscode", | ||
| "editor.codeActionsOnSave": { | ||
| "source.fixAll.eslint": true | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -49,6 +49,6 @@ By contributing, you agree that your contributions will be licensed under its MI | |
|
|
||
| ## Questions and support | ||
|
|
||
| For product support, visit our [docs](https://fig.io/docs) and join the [Fig Community](https://figcommunity.slack.com/join/shared_invite/zt-fupa9n8g-sfHm8MyBn1DBaCj8SoIxSA#/) for instant support and discussion. | ||
| For product support, visit our [docs](https://fig.io/docs) and join the [Fig Community](https://fig.io/community) for instant support and discussion. | ||
|
|
||
| Any unanswered questions or inquiries? We're always open to chat at [email protected]. | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,45 +6,69 @@ | |
|
|
||
|  | ||
| [](https://fig.io?ref=github_autocomplete) | ||
| [](https://fig.io/docs/autocomplete/getting-started) | ||
| [](#Contributors) | ||
| [](https://fig.io/community) | ||
| [](https://fig.io/docs/) | ||
| [](#Contributors) | ||
|  | ||
| [](https://twitter.com/intent/follow?screen_name=fig) | ||
|
|
||
| **[Fig](https://fig.io?ref=github_autocomplete) adds autocomplete to the terminal.** As you type, Fig pops up subcommands, options, and contextually relevant arguments in your existing terminal on macOS. | ||
| **[Fig](https://fig.io?ref=github_autocomplete) adds autocomplete to your terminal.** | ||
|
|
||
| As you type, Fig pops up subcommands, options, and contextually relevant arguments in your existing terminal on macOS. | ||
|
|
||
|  | ||
|
|
||
| ## Add a completion spec for a CLI tool | ||
| <br/> | ||
|
|
||
| ## 👋 Add a completion spec for a CLI tool | ||
|
|
||
| Want to add autocomplete to a CLI tool (or make changes to an existing autocomplete spec)? We welcome contributions for new specs! | ||
|
|
||
| Completion specs are defined in a _declarative_ schema that specifies `subcommands`, `options` and `arguments`. Suggestions are generated from information in the spec or can be generated dynamically by running shell commands or reading local files. | ||
|
|
||
| Looking to improve autocomplete functionality or add support for your favorite CLI tool? We welcome contributions for new specs! | ||
| **For documentation and tutorials**, visit [fig.io/docs](https://fig.io/docs/autocomplete/getting-started) | ||
|
|
||
| Completion specs are defined in a _declarative_ schema that specifies `subcommands`, `options` and `arguments`. Suggestions can be generated dynamically by running shell commands or reading local files, in addition to the information in the spec itself. | ||
| **To request autocomplete for a CLI tool**, open an [issue](https://github.com/withfig/autocomplete/issues/new/choose). | ||
|
|
||
| **For more documentation and tutorials**, visit [fig.io/docs](https://fig.io/docs/autocomplete/getting-started) | ||
| <br/> | ||
|
|
||
| ## 😎 Get Started | ||
|
|
||
| Build your first spec in < 3 min: [fig.io/docs/getting-started](fig.io/docs/getting-started) | ||
|
|
||
| **To request completions for a CLI tool**, open an [issue](https://github.com/withfig/autocomplete/issues/new/choose). | ||
| 1. Fork this repo | ||
| [](https://GitHub.com/withfig/autocomplete/fork/) | ||
|
|
||
| ## Get Started | ||
| 2. Clone your forked repo and create an example spec | ||
|
|
||
| ```bash | ||
| git clone https://github.com/withfig/autocomplete.git fig-autocomplete | ||
| # 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 | ||
|
|
||
| # Go into testing mode | ||
| # Create an example spec (call it "abc") | ||
| npm run create-example | ||
|
|
||
| # Turn on "dev mode" | ||
| npm run dev | ||
| ``` | ||
|
|
||
| Edit your spec in the `dev/` folder. It will compile to the `specs/` folder on save. Start testing your spec immediately in your terminal. | ||
| 3. Now go to your terminal and type `abc[space]`. Your example spec will appear 😊 | ||
|
|
||
| **Note**: Fig usually looks for completion specs in your `~/.fig/autocomplete` folder. When in testing mode, we check your cloned repo's `specs/` folder | ||
| #### Other things to know | ||
|
|
||
| - Edit your spec in typescript in the `dev/` folder | ||
| - On save, specs are compiled to the `specs/` folder | ||
| - In **dev mode** specs are read from the `specs` folders. Otherwise they are read from `~/.fig/autocomplete` | ||
|
|
||
| <br/> | ||
|
|
||
| ## Other available commands | ||
| ## 📦 Other available package.json commands | ||
|
|
||
| ```bash | ||
|
|
||
|
|
@@ -64,15 +88,25 @@ npm run copy:all | |
| npm run copy <spec-name> | ||
| ``` | ||
|
|
||
| ## FAQ | ||
| ## 😊 Need Help? | ||
|
|
||
| <p align="center"> | ||
| Join our community | ||
| <br/> | ||
| <a href="https://fig.io/community"> | ||
| <img src="http://fig.io/icons/discord-logo-square.png" width="80px" height="80px" /> | ||
| </a> | ||
| </p> | ||
|
|
||
| ## 🙋♀️ FAQ | ||
|
|
||
| #### What terminals does Fig work with? | ||
|
|
||
| Fig works with iTerm, the native MacOS Terminal app, Hyper and the integrated terminal in VSCode. | ||
|
|
||
| #### How does Fig work? | ||
|
|
||
| Fig uses the Accessibility API on Mac to insert text on your behalf and read the current keybuffer. | ||
| Fig uses the Accessibility API on Mac to position the window, insert text on your behalf, and read what you've typed in your terminal. | ||
|
|
||
| #### Does Fig work on Windows or Linux? | ||
|
|
||
|
|
@@ -88,47 +122,13 @@ Yes! Check out our guide on how to [get started building autocomplete specs](htt | |
|
|
||
| #### Did we miss something? | ||
|
|
||
| Get in touch at [email protected] or chat with us on [Slack](https://fig.io/community) | ||
|
|
||
| ## Contributors ✨ | ||
|
|
||
| <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> | ||
| <!-- prettier-ignore-start --> | ||
| <!-- markdownlint-disable --> | ||
| <table> | ||
| <tr> | ||
| <td align="center"><a href="https://github.com/falky97"><img src="https://avatars.githubusercontent.com/u/4949076?v=4" width="30px;" alt="" style="border-radius:100%!important"></a></td> | ||
| <td align="center"><a href="http://rolandshen.com/"><img src="https://avatars.githubusercontent.com/u/8952958?v=4" width="30px;" alt="" style="border-radius:100%!important"></a></td> | ||
| <td align="center"><a href="http://mschrage.com/"><img src="https://avatars.githubusercontent.com/u/3155109?v=4" width="30px;" alt="" style="border-radius:100%!important"></a></td> | ||
| <td align="center"><a href="https://cstrnt.dev/"><img src="https://avatars.githubusercontent.com/u/20679094?v=4" width="30px;" alt="" style="border-radius:100%!important"></a></td> | ||
| <td align="center"><a href="https://github.com/QuiiBz"><img src="https://avatars.githubusercontent.com/u/43268759?v=4" width="30px;" alt="" style="border-radius:100%!important"></a></td> | ||
| <td align="center"><a href="https://julius-kiekbusch.de/"><img src="https://avatars.githubusercontent.com/u/15707543?v=4" width="30px;" alt="" style="border-radius:100%!important"></a></td> | ||
| <td align="center"><a href="https://github.com/FlowyCoder"><img src="https://avatars.githubusercontent.com/u/28676154?v=4" width="30px;" alt="" style="border-radius:100%!important"></a></td> | ||
| <td align="center"><a href="https://github.com/samwinslow"><img src="https://avatars.githubusercontent.com/u/4645779?v=4" width="30px;" alt="" style="border-radius:100%!important"></a></td> | ||
| <td align="center"><a href="https://jamesj.ac/kson"><img src="https://avatars.githubusercontent.com/u/13633271?v=4" width="30px;" alt="" style="border-radius:100%!important"></a></td> | ||
| <td align="center"><a href="https://github.com/dipakparmar"><img src="https://avatars.githubusercontent.com/u/24366206?v=4" width="30px;" alt="" style="border-radius:100%!important"></a></td> | ||
| </tr> | ||
| <tr> | ||
| <td align="center"><a href="https://github.com/DannyAziz"><img src="https://avatars.githubusercontent.com/u/3679064?v=4" width="30px;" alt="" style="border-radius:100%!important"></a></td> | ||
| <td align="center"><a href="https://github.com/jdotjdot"><img src="https://avatars.githubusercontent.com/u/1328961?v=4" width="30px;" alt="" style="border-radius:100%!important"></a></td> | ||
| <td align="center"><a href="https://github.com/alexnaiman"><img src="https://avatars.githubusercontent.com/u/25799714?v=4" width="30px;" alt="" style="border-radius:100%!important"></a></td> | ||
| <td align="center"><a href="https://github.com/omichowdhury"><img src="https://avatars.githubusercontent.com/u/969419?v=4" width="30px;" alt="" style="border-radius:100%!important"></a></td> | ||
| <td align="center"><a href="https://github.com/winnayx"><img src="https://avatars.githubusercontent.com/u/46658657?v=4" width="30px;" alt="" style="border-radius:100%!important"></a></td> | ||
| <td align="center"><a href="https://github.com/Nullfuse"><img src="https://avatars.githubusercontent.com/u/61602086?v=4" width="30px;" alt="" style="border-radius:100%!important"></a></td> | ||
| <td align="center"><a href="https://github.com/vicentube"><img src="https://avatars.githubusercontent.com/u/73502080?v=4" width="30px;" alt="" style="border-radius:100%!important"></a></td> | ||
| <td align="center"><a href="https://github.com/rk-yen"><img src="https://avatars.githubusercontent.com/u/4944665?v=4" width="30px;" alt="" style="border-radius:100%!important"></a></td> | ||
| <td align="center"><a href="https://github.com/berbaroovez"><img src="https://avatars.githubusercontent.com/u/6900468?v=4" width="30px;" alt="" style="border-radius:100%!important"></a></td> | ||
| <td align="center"><a href="https://github.com/smeevil"><img src="https://avatars.githubusercontent.com/u/13874?v=4" width="30px;" alt="" style="border-radius:100%!important"></a></td> | ||
| </tr> | ||
| <tr> | ||
| <td align="center"><a href="https://github.com/Chair4ce"><img src="https://avatars.githubusercontent.com/u/33118919?v=4" width="30px;" alt="" style="border-radius:100%!important"></a></td> | ||
| <td align="center"><a href="https://github.com/LI0131"><img src="https://avatars.githubusercontent.com/u/4829473?v=4" width="30px;" alt="" style="border-radius:100%!important"></a></td> | ||
| <td align="center"><a href="http://sauntimo.org/"><img src="https://avatars.githubusercontent.com/u/2720466?v=4" width="30px;" alt="" style="border-radius:100%!important"></a></td> | ||
| <td align="center"><a href="https://github.com/ygaitonde"><img src="https://avatars.githubusercontent.com/u/54426809?v=4" width="30px;" alt="" style="border-radius:100%!important"></a></td> | ||
| </tr> | ||
| </table> | ||
|
|
||
| <!-- markdownlint-restore --> | ||
| <!-- prettier-ignore-end --> | ||
|
|
||
| <!-- ALL-CONTRIBUTORS-LIST:END --> | ||
| Get in touch at [email protected] or chat with us on [Discord](https://fig.io/community) | ||
|
|
||
| <br/> | ||
|
|
||
| ## ✨ Contributors | ||
|
|
||
| <a href="https://github.com/withfig/autocomplete/graphs/contributors"> | ||
| <img src="https://contrib.rocks/image?repo=withfig/autocomplete" /> | ||
| </a> | ||
| <!-- https://contrib.rocks --> | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.