Merge pull request #2 from atomiechen/dev

Bump version to 0.1.0

.eslintrc.json

@@ -0,0 +1,30 @@
+{
+    "root": true,
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+        "ecmaVersion": 6,
+        "sourceType": "module"
+    },
+    "plugins": [
+        "@typescript-eslint"
+    ],
+    "rules": {
+        "@typescript-eslint/naming-convention": [
+            "warn",
+            {
+                "selector": "import",
+                "format": [ "camelCase", "PascalCase" ]
+            }
+        ],
+        "@typescript-eslint/semi": "warn",
+        "curly": "warn",
+        "eqeqeq": "warn",
+        "no-throw-literal": "warn",
+        "semi": "off"
+    },
+    "ignorePatterns": [
+        "out",
+        "dist",
+        "**/*.d.ts"
+    ]
+}

.github/workflows/test_and_publish.yml

@@ -0,0 +1,33 @@
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - v*
+  release:
+    types:
+    - created
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        os: [macos-latest, ubuntu-latest, windows-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+    - name: Install Node.js
+      uses: actions/setup-node@v4
+      with:
+        node-version: 18.x
+    - run: npm install
+    - run: xvfb-run -a npm test
+      if: runner.os == 'Linux'
+    - run: npm test
+      if: runner.os != 'Linux'
+    - name: Publish
+      if: success() && startsWith(github.ref, 'refs/tags/') && matrix.os == 'ubuntu-latest'
+      run: npm run deploy
+      env:
+        VSCE_PAT: ${{ secrets.VSCE_PAT }}

.gitignore

@@ -1,3 +1,8 @@
+out
+dist
 node_modules
+.vscode-test/
 *.vsix
+
 .DS_Store
+tmp*

.vscode-test.mjs

@@ -0,0 +1,5 @@
+import { defineConfig } from '@vscode/test-cli';
+
+export default defineConfig({
+	files: 'out/test/**/*.test.js',
+});

.vscode/extensions.json

@@ -0,0 +1,8 @@
+{
+	// See http://go.microsoft.com/fwlink/?LinkId=827846
+	// for the documentation about the extensions.json format
+	"recommendations": [
+		"dbaeumer.vscode-eslint",
+        "ms-vscode.extension-test-runner"
+	]
+}

.vscode/launch.json

@@ -1,17 +1,21 @@
-// A launch configuration that launches the extension inside a new window
+// A launch configuration that compiles the extension and then opens it inside a new window
 // Use IntelliSense to learn about possible attributes.
 // Hover to view descriptions of existing attributes.
 // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
 {
 	"version": "0.2.0",
-    "configurations": [
-        {
-            "name": "Extension",
-            "type": "extensionHost",
-            "request": "launch",
-            "args": [
-                "--extensionDevelopmentPath=${workspaceFolder}"
-            ]
-        }
-    ]
-}
+	"configurations": [
+		{
+			"name": "Run Extension",
+			"type": "extensionHost",
+			"request": "launch",
+			"args": [
+				"--extensionDevelopmentPath=${workspaceFolder}"
+			],
+			"outFiles": [
+				"${workspaceFolder}/out/**/*.js"
+			],
+			"preLaunchTask": "${defaultBuildTask}"
+		}
+	]
+}

.vscode/settings.json

@@ -0,0 +1,11 @@
+// Place your settings in this file to overwrite default and user settings.
+{
+    "files.exclude": {
+        "out": false // set this to true to hide the "out" folder with the compiled JS files
+    },
+    "search.exclude": {
+        "out": true // set this to false to include "out" folder in search results
+    },
+    // Turn off tsc task auto detection since we have the necessary tasks as npm scripts
+    "typescript.tsc.autoDetect": "off"
+}

.vscode/tasks.json

@@ -0,0 +1,20 @@
+// See https://go.microsoft.com/fwlink/?LinkId=733558
+// for the documentation about the tasks.json format
+{
+	"version": "2.0.0",
+	"tasks": [
+		{
+			"type": "npm",
+			"script": "watch",
+			"problemMatcher": "$tsc-watch",
+			"isBackground": true,
+			"presentation": {
+				"reveal": "never"
+			},
+			"group": {
+				"kind": "build",
+				"isDefault": true
+			}
+		}
+	]
+}

.vscodeignore

@@ -1,4 +1,11 @@
 .vscode/**
 .vscode-test/**
+src/**
 .gitignore
+.yarnrc
 vsc-extension-quickstart.md
+**/tsconfig.json
+**/.eslintrc.json
+**/*.map
+**/*.ts
+**/.vscode-test.*

README.md

@@ -1,12 +1,25 @@
 # HandyLLM in Visual Studio Code
 
-VS Code extension for [HandyLLM](https://github.com/atomiechen/HandyLLM).
+[![vsmarketplace](https://vsmarketplacebadges.dev/version-short/atomiechen.handyllm.svg)](https://marketplace.visualstudio.com/items?itemName=atomiechen.handyllm) [![PyPI](https://img.shields.io/pypi/v/HandyLLM?logo=pypi&logoColor=white)](https://pypi.org/project/HandyLLM/)
+
+VS Code extension for [HandyLLM](https://github.com/atomiechen/HandyLLM) (>= 0.7.0).
 
 ## Features
 
-HandyLLM prompt syntax highlighting.
+### Hprompt syntax highlight
 
 See demo below:
 
 ![example screenshot](https://raw.githubusercontent.com/atomiechen/vscode-handyllm/main/assets/demo/example.jpg)
 
+### Run hprompt file
+
+See gif below:
+
+![run hprompt](https://raw.githubusercontent.com/atomiechen/vscode-handyllm/main/assets/demo/run.gif)
+
+### Create starter hprompt file
+
+See gif below:
+
+![create hprompt](https://raw.githubusercontent.com/atomiechen/vscode-handyllm/main/assets/demo/create.gif)

examples/.env

@@ -0,0 +1,2 @@
+OPENAI_API_KEY=sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+OPENAI_ORGANIZATION=org-xxxxxxxxxxxxxxxxxxxxxxxx

examples/run.hprompt

@@ -0,0 +1,21 @@
+---
+model: gpt-3.5-turbo
+temperature: 0.5
+stream: true
+meta:
+  credential_path: .env
+  var_map_path: substitute.txt
+  output_path: out/%Y-%m-%d/result.%H-%M-%S.hprompt
+---
+
+$system$
+You are a helpful assistant.
+
+$user$
+My context:
+%context%
+
+Please help me write a poem about my day.
+
+Extra notes:
+%notes%

examples/substitute.txt

@@ -0,0 +1,5 @@
+%context%
+I met some new friends at the party. They were very friendly and we had a great time together. I was happy to have met them and I hope to see them again soon.
+
+%notes%
+Comply with the context and make sure to use the correct verb tense.