bettermusic
diff --git a/‎package.json
Lines changed: 3 additions & 2 deletions b/‎package.json
Lines changed: 3 additions & 2 deletions
diff --git a/‎script/debug_parser.ts
Lines changed: 5 additions & 81 deletions b/‎script/debug_parser.ts
Lines changed: 5 additions & 81 deletions
diff --git a/‎script/helpers/parser_builder.ts
Lines changed: 95 additions & 0 deletions b/‎script/helpers/parser_builder.ts
Lines changed: 95 additions & 0 deletions
diff --git a/‎script/helpers/peggy_online.ts
Lines changed: 64 additions & 0 deletions b/‎script/helpers/peggy_online.ts
Lines changed: 64 additions & 0 deletions
diff --git a/‎src/chord_sheet/song.ts
Lines changed: 26 additions & 3 deletions b/‎src/chord_sheet/song.ts
Lines changed: 26 additions & 3 deletions
@@ -59,7 +59,6 @@
     "ts-jest": "^29.2.5",
     "ts-node": "^10.9.2",
     "ts-pegjs": "^3.0.0",
-    "tsc": "^2.0.4",
     "tsx": "^4.10.5",
     "typedoc": "^0.27.6",
     "typescript": "^5.7.3",
@@ -69,7 +68,9 @@
     "build": "yarn unibuild",
     "build:release": "yarn unibuild --force --release",
     "ci": "yarn install && yarn unibuild ci",
-    "debug:chordpro": "yarn build && tsx script/debug_parser.ts chord_pro --skip-chord-grammar",
+    "debug:chord": "yarn build && tsx script/debug_parser.ts chord",
+    "debug:chordpro": "yarn build && tsx script/debug_parser.ts chord_pro",
+    "debug:chords-over-words": "yarn build && tsx script/debug_parser.ts chords_over_words --include-chord-grammar",
     "dev": "parcel watch --no-cache",
     "dev:pdf": "parcel test/formatter/pdf/index.html --port=3000",
     "eslint": "node_modules/.bin/eslint",
 
@@ -1,86 +1,10 @@
-// eslint no-console: "off"
-
-import fs from 'fs';
 import process from 'process';
-import puppeteer from 'puppeteer';
-import esbuild from 'esbuild';
-
-const parserName = process.argv[2];
-const args = process.argv.slice(3);
-const skipChordGrammar = args.includes('--skip-chord-grammar');
-
-const parserFolder = `./src/parser/${parserName}`;
-const grammarFile = `${parserFolder}/grammar.pegjs`;
-const helpersFile = `${parserFolder}/helpers.ts`;
-const chordGrammarFile = './src/parser/chord/base_grammar.pegjs';
-const chordSuffixGrammarFile = './src/parser/chord/suffix_grammar.pegjs';
-const whitespaceGrammarFile = './src/parser/whitespace_grammar.pegjs';
-const sectionsGrammarFile = './src/parser/chord_pro/sections_grammar.pegjs';
-const chordDefinitionGrammarFile = './src/parser/chord_definition/grammar.pegjs';
-
-const parserGrammar = fs.readFileSync(grammarFile, 'utf8');
-const chordGrammar = skipChordGrammar ? '' : fs.readFileSync(chordGrammarFile);
-const chordSuffixGrammar = fs.readFileSync(chordSuffixGrammarFile);
-const whitespaceGrammar = fs.readFileSync(whitespaceGrammarFile);
-const sectionsGrammar = fs.readFileSync(sectionsGrammarFile);
-const chordDefinitionGrammar = fs.readFileSync(chordDefinitionGrammarFile);
-
-const result = esbuild.buildSync({
-  bundle: true,
-  entryPoints: [helpersFile],
-  globalName: 'helpers',
-  write: false,
-});
-
-const transpiledHelpers = result.outputFiles[0].text;
-
-const parserSource = [
-  `{\n${transpiledHelpers}\n}`,
-  parserGrammar,
-  chordGrammar,
-  chordSuffixGrammar,
-  chordDefinitionGrammar,
-  sectionsGrammar,
-  whitespaceGrammar,
-].join('\n\n');
-
-async function run() {
-  const browser = await puppeteer.launch({
-    args: ['--start-maximized'],
-    defaultViewport: null,
-    headless: false,
-  });
-
-  async function shutdownHandler() {
-    await browser.close();
-  }
-
-  ['exit', 'SIGINT', 'SIGUSR1', 'SIGUSR2', 'uncaughtException', 'SIGTERM'].forEach((event) => {
-    process.on(event, shutdownHandler);
-  });
-
-  const [page] = await browser.pages();
-  await page.setViewport({ width: 0, height: 0 });
-  await page.goto('https://peggyjs.org/online.html');
-
-  await page.evaluate((grammar) => {
-    // eslint-disable-next-line no-undef
-    const textarea = document.getElementById('grammar');
-    if (!textarea) return;
-
-    const editorNode = textarea.nextSibling;
-    if (!editorNode) return;
-
-    // @ts-expect-error There is no way to validate that the CodeMirror object is present
-    const editor = editorNode.CodeMirror;
-    editor.setValue(grammar);
-  }, parserSource);
+import PeggyOnline from './helpers/peggy_online';
+import ParserBuilder from './helpers/parser_builder';
 
-  while (true) {
-    // Loop forever to allow for interactive debugging with the online Peggy parser
-  }
-}
+const parserSource = new ParserBuilder(process.argv[2]).build();
 
