[pull] main from pqrs-org:main

.editorconfig

@@ -11,8 +11,5 @@ trim_trailing_whitespace = true
 [Makefile]
 indent_style = tab
 
-[*.json.erb]
-indent_size = 4
-
 [*.md]
 indent_size = 4

.github/workflows/ci.yml

@@ -1,14 +1,21 @@
 name: KE-complex_modifications CI
 
-on: [push, pull_request]
+on:
+  push:
+    branches:
+      - main
+  pull_request:
 
 jobs:
   build:
-    runs-on: macOS-latest
+    runs-on: macos-14
 
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v3
         with:
           fetch-depth: 1
+          submodules: recursive
       - name: rebuild
         run: make rebuild
+      - name: check uncommitted changes
+        run: bash core/scripts/check-uncommitted-changes.sh

.gitignore

@@ -1,4 +1,6 @@
 .DS_Store
 .idea
+.vscode
 *.tmp
 /public/build/
+/dist/

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "core"]
+	path = core
+	url = https://github.com/pqrs-org/KE-complex_modifications-core.git

.markdownlint.json

@@ -10,7 +10,8 @@
     "ol_multi": 2
   },
   "MD033": {
-    "allowed_elements": ["br", "img"]
+    "allowed_elements": ["br", "img", "details", "summary"]
   },
-  "MD041": false
+  "MD041": false,
+  "MD046": false
 }

.prettierrc.json

@@ -1,5 +1,16 @@
 {
   "semi": false,
   "singleQuote": true,
-  "tabWidth": 2
+  "tabWidth": 2,
+  "printWidth": 200,
+  "trailingComma": "es5",
+
+  "overrides": [
+    {
+      "files": "*.md",
+      "options": {
+        "tabWidth": 4
+      }
+    }
+  ]
 }

.vscode/.gitignore

@@ -0,0 +1,2 @@
+/browse.*
+/*.log

.vscode/settings.json

@@ -1,12 +1,6 @@
 {
     "files.exclude": {
-        "**/*.min.css": true,
-        "**/*.min.js": true,
-        "**/dist/css/": true,
-        "**/dist/js/": true,
-        "public/css/": true,
-        "public/js/": true,
-        "src/vuejs/dist/": true,
-        "src/vuejs/public/": true
+        "public/static/": true,
+        "public/vendor/": true,
     }
 }

Makefile

@@ -1,11 +1,11 @@
 all:
-	bash scripts/update-json.sh
-	ruby scripts/lint-groups.rb
-	bash scripts/update-public-build.sh
+	make -C core
 
 rebuild:
