move everything from vscode folder to root

rszyma · Nov 16, 2023 · a5f9a69 · a5f9a69
1 parent ae0cc93
commit a5f9a69
Show file tree

Hide file tree

Showing 37 changed files with 111 additions and 260 deletions.
diff --git a/vscode/.eslintrc.js → .eslintrc.js b/vscode/.eslintrc.js → .eslintrc.js
diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml
@@ -13,10 +13,6 @@ jobs:
   build:
     runs-on: ubuntu-latest
 
-    defaults:
-      run:
-        working-directory: ./kls
-
     steps:
     - name: Checkout repository
       uses: actions/checkout@v3
@@ -33,7 +29,7 @@ jobs:
 
     - name: Test with wasm-pack
       run: wasm-pack test --headless --firefox
-      
+
     - name: Lint and Format
       run: |
         rustup component add clippy

diff --git a/.gitignore b/.gitignore
@@ -3,6 +3,9 @@
 **/out
 yarn-error.log
 .vscode
+.vscode-test
+*.vsix
+
 
 # A symbolic link to a local development kanata repo for testing changes.
 kanata-local
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,24 @@
+# Change Log
+
+### Unreleased
+
+* no changes yet
+
+### 0.3.0
+
+* Fixed: Unknown key in defsrc while it is defined in deflocalkeys (#3)
+* Updated kanata to ef23c68
+
+### 0.2.0
+
+* Invalid deflocalkeys-win and deflocalkeys-wintercept blocks now properly report errors (#1)
+* Added missing syntax highlighting,
+* Added the same help text as kanata uses to inform users where to look for help,
+* Updated kanata submodule to 5dc3296
+
+### 0.1.0
+
+* Added syntax highlighting.
+* Added parse errors checking.
+* Added support for includes.
+* Used kanata-parser version: 3ccbcd1
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,30 @@
+
+## Building from source
+
+Requirements:
+- Latest stable version of Rust with `cargo` available on your system PATH.
+- `wasm-pack` 0.12.1+ installed and available on your system PATH.
+- VS Code 1.80.0+.
+
+1. Run commands:
+```bash
+git clone https://github.com/rszyma/vscode-kanata.git &&
+cd vscode-kanata &&
+git submodule init &&
+git submodule update &&
+make package
+# or alternatively build in release mode:
+# make CARGO_FLAGS=--release package
+```
+2. To install:
+    - Right click on `kanata.vsix` file in VS Code file explorer and "Install Extension VSIX"...
+    - ...or run `code --install-extension kanata.vsix` and restart VS Code.
+
+
+## Bumping version of kanata
+
+This project directly embeds kanata's parser during compilation. It's located in project root in `/kanata`. Any updates to kanata must be manually checked out. The following command bumps version of kanata to the latest commit on [kanata main branch](https://github.com/jtroo/kanata/tree/main):
+
+```bash
+git submodule update --remote
+```
diff --git a/vscode/Makefile → Makefile b/vscode/Makefile → Makefile
@@ -21,7 +21,7 @@ package: wasm
 CARGO_FLAGS ?= --dev
 
 wasm: clean
-	$(MAKE) CARGO_FLAGS=$(CARGO_FLAGS) OUT_DIR=$$(pwd)/out -C ../kls build
+	$(MAKE) CARGO_FLAGS=$(CARGO_FLAGS) OUT_DIR=$$(pwd)/out -C kls build
 
 node_modules: package.json
 	yarn install

diff --git a/README.md b/README.md
@@ -1,34 +1,59 @@
 # vscode-kanata
+[![GitHub Repo stars](https://img.shields.io/github/stars/rszyma/vscode-kanata)](https://github.com/rszyma/vscode-kanata)
+[![Visual Studio Marketplace Installs](https://img.shields.io/visual-studio-marketplace/i/rszyma.vscode-kanata)](https://marketplace.visualstudio.com/items?itemName=rszyma.vscode-kanata)
 
-A VS Code extension that adds language support for [kanata](https://github.com/jtroo/kanata) configuration files .
+A VS Code extension that adds language support for [kanata](https://github.com/jtroo/kanata) configuration files.
 
-### Features
+## Features
 
-A list of features is available [here](./vscode/README.md#features)
+Kanata config files are detected by `.kbd` file extension.
 
-### Installing from source
+### Syntax highlighting
 
-Requirements:
-- Latest stable version of Rust with `cargo` available on your system PATH.
-- `wasm-pack` 0.12.1+ installed and available on your system PATH.
-- VS Code 1.80.0+.
+keywords, action identifiers, alias handles etc.
 
-1. Run commands:
-```bash
-git clone https://github.com/rszyma/vscode-kanata.git &&
-cd vscode-kanata &&
-git submodule init &&
-git submodule update &&
-cd vscode &&
-make package
-# or alternatively build in release mode:
-# make CARGO_FLAGS=--release package
-```
-2. To install:
-    - Right click on `kanata.vsix` file in VS Code file explorer and "Install Extension VSIX"...
-    - ...or run `code --install-extension kanata.vsix` and restart VS Code.
+<p><img src="assets/syntax-highlighting-showcase.png"/></p>
 
-### Credits
+### Checking for config errors
+
+Config will be parsed and validated, when saving document.
+
+<p><img src="assets/config-parsing-showcase.gif"/></p>
+
+Note: kanata parser is embedded directly in this extension, so it might happen
+that this extension don't yet support the latest features of kanata. Version bumps of
+kanata are usually done every release and indicated in [change log](/CHANGELOG.md).
+
+### Support for including other files
+
+If you use [`include`](https://github.com/jtroo/kanata/blob/main/docs/config.adoc#include-other-files)
+configuration items in your kanata config, make sure to adjust the following settings:
+- `vscode-kanata.includesAndWorkspaces`
+- `vscode-kanata.mainConfigFile`
+
+Important: Absolute paths in `include` blocks that point outside the opened workspace aren't supported.
+
+Also, if you work with multiple main files, and find yourself switching `mainConfigFile` often,
+there's a handy command palette entry:
+- `Kanata: Set current file as main`
+
+## Contributing
+
+Contributions are welcome, feel free to open an issue or a PR.
+
+### Bug reports
+
+If you encounter a bug, please report it here: https://github.com/rszyma/vscode-kanata/issues
+
+### Building
+
+See [this document](CONTRIBUTING.md) for build instructions.
+
+## Release notes
+
+See the [change log](CHANGELOG.md).
+
+## Credits
 
 - https://github.com/jtroo/kanata/ - provides kanata-parser crate
 - https://github.com/osohq/oso - used this as vscode extension template (with a lot of things removed)

diff --git a/assets/config-parsing-showcase.gif b/assets/config-parsing-showcase.gif
diff --git a/vscode/kanata_icon.png → assets/kanata_icon.png b/vscode/kanata_icon.png → assets/kanata_icon.png
diff --git a/assets/syntax-highlighting-showcase.png b/assets/syntax-highlighting-showcase.png
diff --git a/vscode/client/src/index.ts → client/src/index.ts b/vscode/client/src/index.ts → client/src/index.ts
diff --git a/vscode/client/tsconfig.json → client/tsconfig.json b/vscode/client/tsconfig.json → client/tsconfig.json
diff --git a/kls/Cargo.lock b/kls/Cargo.lock
diff --git a/kls/Cargo.toml b/kls/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "kls"
-version = "0.3.0"
+version = "0.0.0"
 authors = ["rszyma <[email protected]>"]
 description = "Language server for kanata keyboard remapper"
 keywords = ["kanata", "lsp", "vscode"]
@@ -20,7 +20,7 @@ bench = false
 # Uncomment below and comment out above for testing local changes.
 # Otherwise any changes to the local files will not reflect in the compiled
 # binary.
-kanata-parser = { path = "../kanata/parser" }
+kanata-parser = { path = "../kanata-local/parser" }
 
 console_error_panic_hook = "0.1.6"
 js-sys = "0.3.53"

diff --git a/vscode/language-configuration.json → language-configuration.json b/vscode/language-configuration.json → language-configuration.json
diff --git a/vscode/package.json → package.json b/vscode/package.json → package.json
@@ -5,7 +5,7 @@
   "displayName": "Kanata Configuration Language",
   "author": "rszyma",
   "publisher": "rszyma",
-  "icon": "kanata_icon.png",
+  "icon": "assets/kanata_icon.png",
   "description": "Language support for kanata configuration files",
   "keywords": [
     "kanata",

diff --git a/vscode/server/src/index.ts → server/src/index.ts b/vscode/server/src/index.ts → server/src/index.ts
diff --git a/vscode/server/tsconfig.json → server/tsconfig.json b/vscode/server/tsconfig.json → server/tsconfig.json
diff --git a/vscode/syntaxes/kanata.tmLanguage.json → syntaxes/kanata.tmLanguage.json b/vscode/syntaxes/kanata.tmLanguage.json → syntaxes/kanata.tmLanguage.json
diff --git a/...de/test-fixtures/workspace/a/antelope.txt → test-fixtures/workspace/a/antelope.txt b/...de/test-fixtures/workspace/a/antelope.txt → test-fixtures/workspace/a/antelope.txt
diff --git a/...de/test-fixtures/workspace/a/included.kbd → test-fixtures/workspace/a/included.kbd b/...de/test-fixtures/workspace/a/included.kbd → test-fixtures/workspace/a/included.kbd
diff --git a/vscode/test-fixtures/workspace/a/minimal.kbd → test-fixtures/workspace/a/minimal.kbd b/vscode/test-fixtures/workspace/a/minimal.kbd → test-fixtures/workspace/a/minimal.kbd
diff --git a/vscode/test-fixtures/workspace/b/kanata.kbd → test-fixtures/workspace/b/kanata.kbd b/vscode/test-fixtures/workspace/b/kanata.kbd → test-fixtures/workspace/b/kanata.kbd
diff --git a/...st-fixtures/workspace/test.code-workspace → test-fixtures/workspace/test.code-workspace b/...st-fixtures/workspace/test.code-workspace → test-fixtures/workspace/test.code-workspace
diff --git a/vscode/test/src/runTest.ts → test/src/runTest.ts b/vscode/test/src/runTest.ts → test/src/runTest.ts
diff --git a/vscode/test/src/suite/extension.test.ts → test/src/suite/extension.test.ts b/vscode/test/src/suite/extension.test.ts → test/src/suite/extension.test.ts
diff --git a/vscode/test/src/suite/index.ts → test/src/suite/index.ts b/vscode/test/src/suite/index.ts → test/src/suite/index.ts
diff --git a/vscode/test/tsconfig.json → test/tsconfig.json b/vscode/test/tsconfig.json → test/tsconfig.json
diff --git a/vscode/tsconfig.json → tsconfig.json b/vscode/tsconfig.json → tsconfig.json
diff --git a/vscode/.gitignore b/vscode/.gitignore
diff --git a/vscode/.prettierignore b/vscode/.prettierignore
diff --git a/vscode/.prettierrc.js b/vscode/.prettierrc.js
diff --git a/vscode/.vscodeignore b/vscode/.vscodeignore
diff --git a/vscode/.yarnrc b/vscode/.yarnrc