-run()
+PeggyOnline
+  .open(parserSource)
   .then(() => console.log('Done'))
   .catch((e) => console.error(e));
@@ -0,0 +1,95 @@
+import fs from 'fs';
+import esbuild from 'esbuild';
+
+class ParserBuilder {
+  parserName: string;
+
+  chordDefinitionGrammarFile = './src/parser/chord_definition/grammar.pegjs';
+
+  chordGrammarFile = './src/parser/chord/base_grammar.pegjs';
+
+  chordSuffixGrammarFile = './src/parser/chord/suffix_grammar.pegjs';
+
+  chordSimpleSuffixGrammarFile = './src/parser/chord/simple_suffix_grammar.pegjs';
+
+  sectionsGrammarFile = './src/parser/chord_pro/sections_grammar.pegjs';
+
+  whitespaceGrammarFile = './src/parser/whitespace_grammar.pegjs';
+
+  constructor(parserName: string) {
+    this.parserName = parserName;
+  }
+
+  build(): string { return this.parserSource; }
+
+  get parserSource(): string {
+    return [
+      this.transpiledHelpers,
+      ...this.grammars,
+    ].join('\n\n');
+  }
+
+  get grammars(): (string | Buffer)[] {
+    switch (this.parserName) {
+      case 'chord':
+        return [this.chordGrammar, this.chordSimpleSuffixGrammar];
+      case 'chord_pro':
+        return [this.parserGrammar, this.chordDefinitionGrammar, this.sectionsGrammar, this.whitespaceGrammar];
+      case 'chords_over_words':
+        return [this.parserGrammar, this.chordGrammar, this.chordSuffixGrammar, this.whitespaceGrammar];
+      default:
+        throw new Error(`No configuration for parser ${this.parserName}`);
+    }
+  }
+
+  get parserFolder(): string { return `./src/parser/${this.parserName}`; }
+
+  get grammarFile(): string { return `${this.parserFolder}/grammar.pegjs`; }
+
+  get helpersFile(): string { return `${this.parserFolder}/helpers.ts`; }
+
+  get parserGrammar(): string | Buffer {
+    return fs.readFileSync(this.grammarFile, 'utf8');
+  }
+
+  get chordSuffixGrammar(): string | Buffer {
+    return fs.readFileSync(this.chordSuffixGrammarFile);
+  }
+
+  get chordSimpleSuffixGrammar(): string | Buffer {
+    return fs.readFileSync(this.chordSimpleSuffixGrammarFile);
+  }
+
+  get whitespaceGrammar(): string | Buffer {
+    return fs.readFileSync(this.whitespaceGrammarFile);
+  }
+
+  get chordDefinitionGrammar(): string | Buffer {
+    return fs.readFileSync(this.chordDefinitionGrammarFile);
+  }
+
+  get sectionsGrammar(): string | Buffer {
+    return fs.readFileSync(this.sectionsGrammarFile);
+  }
+
+  get chordGrammar(): string | Buffer {
+    return fs.readFileSync(this.chordGrammarFile);
+  }
+
+  get transpiledHelpers(): string {
+    if (!fs.existsSync(this.helpersFile)) {
+      return '';
+    }
+
+    const result = esbuild.buildSync({
+      bundle: true,
+      entryPoints: [this.helpersFile],
+      globalName: 'helpers',
+      write: false,
+    });
+
+    return `{\n${result.outputFiles[0].text}\n}`;
+  }
+}
+
+export default ParserBuilder;
@@ -0,0 +1,64 @@
+import puppeteer, { Browser, Page } from 'puppeteer';
+import process from 'process';
+
+class PeggyOnline {
+  parserSource: string;
+
+  static open(parserSource: string): Promise<void> {
+    return new PeggyOnline(parserSource).open();
+  }
+
+  constructor(parserSource: string) {
+    this.parserSource = parserSource;
+  }
+
+  async open(): Promise<void> {
+    const browser = await this.launchBrowser();
+
+    async function shutdownHandler() {
+      await browser.close();
+    }
+
+    this.attachShutdownHandler(shutdownHandler);
+    const page = await this.openPage(browser);
+    await this.addGrammar(page);
+  }
+
+  async launchBrowser() {
+    return puppeteer.launch({
+      args: ['--start-maximized'],
+      defaultViewport: null,
+      headless: false,
+    });
+  }
+
+  async openPage(browser: Browser): Promise<Page> {
+    const [page] = await browser.pages();
+    await page.setViewport({ width: 0, height: 0 });
+    await page.goto('https://peggyjs.org/online.html');
+    return page;
+  }
+
+  async addGrammar(page: Page) {
+    await page.evaluate((grammar) => {
+      // eslint-disable-next-line no-undef
+      const textarea = document.getElementById('grammar');
+      if (!textarea) return;
+
+      const editorNode = textarea.nextSibling;
+      if (!editorNode) return;
+
+      // @ts-expect-error There is no way to validate that the CodeMirror object is present
+      const editor = editorNode.CodeMirror;
+      editor.setValue(grammar);
+    }, this.parserSource);
+  }
+
+  attachShutdownHandler(shutdownHandler: (...args: any[]) => void) {
+    ['exit', 'SIGINT', 'SIGUSR1', 'SIGUSR2', 'uncaughtException', 'SIGTERM'].forEach((event) => {
+      process.on(event, shutdownHandler);
+    });
+  }
+}
+
+export default PeggyOnline;
@@ -253,18 +253,33 @@ class Song extends MetadataAccessors {
    * @param {boolean} [options.normalizeChordSuffix=false] whether to normalize the chord suffixes after transposing
    * @returns {Song} The transposed song
    */
-  transpose(delta: number, { normalizeChordSuffix = false } = {}): Song {
+  transpose(
+    delta: number,
+    { modifier, normalizeChordSuffix = false }:
+      { modifier?: Modifier | null, normalizeChordSuffix?: boolean } = {},
+  ): Song {
     let transposedKey: Key | null = null;
     const song = (this as Song);
 
     return song.mapItems((item) => {
       if (item instanceof Tag && item.name === KEY) {
         transposedKey = Key.wrapOrFail(item.value).transpose(delta);
+
+        if (modifier) {
+          transposedKey = transposedKey.useModifier(modifier);
+        }
+
         return item.set({ value: transposedKey.toString() });
       }
 
       if (item instanceof ChordLyricsPair) {
-        return item.transpose(delta, transposedKey, { normalizeChordSuffix });
+        let chord = item.transpose(delta, transposedKey, { normalizeChordSuffix });
+
+        if (modifier) {
+          chord = chord.useModifier(modifier);
+        }
+
+        return chord;
       }
 
       return item;
@@ -309,7 +324,7 @@ class Song extends MetadataAccessors {
     const currentKey = this.requireCurrentKey();
     const targetKey = Key.wrapOrFail(newKey);
     const delta = currentKey.distanceTo(targetKey);
-    const transposedSong = this.transpose(delta);
+    const transposedSong = this.transpose(delta, { modifier: targetKey.modifier });
 
     if (targetKey.modifier) {
       return transposedSong.useModifier(targetKey.modifier);
@@ -320,6 +335,14 @@ class Song extends MetadataAccessors {
 
   /**
    * Returns a copy of the song with all chords changed to the specified modifier.
+   *
+   * Examples:
+   *
+   * ```js
+   * song.useModifier('#');
+   * song.useModifier('b');
+   * ```
+   *
    * @param {Modifier} modifier the new modifier
    * @returns {Song} the changed song
    */