-	touch src/json/*
-	$(MAKE) all
+	make -C core rebuild
 
-server:
-	ruby scripts/dev-server.rb
+update-dist:
+	make -C core update-dist
+
+preview-server:
+	make -C core preview-server

README.md

@@ -7,81 +7,152 @@ complex_modifications for Karabiner-Elements.
 
 <https://ke-complex-modifications.pqrs.org/>
 
-## Add rules
+## complex_modifications documents
+
+-   [karabiner.json Reference Manual](https://karabiner-elements.pqrs.org/docs/json/)
+    -   [Typical complex_modifications examples](https://karabiner-elements.pqrs.org/docs/json/typical-complex-modifications-examples/)
+    -   [complex_modifications manipulator definition](https://karabiner-elements.pqrs.org/docs/json/complex-modifications-manipulator-definition/)
+
+## How to add your rules
+
+Follow the steps below to create a PR and add your settings!
+
+1.  Fork this repository on GitHub.
+2.  Clone the repository in Terminal.
+
+    ```shell
+    git clone --depth 1 https://github.com/{your_account}/KE-complex_modifications.git
+    cd KE-complex_modifications
+    git submodule update --init --recursive --depth 1
+    ```
+
+3.  Create a git branch in Terminal.
+
+    ```shell
+    git switch -c my-settings
+    ```
 
-1.  Put a `.rb` (or `.erb`) template file into [src/json](https://github.com/pqrs-org/KE-complex_modifications/tree/main/src/json). (Or put a `.json` file into [public/json](https://github.com/pqrs-org/KE-complex_modifications/tree/main/public/json) directly.)
-2.  (Optional) Put extra description file into [public/extra_descriptions](https://github.com/pqrs-org/KE-complex_modifications/tree/main/public/extra_descriptions).
-3.  Add the following json into [public/groups.json](https://github.com/pqrs-org/KE-complex_modifications/tree/main/public/groups.json) &gt; `files`.
+4.  Put a JSON generator file (`.js`) into [src/json](https://github.com/pqrs-org/KE-complex_modifications/tree/main/src/json).
+    (Or put a `.json` file directly into [public/json](https://github.com/pqrs-org/KE-complex_modifications/tree/main/public/json) directory.)
+5.  <details>
+    <summary>
+        (Optional) Update public/groups.json if you want to add your rules to a particular category.
+    </summary>
+
+    Add the following entry into [public/groups.json](public/groups.json).
 
     ```json5
     {
-      "path": "json/your_awesome_configuration.json", // required
-      "extra_description_path": "extra_descriptions/your_awesome_configuration.html" // optional
+        "path": "json/your_awesome_configuration.json", // required
+        "extra_description_path": "extra_descriptions/your_awesome_configuration.html" // optional
     },
     ```
 
-4.  Run `make` command on Terminal. <br/> If you've put `.rb` (or `.erb`) source file into `src/json`, formatted json file will be auto generated in the `public/json/your_awesome_configuration.json`.
+    You can use the tag `<kbd>⇧Shift</kbd>` to make a nice <kbd>⇧Shift</kbd> in your html.
+    </details>
+
+6.  Run `make` command in Terminal to validate your files.<br/>
+    If you placed a generator file into `src/json`, json file will be generated in the `public/json` by this command.
 
     ```shell
-    make
+    make all
     ```
 
-## complex_modifications documents
+    If there is a problem, an error message is displayed. Fix your files until no errors are shown.
 
--   [karabiner.json Reference Manual](https://karabiner-elements.pqrs.org/docs/json/)
-    -   [Typical complex_modifications examples](https://karabiner-elements.pqrs.org/docs/json/typical-complex-modifications-examples/)
-    -   [complex_modifications manipulator definition](https://karabiner-elements.pqrs.org/docs/json/complex-modifications-manipulator-definition/)
+    ```text
+    "../public/json/personal_tekezo.json": `Personal rules (@tekezo) (rev 47)` error: `to` entry error: `key_code` error: unknown key_code: `"space"`
+    make[1]: *** [all] Error 1
+    make: *** [all] Error 2
+    ```
+
+7.  Test your files
 
-## Testing complex_modifications webpage on local server
+    Copy a json file to `~/.config/karabiner/assets/complex_modifications`.
 
-`public/index.html` does not work properly if you open it via `file://...`.<br />
-Launch a local web server by `make server` in terminal and open <http://localhost:8000>.<br />
-(You can quit the local web server by the `control-c` shortcut in terminal.) <br/>
-Before run `make server`, make sure you've run `make` command to auto generate `public/build/dist.json` file.
+    ```shell
+    cp public/json/your_awesome_configuration.json ~/.config/karabiner/assets/complex_modifications
+    ```
 
-Karabiner-Elements cannot import the json from the local web server due to the no https connection between local web server.<br />
-Please import the json via file copy. (See [Test your own rules](#Test-your-own-rules).)
+    Import rules from `Karabiner-Elements Settings > Complex Modifications > Rules > Add rule`.
 
-## Testing your own rules
+8.  <details>
+    <summary>
+        (Optional) Test your files on local web server.
+    </summary>
 
-1.  Copy a json file to `~/.config/karabiner/assets/complex_modifications`.
+    Run local web server by the following command in Terminal.
 
     ```shell
-    cp public/json/your_awesome_configuration.json ~/.config/karabiner/assets/complex_modifications
+    make preview-server
     ```
 
-2.  Import rules from Karabiner-Elements Preferences.
-    `Karabiner-Elements Preferences > Complex Modifications > Rules > Add rule`
+    Then open <http://localhost:8000>.
+
+9.  Run `git commit` and `git push` in Terminal.
+
+    ```shell
+    git add -A
+    git commit -m 'your commit message'
+    git push --set-upstream origin my-settings
+    ```
+
+10. Create a PR on GitHub.
+
+## Sync your fork
+
+To update your previously forked repositories, run the following command in Terminal.
+
+### Run only once
+
+```shell
+git remote add upstream https://github.com/pqrs-org/KE-complex_modifications.git
+```
+
+### Run every time
+
+```shell
+# switch to main branch
+git switch main
+
+# fetch upstream
+git fetch --all --prune --prune-tags
 
-## How to publish your own rules
+# update local repository
+git reset --hard upstream/main
 
-If you want to publish your own rules into complex_modification repository, follow this step.
+# update submodules
+git submodule update --init --recursive
 
-1.  Fork this repository to your github account.
-2.  Update or add new rules by following [Add rules](#add-rules) section. Don't forget to run `make`
-3.  Stage modified files (`git add`) and commit it (`git commit`)<br/>
-    <br/>
-    _NOTE :_ The `make` command will auto generate `public/build/dist.json` file. But do not stage `public/build/dist.json` file. <br/>
-    (`public/build/dist.json` file is already ignored by .gitignore)<br/>
-    <br/>
-4.  Push to your forked repository.
-5.  Click "New Pull Request" button, then the maintainer will review your commit.
+# clean files
+git clean -x -d -f .
 
----
+# update GitHub repository
+git push
+```
 
-# Karabiner-Elements Usage
+## Notes on creating your generators
 
-## Import file from another site
+The code in `src/json/*.js` is executed by [Duktape](https://duktape.org/), which is built into the Karabiner-Elements's command line interface ( `karabiner_cli`).
 
-1.  Put a json file to your site.
-2.  Make a link `karabiner://karabiner/assets/complex_modifications/import?url=<JSON_URL>`.
-3.  Open the link from web browser.
+Unlike the latest Node.js, the basic language specification is ES5.1, so the following features cannot be used.
 
----
+-   `let` (`const` is specially supported)
+-   Arrow functions
+-   Default parameters
+-   Spread (...) syntax
+-   Template literals
 
-# Updating the web application
+### Examples
 
-Note: You don't need to update the web application if you just want to add new json.
+There are many existing codes. Here are some of the more distinctive ones among them.
 
-If you want to modify the web application, the source code is in `src/vuejs`.
-Follow the instruction in `src/vuejs/README.md`.
+-   Use the predefined list of bundle identifiers in `frontmost_application_if`.
+    -   [capslock_shift_copy_paste.json.js](https://github.com/pqrs-org/KE-complex_modifications/blob/main/src/json/capslock_shift_copy_paste.json.js)
+-   Generate remappings from a list of characters
+    -   [colemak_layout.json.js](https://github.com/pqrs-org/KE-complex_modifications/blob/main/src/json/colemak_layout.json.js)
+-   Include file from another file
+    -   [personal_thooams.json.js](https://github.com/pqrs-org/KE-complex_modifications/blob/main/src/json/personal_thooams.json.js)
+    -   [control_backspace_to_function_backspace.json.js](https://github.com/pqrs-org/KE-complex_modifications/blob/main/src/json/control_backspace_to_function_backspace.json.js)
+-   Generate rules from key combinations
+    -   [matias_ergo_pro.json.js](https://github.com/pqrs-org/KE-complex_modifications/blob/main/src/json/matias_ergo_pro.json.js)

public/extra_descriptions/CAPSLOCK_modifier_suite.html

@@ -0,0 +1,20 @@
+<link rel="stylesheet" href="../../vendor/css/bootstrap.min.css" />
+<h3>CAPSLOCK modifier suite</h3>
+
+Great for 60% layouts! Repurpose capslock as a layer two shortcut:
+<br>
+<kbd>caps</kbd> +
+<ul>
+  <li><kbd>l_shift</kbd> = <kbd>caps</kbd></li>
+  <li><kbd>w</kbd> = <kbd>&uarr;</kbd></li>
+  <li><kbd>a</kbd> = <kbd>&larr;</kbd></li>
+  <li><kbd>s</kbd> = <kbd>&darr;</kbd></li>
+  <li><kbd>d</kbd> = <kbd>&rarr;</kbd></li>
+  <li><kbd>esc</kbd> = <kbd>`~</kbd></li>
+  <li><kbd>o</kbd> = mute</li>
+  <li><kbd>p</kbd> = vk_consumer_previous</li>
+  <li><kbd>[</kbd> = play_or_pause</li>
+  <li><kbd>]</kbd> = vk_consumer_next</li>
+  <li><kbd>&larr; backspace</kbd> = volume_increment</li>
+  <li><kbd>\</kbd> = volume_decrement</li>
+</ul>