Integrate unibuild (#1376)

Author: martijnversluis

eslint.config.mjs

@@ -58,6 +58,7 @@ export default tseslint.config(
           argsIgnorePattern: '^_',
           caughtErrorsIgnorePattern: '^_',
           destructuredArrayIgnorePattern: '^_',
+          varsIgnorePattern: '^_',
         },
       ],
     },

package.json

@@ -32,6 +32,7 @@
     "@babel/preset-typescript": "^7.16.7",
     "@eslint/core": "^0.6.0",
     "@eslint/js": "^9.11.0",
+    "@martijnversluis/unibuild": "0.3.3",
     "@parcel/packager-ts": "2.12.0",
     "@parcel/transformer-typescript-types": "2.12.0",
     "@types/eslint__js": "^8.42.3",
@@ -71,15 +72,8 @@
     "build:bundle:default": "esbuild lib/index.js --outfile=lib/bundle.js --bundle --global-name=ChordSheetJS",
     "build:bundle:min": "esbuild lib/index.js --outfile=lib/bundle.min.js --bundle --global-name=ChordSheetJS --minify-whitespace --minify-identifiers --minify-syntax",
     "build:check-types": "tsc lib/main.d.ts",
-    "build:chord-suffix-grammar": "yarn tsx script/generate_chord_suffix_grammar.ts",
-    "build:code-generate": "yarn build:suffix-normalize && yarn build:chord-suffix-grammar && yarn build:pegjs && yarn build:scales",
-    "build:pegjs": "yarn build:pegjs:chord && yarn build:pegjs:chordpro && yarn build:pegjs:chords-over-words",
-    "build:pegjs:chord": "tsx script/combine_files.ts src/parser/chord/base_grammar.pegjs src/parser/chord/suffix_grammar.pegjs src/parser/chord/combined_grammer.pegjs && peggy --plugin ts-pegjs -o src/parser/chord/peg_parser.ts src/parser/chord/combined_grammer.pegjs",
-    "build:pegjs:chordpro": "tsx script/generate_parser.ts chord_pro --skip-chord-grammar",
-    "build:pegjs:chords-over-words": "tsx script/generate_parser.ts chords_over_words",
-    "build:scales": "tsx script/generate_scales.ts && yarn linter:fix src/scales.ts",
+    "build:code-generate": "tsx ./unibuild.ts",
     "build:sources": "parcel build",
-    "build:suffix-normalize": "shx rm -rf src/normalize_mappings/suffix-normalize-mapping.ts && tsx script/generate-suffix-normalize-mapping.ts",
     "ci": "yarn install && yarn lint && yarn test && yarn build && yarn readme",
     "clean": "shx rm -rf node_modules && shx rm -rf lib",
     "debug:chordpro": "tsx script/debug_parser.ts chord_pro --skip-chord-grammar",
@@ -95,7 +89,7 @@
     "postpublish": "pinst --enable",
     "prelint": "yarn pretest",
     "prepare": "husky install",
-    "prepublish": "pinst --disable && yarn install && yarn test && yarn build",
+    "prepublish": "pinst --disable && yarn install && yarn test && yarn build:code-generate",
     "pretest": "NODE_ENV=test yarn build:code-generate",
     "readme": "node_modules/.bin/jsdoc2md -f src/**/*.ts -f src/*.ts --configure ./jsdoc2md.json --template doc/README.hbs > README.md",
     "test": "yarn pretest && yarn linter:run && yarn jest:run"

script/build_chord_suffix_grammar.ts

@@ -0,0 +1,31 @@
+import { EOL } from 'os';
+import { BuildOptions } from 'esbuild';
+
+export default function buildChordSuffixGrammar(_: BuildOptions, data: string): string {
+  const suffixes: string[] = data
+    .split(EOL)
+    .filter((s) => s.trim().length > 0)
+    .flatMap((line) => line.split(/,\s*/))
+    .sort((a, b) => b.length - a.length)
+    .map((suffix) => `"${suffix}"`);
+
+  const groups: string[][] = [];
+
+  const copy = [...suffixes];
+
+  while (copy.length > 0) {
+    const chunk = copy.splice(0, 100) as string[];
+    groups.push(chunk);
+  }
+
+  const groupsGrammar = groups.map((groupSuffixes, i) => (
+    `ChordSuffix${i}\n  = ${groupSuffixes.join('\n  / ')}\n`
+  ));
+
+  return `
+ChordSuffix
+  = (${groupsGrammar.map((_grammar, i) => `ChordSuffix${i}`).join(' / ')})?
+
+${groupsGrammar.join('\n')}
+`;
+}

