Add macro config per user, refactor & add tests

.editorconfig

@@ -0,0 +1,22 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+
+# Matches multiple files with brace expansion notation
+# Set default charset
+[*.{js,ts}]
+charset = utf-8
+# 4 space indentation
+indent_style = space
+indent_size = 4
+
+# Matches the exact file: package.json - and yaml files
+[{package.json,*.yml}]
+indent_style = space
+indent_size = 2

.env.dist

@@ -1,3 +1,4 @@
+USER_NAME="githubUserName"
 LAYOUT_ID="default"
 LAYOUT_FOLDER="moonlander_moonlander-default-layout_source"
-LAYOUT_DIR="./layout_src"
+LAYOUT_SRC="./layout_src"

.eslintrc.cjs

@@ -0,0 +1,15 @@
+module.exports = {
+  extends: [
+    'eslint:recommended', 
+    'plugin:@typescript-eslint/recommended',
+    'plugin:@typescript-eslint/recommended-requiring-type-checking',
+  ],
+  parser: '@typescript-eslint/parser',
+  plugins: ['@typescript-eslint'],
+  parserOptions: {
+    project: true,
+    tsconfigRootDir: __dirname,
+  },
+  root: true,
+  ignorePatterns: [".eslintrc.cjs", "babel.config.cjs"]
+};

.github/workflows/lint.yml

@@ -0,0 +1,26 @@
+name: Node Test/Lint CI
+
+on:
+  push:
+  workflow_dispatch:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    name: Run your tests
+    env:
+      LAYOUT_ID: ${{ vars.LAYOUT_ID }}
+      LAYOUT_FOLDER: ${{ vars.LAYOUT_FOLDER }}
+      CI: true
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
+      - name: Install
+        run: npm install
+      - name: Lint
+        run: npm run lint
+      - name: Test
+        run: npm run test

.github/workflows/process.yml

@@ -11,12 +11,13 @@ jobs:
     env:
       LAYOUT_ID: ${{ vars.LAYOUT_ID }}
       LAYOUT_FOLDER: ${{ vars.LAYOUT_FOLDER }}
+      USER_NAME: ${{ github.event.repository.owner.name }}
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v3
       - name: Use Node.js
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v3
         with:
-          node-version: 14.x
+          node-version: 16.x
       - name: Install
         run: npm install
       - name: Get ORYX layout

.gitignore

@@ -1,4 +1,5 @@
 node_modules
+coverage
 test
 layout_src
 .env

.prettierrc

@@ -0,0 +1,7 @@
+{
+  "semi": true,
+  "trailingComma": "all",
+  "singleQuote": false,
+  "printWidth": 80,
+  "useTabs": false
+}

README.md

@@ -1,4 +1,4 @@
-# Ergodox Macro Hax
+# Oryx Macro Hax
 
 This is a quick and dirty script to nicely get around the annoying (though reasonable) limitation of Ergodox / Moonlander keyboards in the Oryx configurator where macros can only be five key sequences for security reasons.
 
@@ -39,12 +39,12 @@ It is also recommended to `git branch <your layout name>` and gitignore allowlis
 ## 2. Create a mapping in this script
 
 
-Grab macros.ts or example and change it to what you need
+Copy `macros/example.ts` and change it to what you need, use your lowercased username for the filename.
 
 Here's an example of creating an extended (more than five character) macro:
 
 ```
-const macro = newMacro()
+"funct": newMacro()
     .typeAlphanumeric("function") // Supports a-z and 0-9
     .sendRawCmd("SS_DELAY(100)") // Raw commands in the C file
     .tapKey("X_SPACE") // Tap a raw key code
@@ -68,19 +68,15 @@ The name of the macro tells the system what to replace. always start with 'dance
         .typeAlphanumeric("cp ../moonlander_hacked.bin /mnt/c/tools/"),
 
 ```
+### Tests `npm test (--watch | --coverage)`
 
+You can also create a `user_name.process_record_user.spec.ts` (integration test) or unit tests if you like TDD and test coverage, please also add a unit test if you add a feature to the MacroBuilder!
 
+## 3. Run the post-processor `npm start`
 
-## 3. Run the post-processor
+Run to modify your `keymap.c` and extend your macros. By default layoutFolderName is 'moonlander_default-layout_source'
 
-Run to modify your config and extend your macros. By default layoutFolderName is 'moonlander_default-layout_source'
-
-```
-cd ~/qmk_firmware/ergodox-macro-hax
-npm run hax -- <layoutFolderName>
-```
-
-Run `npm run copy` to copy the processed keymap to the parent keymaps folder (../keyboards/moonlander/keymaps/hacked).
+Optionally, run `npm run copy` to copy the processed keymap to the parent keymaps folder (../keyboards/moonlander/keymaps/hacked).
 
 ## 4. Build Modified Source and Flash it!
 

babel.config.cjs

@@ -0,0 +1,6 @@
+module.exports = {
+  presets: [
+    ['@babel/preset-env', {targets: {node: 'current'}}],
+    '@babel/preset-typescript',
+  ],
+};