first commit

icebaker · May 19, 2023 · a3a2d12 · a3a2d12
commit a3a2d12
Show file tree

Hide file tree

Showing 17 changed files with 2,907 additions and 0 deletions.
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -0,0 +1,25 @@
+{
+	"env": {
+		"browser": false,
+		"commonjs": true,
+		"es6": true,
+		"node": true,
+		"mocha": true
+	},
+	"parserOptions": {
+		"ecmaVersion": 2018,
+		"ecmaFeatures": {
+			"jsx": true
+		},
+		"sourceType": "module"
+	},
+	"rules": {
+		"no-const-assign": "warn",
+		"no-this-before-super": "warn",
+		"no-undef": "warn",
+		"no-unreachable": "warn",
+		"no-unused-vars": "warn",
+		"constructor-super": "warn",
+		"valid-typeof": "warn"
+	}
+}
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,3 @@
+.vscode/**
+.vscode-test/**
+node_modules/
diff --git a/.vscodeignore b/.vscodeignore
@@ -0,0 +1,8 @@
+.vscode/**
+.vscode-test/**
+test/**
+.gitignore
+.yarnrc
+**/jsconfig.json
+**/*.map
+**/.eslintrc.json
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,9 @@
+# Change Log
+
+All notable changes to the "nano-bots" extension will be documented in this file.
+
+Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
+
+## [0.0.1]
+
+- First Public Release
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 icebaker
+
+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.
diff --git a/README.md b/README.md
@@ -0,0 +1,273 @@
+# Nano Bots for Visual Studio Code
+
+[**Nano Bots**](https://github.com/icebaker/nano-bots): small, AI-powered bots easily shared as a single file, designed to support multiple providers such as Vicuna, OpenAI ChatGPT, Google PaLM, Alpaca, and LLaMA.
+
+Enhance your productivity and workflow by bringing the power of Artificial Intelligence to your code editor!
+
+![Nano Bots](https://user-images.githubusercontent.com/113217272/239403886-eca7762a-8dcb-4e71-9017-9ebcc7fad4e7.png)
+
+- [Installation](#installation)
+  - [Setup](#setup)
+- [Commands](#commands)
+  - [Prompt](#prompt)
+  - [Apply](#apply)
+  - [Evaluate](#evaluate)
+  - [Stop](#stop)
+- [Cartridges](#cartridges)
+  - [Default](#default)
+- [Shortcuts](#shortcuts)
+  - [Suggested Defaults](#suggested-defaults)
+  - [Custom Commands](#custom-commands)
+  - [State](#state)
+- [Development](#development)
+
+## Installation
+
+TODO
+
+### Setup
+
+In order to connect your package to the Nano Bots API, you can start a local instance of the API with [nano-bots-api](https://github.com/icebaker/nano-bots-api). It is important to remember that the API still depends on an external provider, which has its own polices about security and privacy.
+
+Once you have access to the Nano Bots API, you can navigate to "File" -> "Preferences" -> "Settings". Then, search for `Nano Bots` and configure the following settings:
+
+- `NANO_BOTS_API_ADDRESS`: `http://localhost:3048`
+- `NANO_BOTS_STREAM`: `true`
+
+![settings](https://user-images.githubusercontent.com/113217272/239404558-aacd4efa-1657-4516-baeb-d0c564c7fcb2.png)
+
+## Commands
+
+After installation, you will have the following commands available in the command pallet:
+
+- 🤖 Nano Bots: [Prompt](#prompt)
+- 🤖 Nano Bots: [Apply](#apply)
+- 🤖 Nano Bots: [Evaluate](#evaluate)
+- 🤖 Nano Bots: [Stop](#stop)
+
+### Prompt
+
+The Prompt command works like a traditional chat, allowing you to ask a question and receive an answer from the Nano Bot.
+
+Example:
+```text
+  Prompt: write a hello world in Ruby
+
+Nano Bot: puts "Hello, world!"
+```
+
+https://user-images.githubusercontent.com/113217272/239404291-ec8b1f65-7d9b-4d60-be48-f2aac21b84ea.mp4
+
+### Apply
+
+The Apply command works on a text selection. You select a piece of text and ask the Nano Bot to perform an action.
+
+Example:
+
+```text
+Selected Text: How are you doing?
+       Prompt: translate to french
+
+     Nano Bot: Comment allez-vous ?
+```
+
+https://user-images.githubusercontent.com/113217272/239405546-74bbfb6c-4095-40bc-8095-85e423d73267.mp4
+
+### Evaluate
+
+The Evaluate command sends your currently selected text to a Nano Bot without any additional instructions.
+
+Example:
+```text
+Selected Text: Hi!
+
+     Nano Bot: Hello! How can I assist you today?
+```
+
+https://user-images.githubusercontent.com/113217272/239405849-65bb7bb8-5591-4e2b-b4de-7035b4c86a66.mp4
+
+### Stop
+
+To interrupt a streaming response or stop waiting for a complete response, you can use the "Stop" command in the command palette. This is useful if you realize that the bot's answer is not what you were expecting from your request.
+
+## Cartridges
+
+When executing any of the commands mentioned earlier, a prompt will appear asking you to select a Cartridge. The default Cartridge is the standard chat interaction. However, you can create your own Cartridges which will automatically appear in the command palette.
+
+For further details on Cartridges, please refer to the [Nano Bots](https://github.com/icebaker/nano-bots) specification. You can find it [here](https://icebaker.github.io/nano-bots/#/README?id=cartridges).
+
+https://user-images.githubusercontent.com/113217272/239406395-6da4557b-9435-40cd-a0ed-f2393cc99576.mp4
+
+### Default
+
+You can override the default cartridge by creating your own with the name `default.yml`:
+
+```yaml
+---
+meta:
+  name: Default
+  symbol: 🤖
+  author: Your Name
+  version: 0.0.1
+
+provider:
+  name: openai
+  settings:
+    model: gpt-3.5-turbo
+    credentials:
+      address: ENV/OPENAI_API_ADDRESS
+      access-token: ENV/OPENAI_API_ACCESS_TOKEN
+      user-identifier: ENV/OPENAI_API_USER_IDENTIFIER
+
+```
+
+## Shortcuts
+
+There are no default shortcuts, but you can add your own by going to "Preferences" and selecting "Key Binding". We recommend the following ones:
+
+### Suggested Defaults
+
+```json
+[
+    {
+        "key": "ctrl+b ctrl+p",
+        "command": "nano-bots.prompt",
+        "args": {
+            "state": "-",
+            "mode": "add"
+        }
+    },
+    {
+        "key": "ctrl+b ctrl+l",
+        "command": "nano-bots.apply",
+        "args": {
+            "state": "-",
+            "mode": "replace",
+            "prefix": "",
+            "format": "[prompt]: [input]"
+        }
+    },
+    {
+        "key": "ctrl+b ctrl+b",
+        "command": "nano-bots.evaluate",
+        "args": {
+            "state": "-",
+            "mode": "replace"
+        }
+    },
+    {
+        "key": "ctrl+b ctrl+k",
+        "command": "nano-bots.stop"
+    }
+]
+```
+
+### Custom Commands
+
+The `action` keyword refers to the [available commands](#commands).
+
+The `mode` refers to how the answer will be delivered when a text is selected. `add` will add the answer after the selected text, while `replace` will replace it with the answer.
+
+When `add` is defined, you may also want to add a `prefix`:
+
+```json
+{
+  "key": "ctrl+b ctrl+l",
+  "command": "nano-bots.apply",
+  "args": {
+      "state": "-", "mode": "add", "prefix": "\n",
+      "format": "[prompt]: [input]" }
+},
+```
+
+When using the `apply` command, it is possible to customize the prompt by including a `format` keyword:
+
+```text
+Selected Text: How are you doing?
+       Prompt: translate to french
+```
+
+```json
+{
+  "format": "[prompt]: [input]"
+}
+```
+
+Will produce the prompt:
+```text
+translate to french: How are you doing?
+```
+
+If you prefer to skip the prompt for selecting a Cartridge when using those commands, you can define the desired cartridge beforehand:
+
+```json
+{
+    "key": "ctrl+b ctrl+b",
+    "command": "nano-bots.evaluate",
+    "args": { "state": "-", "mode": "replace", "cartridge": "-" }
+}
+```
+
+The `-` represents the default Cartridge. You can replace it with any other available Cartridge in your system.
+
+If you want to define a straightforward command that does not require any user input or consideration, you can accomplish this by using:
+
+```json
+{
+    "key": "ctrl+b ctrl+p",
+    "command": "nano-bots.prompt",
+    "args": { "state": "-", "mode": "add", "cartridge": "-", "input": "Hello!" }
+}
+```
+
+If you wish to define a command that applies to your current selection without requiring any additional input, you can use:
+
+```json
+{
+    "key": "ctrl+b ctrl+b",
+    "command": "nano-bots.evaluate",
+    "args": { "state": "-", "mode": "replace", "cartridge": "-" }
+}
+```
+
+```json
+{
+    "key": "ctrl+b ctrl+l",
+    "command": "nano-bots.apply",
+    "args": {
+      "state": "-", "mode": "replace",
+      "cartridge": "-", "input": "translate to en-us" }
+}
+```
+
+### State
+
+All interactions with Nano Bots are stateless by default. However, if you wish to preserve the history of interactions, you can use a state key:
+
+```json
+{
+    "key": "ctrl+b ctrl+p",
+    "command": "nano-bots.prompt",
+    "args": {
+      "state": "0470dfa445f1f11b5eb9b3089c5943c8", "mode": "add" }
+}
+```
+
+Each cartridge will maintain its own isolated state. Please refer to the [specification](https://icebaker.github.io/nano-bots/#/README?id=state) for further information on state management.
+
+## Development
+
+Clone the repository using the command:
+
+```
+git clone https://github.com/icebaker/vscode-nano-bots.git
+```
+
+Navigate to the `vscode-nano-bots` folder and open it in Visual Studio Code using the command `vscode .`. Press F5 to launch the extension. 
+
+For more information on extension development, refer to the [Your First Extension](https://code.visualstudio.com/api/get-started/your-first-extension) page.
+
+```bash
+npm run test
+npm run lint --fix
+```