script/build_chord_suffix_normalize_mapping.ts

@@ -0,0 +1,15 @@
+import { EOL } from 'os';
+import { BuildOptions } from 'esbuild';
+
+export default function buildChordSuffixNormalizeMapping(_: BuildOptions, data: string): string {
+  const suffixes = data
+    .split(EOL)
+    .map((line) => {
+      const variants = line.split(/,\s*/);
+      return variants.reduce((acc, variant) => ({ ...acc, [variant]: variants[0] }), {});
+    })
+    .reduce((acc, set) => ({ ...acc, ...set }), {});
+
+  const json = JSON.stringify(suffixes, null, 2);
+  return `const mapping: Record<string, string> = ${json};${EOL}${EOL}export default mapping;`;
+}

script/build_scales.ts

@@ -0,0 +1,117 @@
+/* eslint indent: 0 */
+
+import SCALES from '../data/scales';
+
+import {
+  FLAT,
+  MAJOR,
+  MINOR,
+  NO_MODIFIER,
+  NUMERAL,
+  NUMERIC,
+  SHARP,
+  SYMBOL,
+  SOLFEGE,
+} from '../src/constants';
+
+interface BuildOptions {
+  force: boolean;
+  release: boolean;
+}
+
+export default function buildScales(_: BuildOptions): string {
+  const MODIFIERS = { NO_MODIFIER, SHARP, FLAT };
+  const MODES = { MAJOR, MINOR };
+
+  const KEY_TYPES = {
+    SYMBOL,
+    SOLFEGE,
+    NUMERIC,
+    NUMERAL,
+  };
+
+  return `
+  /*
+  ⚠️⚠️⚠️ NOTE: this file has been generated automatically.
+          Please do NOT edit this file directly, but instead:
+            - edit the data source, located in \`data/scales.ts\`
+            - run \`yarn build:code-generate\` to re-generate this file.
+   */
+   
+  import {
+    ChordType, 
+    Mode,
+    ModifierMaybe, 
+    FLAT, 
+    MAJOR,
+    MINOR,
+    NO_MODIFIER, 
+    NUMERAL, 
+    NUMERIC, 
+    SHARP, 
+    SYMBOL,
+    SOLFEGE
+  } from './constants';
+
+  export const KEY_TO_GRADE: Record<ChordType, Record<Mode, Record<ModifierMaybe, Record<string, number>>>> = {
+    ${
+    Object.entries(KEY_TYPES).map(([keyTypeName, keyTypeValue]) => `
+        [${keyTypeName}]: {
+          ${
+            Object.entries(MODES).map(([modeName, modeValue]) => `
+              [${modeName}]: {
+                ${
+                  Object.entries(MODIFIERS).map(([modifierName, modifierValue]) => `
+                    [${modifierName}]: {
+                      ${
+                        SCALES[keyTypeValue][modeValue][modifierValue].map((keyString, grade) => {
+                          if (keyString === null) {
+                            return null;
+                          }
+
+                          const keyWithoutModifier = keyString.replace(/#|b/g, '');
+                          return `${keyWithoutModifier}: ${grade}`;
+                        }).filter((v) => v).join(',\n')
+                      }
+                    },
+                  `).join('\n')
+                }
+              },
+            `).join('\n')
+          }
+        },
+      `).join('\n')
+    }
+  };
+  
+  export const GRADE_TO_KEY: Record<ChordType, Record<Mode, Record<ModifierMaybe, Record<number, string>>>> = {
+    ${
+      Object.entries(KEY_TYPES).map(([keyTypeName, keyTypeValue]) => `
+        [${keyTypeName}]: {
+          ${
+            Object.entries(MODES).map(([modeName, modeValue]) => `
+              [${modeName}]: {
+                ${
+                  Object.entries(MODIFIERS).map(([modifierName, modifierValue]) => `
+                    [${modifierName}]: {
+                      ${
+                        SCALES[keyTypeValue][modeValue][modifierValue].map((keyString, grade) => {
+                          if (keyString === null) {
+                            return null;
+                          }
+
+                          return `${grade}: '${keyString}',`;
+                        }).filter((v) => v).join('\n')
+                      }
+                    },
+                  `).join('\n')
+                }
+              },
+            `).join('\n')
+            }
+        },
+      `).join('\n')
+    }
+  };
+`.substring(1);
+}