Skip to content

Commit

Permalink
chore(developer): rename vscode-plugin
Browse files Browse the repository at this point in the history
- rename directory to vscode-plugin
- rename package and description of plugin
- reduce/simplify some other dependencies

Fixes: #12756
  • Loading branch information
srl295 committed Dec 5, 2024
1 parent 85dbd3a commit fc98a4b
Show file tree
Hide file tree
Showing 20 changed files with 55 additions and 643 deletions.
2 changes: 1 addition & 1 deletion developer/src/build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ builder_describe \
":test=test/auto Various older tests (others in each module)" \
":tike Keyman Developer IDE" \
":inst Bundled installers" \
":keyman-vscode-plugin Keyman VSCode Plugin" \
":vscode-plugin Keyman Developer for VSCode" \
"--npm-publish+ For publish, do a npm publish, not npm pack (only for CI)" \
"--dry-run,-n+ Don't actually publish anything to external endpoints, just dry run"

Expand Down
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# Keyman Developer - keyman-vscode-plugin
# Keyman Developer for VSCode

This package is a standalone [VSCode](https://code.visualstudio.com) plugin which offers:

- a Build Task for building .kpj files into a package
- when building the .kpj file, all .kmn and .xml (LDML keyboard) files will be compiled as well
- The Build Task assumes that the .kpj will have the same name as the directory. So, `.../some_keyboard/some_keyboard.kpj`
- The build task will also build .kps files into packages

## Building

Expand All @@ -19,7 +20,7 @@ There is also a `build.sh` which works the usual way.

## Running/Testing locally

- Open this directory (`keyman-vscode-plugin`) in VSCode
- Open this directory (`vscode-plugin`) in VSCode
- From the Run and Debug toolbar, click Run Extension
- A terminal will automatically open with `npm run watch` recompiling the project.
- Choose a directory containing a .kpj file, and choose the **Terminal > Run Task…** menu item, or the **Tasks: Run Task** command. Select "kpj" and the name, and the compilation should occur in a terminal window.
Expand All @@ -30,4 +31,4 @@ There is also a `build.sh` which works the usual way.

Copyright (c) SIL Global.

Keyman is an open source project distributed under the [MIT license](../../../LICENSE.md).
Keyman is an open source project distributed under the [MIT license](https://github.com/keymanapp/keyman/blob/master/LICENSE.md).
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/usr/bin/env bash
#
# Compiles the keyman-vscode-plugin plugin.
# Compiles the Keyman Developer for VSCode plugin.
#
## START STANDARD BUILD SCRIPT INCLUDE
# adjust relative paths as necessary
Expand All @@ -10,15 +10,15 @@ THIS_SCRIPT="$(readlink -f "${BASH_SOURCE[0]}")"

. "$KEYMAN_ROOT/resources/shellHelperFunctions.sh"

builder_describe "Keyman keyman-vscode-plugin module" \
builder_describe "Keyman Developer for VSCode module" \
"configure" \
"build" \
"clean" \
"test"

builder_describe_outputs \
configure /node_modules \
build /developer/src/keyman-vscode-plugin/out/extension.js
build /developer/src/vscode-plugin/out/extension.js

builder_parse "$@"

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@keymanapp/keyman-vscode-plugin",
"displayName": "Keyman VSCode Plugin",
"name": "@keymanapp/developer-vscode",
"displayName": "Keyman Developer for VSCode",
"description": "Plugin for compiling Keyman projects in VSCode",
"version": "0.0.1",
"engines": {
Expand Down Expand Up @@ -43,21 +43,18 @@
"_prepare": "npm run compile"
},
"devDependencies": {
"@types/mocha": "^10.0.8",
"@types/mocha": "^10.0.0",
"@types/node": "20.4.1",
"@types/vscode": "^1.93.0",
"@typescript-eslint/eslint-plugin": "^8.7.0",
"@typescript-eslint/parser": "^8.7.0",
"@vscode/test-cli": "^0.0.10",
"@vscode/test-electron": "^2.4.1",
"eslint": "^9.11.1"
"@vscode/test-electron": "^2.4.1"
},
"license": "MIT",
"dependencies": {
"@keymanapp/common-types": "file:../../../common/web/types",
"@keymanapp/developer-utils": "file:../common/web/utils",
"@keymanapp/kmc-ldml": "file:../kmc-ldml",
"@keymanapp/kmc-kmn": "file:../kmc-kmn",
"@keymanapp/kmc-ldml": "file:../kmc-ldml",
"@keymanapp/kmc-package": "file:../kmc-package"
}
}
File renamed without changes.
File renamed without changes.
Loading

0 comments on commit fc98a4b

Please sign in to comment.