@microsoft/inshellisense 0.0.1-rc.23 → 0.0.1-rc.24

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,9 @@
+# Microsoft Open Source Code of Conduct
+
+This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
+
+Resources:
+
+- [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/)
+- [Microsoft Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
+- Contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with questions or concerns

package/LICENSE

@@ -0,0 +1,21 @@
+    MIT License
+
+    Copyright (c) Microsoft Corporation.
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to deal
+    in the Software without restriction, including without limitation the rights
+    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in all
+    copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+    SOFTWARE

package/README.md

@@ -0,0 +1,159 @@
+# inshellisense
+
+`inshellisense` provides IDE style autocomplete for shells. It's a terminal native runtime for [autocomplete](https://github.com/withfig/autocomplete) which has support for 600+ command line tools. `inshellisense` supports Windows, Linux, & macOS.
+
+<p align="center"><img alt="demo of inshellisense working" src="/docs/demo.gif"/></p>
+
+## Getting Started
+
+### Installation
+
+**npm (recommended)**
+```shell
+npm install -g @microsoft/inshellisense
+is init
+```
+**homebrew (macOS/linux)**
+```shell
+brew tap microsoft/inshellisense https://github.com/microsoft/inshellisense
+brew install inshellisense
+is init
+```
+
+### Updating
+
+```shell
+npm install -g @microsoft/inshellisense # OR brew upgrade inshellisense
+is reinit
+```
+
+### Quickstart
+
+After completing the installation, run `is doctor` to verify your installation was successful. You can run `is` to start the autocomplete session for your desired shell. Additionally, inshellisense is also aliased under `inshellisense` after installation.
+
+### Shell Plugin
+
+If you'd like to automatically start inshellisense when you open your shell, run the respective command for your shell. After running the command, inshellisense will automatically open when you start any new shell session:
+
+```shell
+# bash
+is init bash >> ~/.bashrc
+
+# zsh
+is init zsh >> ~/.zshrc
+
+# fish
+is init fish >> ~/.config/fish/config.fish
+
+# pwsh
+is init pwsh | Add-Content $profile
+
+# powershell
+is init powershell | Add-Content $profile
+
+# xonsh
+is init xonsh >> ~/.xonshrc
+
+# nushell
+is init nu | save $nu.env-path --append
+```
+
+> [!NOTE]  
+> When updating your shell configuration in the future, make sure the inshellisense plugin is the last command in the file. Including commands after it may break the configuration (ex. initializing your shell plugin manager after the inshellisense plugin)
+
+### Usage
+
+| Action                                | Command | Description                                      |
+| ------------------------------------- | ------- | ------------------------------------------------ |
+| Start                                 | `is`    | Start inshellisense session on the current shell |
+| Stop                                  | `exit`  | Stop inshellisense session on the current shell  |
+| Check If Inside Inshellisense Session | `is -c` | Check if shell inside inshellisense session      |
+
+#### Keybindings
+
+All other keys are passed through to the shell. The keybindings below are only captured when the inshellisense suggestions are visible, otherwise they are passed through to the shell as well. These can be customized in the [config](#configuration).
+
+| Action                    | Keybinding     |
+| ------------------------- | -------------- |
+| Accept Current Suggestion | <kbd>tab</kbd> |
+| View Next Suggestion      | <kbd>↓</kbd>   |
+| View Previous Suggestion  | <kbd>↑</kbd>   |
+| Dismiss Suggestions       | <kbd>esc</kbd> |
+
+## Integrations
+
+inshellisense supports the following shells:
+
+- [bash](https://www.gnu.org/software/bash/)
+- [zsh](https://www.zsh.org/)
+- [fish](https://github.com/fish-shell/fish-shell)
+- [pwsh](https://github.com/PowerShell/PowerShell)
+- [powershell](https://learn.microsoft.com/en-us/powershell/scripting/windows-powershell/starting-windows-powershell) (Windows Powershell)
+- [cmd](https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/cmd) _(experimental)_
+- [xonsh](https://xon.sh/)
+- [nushell](https://www.nushell.sh/)
+
+## Configuration
+
+All configuration is done through a [toml](https://toml.io/) file. You can create this file at `~/.inshellisenserc` or, for XDG compliance, at `~/.config/inshellisense/rc.toml`. The [JSON schema](https://json-schema.org/) for the configuration file can be found [here](https://github.com/microsoft/inshellisense/blob/main/src/utils/config.ts).
+
+### Keybindings
+
+You can customize the keybindings for inshellisense by adding a `bindings` section to your config file. The following is the default configuration for the [keybindings](#keybindings):
+
+```toml
+[bindings.acceptSuggestion]
+key = "tab"
+# shift and ctrl are optional and default to false
+shift = false
+ctrl = false
+
+[bindings.nextSuggestion]
+key = "down"
+
+[bindings.previousSuggestion]
+key = "up"
+
+[bindings.dismissSuggestions]
+key = "escape"
+```
+
+Key names are matched against the Node.js [keypress](https://nodejs.org/api/readline.html#readlineemitkeypresseventsstream-interface) events.
+
+### Alias Expansion
+
+Inshellisense supports expanding aliases for bash/zsh shells. You can enable alias expansion in your config file:
+
+```toml
+useAliases = true
+```
+
+### NerdFonts
+
+If you are using a [NerdFont](https://www.nerdfonts.com/) patched font, you can enable the NerdFonts support in your config file:
+
+```toml
+useNerdFont = true
+```
+
+## Contributing
+
+This project welcomes contributions and suggestions. Most contributions require you to agree to a
+Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
+the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
+
+When you submit a pull request, a CLA bot will automatically determine whether you need to provide
+a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
+provided by the bot. You will only need to do this once across all repos using our CLA.
+
+This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
+For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
+contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
+
+## Trademarks
+
+This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft
+trademarks or logos is subject to and must follow
+[Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
+Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
+Any use of third-party trademarks or logos are subject to those third-party's policies.

package/SECURITY.md

@@ -0,0 +1,41 @@
+<!-- BEGIN MICROSOFT SECURITY.MD V0.0.9 BLOCK -->
+
+## Security
+
+Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/Microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet) and [Xamarin](https://github.com/xamarin).
+
+If you believe you have found a security vulnerability in any Microsoft-owned repository that meets [Microsoft's definition of a security vulnerability](https://aka.ms/security.md/definition), please report it to us as described below.
+
+## Reporting Security Issues
+
+**Please do not report security vulnerabilities through public GitHub issues.**
+
+Instead, please report them to the Microsoft Security Response Center (MSRC) at [https://msrc.microsoft.com/create-report](https://aka.ms/security.md/msrc/create-report).
+
+If you prefer to submit without logging in, send email to [secure@microsoft.com](mailto:secure@microsoft.com).  If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://aka.ms/security.md/msrc/pgp).
+
+You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc). 
+
+Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
+
+  * Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
+  * Full paths of source file(s) related to the manifestation of the issue
+  * The location of the affected source code (tag/branch/commit or direct URL)
+  * Any special configuration required to reproduce the issue
+  * Step-by-step instructions to reproduce the issue
+  * Proof-of-concept or exploit code (if possible)
+  * Impact of the issue, including how an attacker might exploit the issue
+
+This information will help us triage your report more quickly.
+
+If you are reporting for a bug bounty, more complete reports can contribute to a higher bounty award. Please visit our [Microsoft Bug Bounty Program](https://aka.ms/security.md/msrc/bounty) page for more details about our active programs.
+
+## Preferred Languages
+
+We prefer all communications to be in English.
+
+## Policy
+
+Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://aka.ms/security.md/cvd).
+
+<!-- END MICROSOFT SECURITY.MD BLOCK -->

package/SUPPORT.md

@@ -0,0 +1,13 @@
+# Support
+
+## How to file issues and get help
+
+This project uses GitHub Issues to track bugs and feature requests. Please search the existing
+issues before filing new issues to avoid duplicates. For new issues, file your bug or
+feature request as a new Issue.
+
+For help and questions about using this project, create a new Github Discussion.
+
+## Microsoft Support Policy
+
+Support for this project is limited to the resources listed above.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/inshellisense",
-  "version": "0.0.1-rc.23",
+  "version": "0.0.1-rc.24",
   "description": "IDE style command line auto complete",
   "license": "MIT",
   "repository": {
@@ -13,13 +13,16 @@
   "bugs": {
     "url": "https://github.com/microsoft/inshellisense/issues"
   },
-  "files": [],
+  "files": [
+    "*.md",
+    "LICENSE"
+  ],
   "optionalDependencies": {
-    "@microsoft/inshellisense-darwin-x64": "0.0.1-rc.23",
-    "@microsoft/inshellisense-darwin-arm64": "0.0.1-rc.23",
-    "@microsoft/inshellisense-linux-x64": "0.0.1-rc.23",
-    "@microsoft/inshellisense-linux-arm64": "0.0.1-rc.23",
-    "@microsoft/inshellisense-win32-x64": "0.0.1-rc.23",
-    "@microsoft/inshellisense-win32-arm64": "0.0.1-rc.23"
+    "@microsoft/inshellisense-darwin-x64": "0.0.1-rc.24",
+    "@microsoft/inshellisense-darwin-arm64": "0.0.1-rc.24",
+    "@microsoft/inshellisense-linux-x64": "0.0.1-rc.24",
+    "@microsoft/inshellisense-linux-arm64": "0.0.1-rc.24",
+    "@microsoft/inshellisense-win32-x64": "0.0.1-rc.24",
+    "@microsoft/inshellisense-win32-arm64": "0.0.1-rc.24"
   }
 }