chordsheetjs 7.16.0 → 7.17.0

package/README.md

@@ -1128,6 +1128,7 @@ https://chordpro.org/chordpro/directives-env_bridge/, https://chordpro.org/chord
 | [configuration.key] | [<code>Key</code>](#Key) \| <code>string</code> | <code></code> | <p>The key to use for rendering. The chord sheet will be transposed from the song's original key (as indicated by the <code>{key}</code> directive) to the specified key. Note that transposing will only work if the original song key is set.</p> |
 | [configuration.expandChorusDirective] | <code>boolean</code> | <code>false</code> | <p>Whether or not to expand <code>{chorus}</code> directives by rendering the last defined chorus inline after the directive.</p> |
 | [configuration.useUnicodeModifiers] | <code>boolean</code> | <code>false</code> | <p>Whether or not to use unicode flat and sharp symbols.</p> |
+| [configuration.normalizeChords] | <code>boolean</code> | <code>true</code> | <p>Whether or not to automatically normalize chords</p> |
 
 <a name="HtmlDivFormatter"></a>
 

package/lib/bundle.js

@@ -2703,7 +2703,8 @@ const $bbcfd2c49e8e9957$export$78c0028a34264234 = {
     },
     key: null,
     expandChorusDirective: false,
-    useUnicodeModifiers: false
+    useUnicodeModifiers: false,
+    normalizeChords: true
 };
 class $bbcfd2c49e8e9957$var$Configuration {
     constructor(configuration = $bbcfd2c49e8e9957$export$78c0028a34264234){
@@ -2714,6 +2715,7 @@ class $bbcfd2c49e8e9957$var$Configuration {
         this.evaluate = !!mergedConfig.evaluate;
         this.expandChorusDirective = !!mergedConfig.expandChorusDirective;
         this.useUnicodeModifiers = !!mergedConfig.useUnicodeModifiers;
+        this.normalizeChords = !!mergedConfig.normalizeChords;
         this.metadata = new (0, $71c330be198ce421$export$2e2bcd8739ae039)(configuration.metadata);
         this.key = configuration.key ? (0, $bff5407e03fdc8ee$export$2e2bcd8739ae039).wrap(configuration.key) : null;
         this.configuration = configuration;
@@ -2731,18 +2733,19 @@ var $bbcfd2c49e8e9957$export$2e2bcd8739ae039 = $bbcfd2c49e8e9957$var$Configurati
     /**
      * Instantiate
      * @param {Object} [configuration={}] options
-     * @param {boolean} [configuration.evaluate=false] Whether or not to evaluate meta expressions. For more info about
-     * meta expressions, see: https://bit.ly/2SC9c2u
+     * @param {boolean} [configuration.evaluate=false] Whether or not to evaluate meta expressions.
+     * For more info about meta expressions, see: https://bit.ly/2SC9c2u
      * @param {object} [configuration.metadata={}]
-     * @param {string} [configuration.metadata.separator=", "] The separator to be used when rendering a metadata value
-     * that has multiple values. See: https://bit.ly/2SC9c2u
-     * @param {Key|string} [configuration.key=null] The key to use for rendering. The chord sheet will be transposed
-     * from the song's original key (as indicated by the `{key}` directive) to the specified key.
-     * Note that transposing will only work
-     * if the original song key is set.
+     * @param {string} [configuration.metadata.separator=", "] The separator to be used when rendering a
+     * metadata value that has multiple values. See: https://bit.ly/2SC9c2u
+     * @param {Key|string} [configuration.key=null] The key to use for rendering. The chord sheet will be
+     * transposed from the song's original key (as indicated by the `{key}` directive) to the specified key.
+     * Note that transposing will only work if the original song key is set.
      * @param {boolean} [configuration.expandChorusDirective=false] Whether or not to expand `{chorus}` directives
      * by rendering the last defined chorus inline after the directive.
-     * @param {boolean} [configuration.useUnicodeModifiers=false] Whether or not to use unicode flat and sharp symbols.
+     * @param {boolean} [configuration.useUnicodeModifiers=false] Whether or not to use unicode flat and sharp
+     * symbols.
+     * @param {boolean} [configuration.normalizeChords=true] Whether or not to automatically normalize chords
      */ constructor(configuration = null){
         this.configuration = new (0, $bbcfd2c49e8e9957$export$2e2bcd8739ae039)(configuration || {});
     }
@@ -8234,14 +8237,16 @@ function $dfecd32049fa58e9$var$chordTransposeDistance(capo, transposeKey, songKe
     }
     return transpose;
 }
-function $dfecd32049fa58e9$export$596ec52955da9472(chordString, line, song, { renderKey: renderKey = null , useUnicodeModifier: useUnicodeModifier = false  } = {}) {
+function $dfecd32049fa58e9$export$596ec52955da9472(chordString, line, song, { renderKey: renderKey = null , useUnicodeModifier: useUnicodeModifier = false , normalizeChords: normalizeChords = true  } = {}) {
     const chord = (0, $26f57998457eb2d4$export$2e2bcd8739ae039).parse(chordString);
     const songKey = song.key;
     const capo = parseInt(song.metadata.getSingle((0, $5e9ede69210ec54a$export$866f445d49bad88e)), 10);
     if (!chord) return chordString;
     const effectiveTransposeDistance = $dfecd32049fa58e9$var$chordTransposeDistance(capo, line.transposeKey, songKey, renderKey);
     const effectiveKey = renderKey || (0, $bff5407e03fdc8ee$export$2e2bcd8739ae039).wrap(line.key || song.key)?.transpose(effectiveTransposeDistance) || null;
-    return chord.transpose(effectiveTransposeDistance).normalize(effectiveKey).toString({
+    const transposedChord = chord.transpose(effectiveTransposeDistance);
+    const normalizedChord = normalizeChords ? transposedChord.normalize(effectiveKey) : transposedChord;
+    return normalizedChord.toString({
         useUnicodeModifier: useUnicodeModifier
     });
 }
@@ -8316,7 +8321,8 @@ var $93f055b77b2d269f$export$2e2bcd8739ae039 = ({ configuration: configuration ,
                   <div class="column">
                     <div class="chord"${(0, $376e205ced98486b$export$ca030c9435779e4b)(line.chordFont)}>${(0, $dfecd32049fa58e9$export$596ec52955da9472)(item.chords, line, song, {
                             renderKey: key,
-                            useUnicodeModifier: configuration.useUnicodeModifiers
+                            useUnicodeModifier: configuration.useUnicodeModifiers,
+                            normalizeChords: configuration.normalizeChords
                         })}</div>
                     <div class="lyrics"${(0, $376e205ced98486b$export$ca030c9435779e4b)(line.textFont)}>${item.lyrics}</div>
                   </div>
@@ -8403,7 +8409,8 @@ var $5381a6b1b90601c7$export$2e2bcd8739ae039 = ({ configuration: configuration ,
                       ${(0, $376e205ced98486b$export$a55877ca9db47377)((0, $376e205ced98486b$export$17c9e635b932873b)(item), ()=>`
                         <td class="chord"${(0, $376e205ced98486b$export$ca030c9435779e4b)(line.chordFont)}>${(0, $dfecd32049fa58e9$export$596ec52955da9472)(item.chords, line, song, {
                                     renderKey: key,
-                                    useUnicodeModifier: configuration.useUnicodeModifiers
+                                    useUnicodeModifier: configuration.useUnicodeModifiers,
+                                    normalizeChords: configuration.normalizeChords
                                 })}</td>
                       `)}
                     `)}
@@ -8548,22 +8555,25 @@ var $5b02ea769c63fd56$export$2e2bcd8739ae039 = $5b02ea769c63fd56$var$HtmlTableFo
         return null;
     }
     chordLyricsPairLength(chordLyricsPair, line) {
-        const chords = (0, $dfecd32049fa58e9$export$596ec52955da9472)(chordLyricsPair.chords, line, this.song, {
-            renderKey: this.configuration.key
-        });
+        const chords = this.renderChords(chordLyricsPair, line);
         const { lyrics: lyrics  } = chordLyricsPair;
         const chordsLength = (chords || "").length;
         const lyricsLength = (lyrics || "").length;
         if (chordsLength >= lyricsLength) return chordsLength + 1;
         return Math.max(chordsLength, lyricsLength);
     }
+    renderChords(chordLyricsPair, line) {
+        const chords = (0, $dfecd32049fa58e9$export$596ec52955da9472)(chordLyricsPair.chords, line, this.song, {
+            renderKey: this.configuration.key,
+            useUnicodeModifier: this.configuration.useUnicodeModifiers,
+            normalizeChords: this.configuration.normalizeChords
+        });
+        return chords;
+    }
     formatItemTop(item, _metadata, line) {
         if (item instanceof (0, $5e9ede69210ec54a$export$2e2bcd8739ae039) && item.isRenderable()) return item.value || "";
         if (item instanceof (0, $d454f4215ba01af2$export$2e2bcd8739ae039)) {
-            const chords = (0, $dfecd32049fa58e9$export$596ec52955da9472)(item.chords, line, this.song, {
-                renderKey: this.configuration.key,
-                useUnicodeModifier: this.configuration.useUnicodeModifiers
-            });
+            const chords = this.renderChords(item, line);
             return (0, $21a34a464e7bc609$export$bc3bea8325045070)(chords, this.chordLyricsPairLength(item, line));
         }
         return "";

package/lib/index.js

@@ -2702,7 +2702,8 @@ const $bbcfd2c49e8e9957$export$78c0028a34264234 = {
     },
     key: null,
     expandChorusDirective: false,
-    useUnicodeModifiers: false
+    useUnicodeModifiers: false,
+    normalizeChords: true
 };
 class $bbcfd2c49e8e9957$var$Configuration {
     constructor(configuration = $bbcfd2c49e8e9957$export$78c0028a34264234){
@@ -2713,6 +2714,7 @@ class $bbcfd2c49e8e9957$var$Configuration {
         this.evaluate = !!mergedConfig.evaluate;
         this.expandChorusDirective = !!mergedConfig.expandChorusDirective;
         this.useUnicodeModifiers = !!mergedConfig.useUnicodeModifiers;
+        this.normalizeChords = !!mergedConfig.normalizeChords;
         this.metadata = new (0, $71c330be198ce421$export$2e2bcd8739ae039)(configuration.metadata);
         this.key = configuration.key ? (0, $bff5407e03fdc8ee$export$2e2bcd8739ae039).wrap(configuration.key) : null;
         this.configuration = configuration;
@@ -2730,18 +2732,19 @@ var $bbcfd2c49e8e9957$export$2e2bcd8739ae039 = $bbcfd2c49e8e9957$var$Configurati
     /**
      * Instantiate
      * @param {Object} [configuration={}] options
-     * @param {boolean} [configuration.evaluate=false] Whether or not to evaluate meta expressions. For more info about
-     * meta expressions, see: https://bit.ly/2SC9c2u
+     * @param {boolean} [configuration.evaluate=false] Whether or not to evaluate meta expressions.
+     * For more info about meta expressions, see: https://bit.ly/2SC9c2u
      * @param {object} [configuration.metadata={}]
-     * @param {string} [configuration.metadata.separator=", "] The separator to be used when rendering a metadata value
-     * that has multiple values. See: https://bit.ly/2SC9c2u
-     * @param {Key|string} [configuration.key=null] The key to use for rendering. The chord sheet will be transposed
-     * from the song's original key (as indicated by the `{key}` directive) to the specified key.
-     * Note that transposing will only work
-     * if the original song key is set.
+     * @param {string} [configuration.metadata.separator=", "] The separator to be used when rendering a
+     * metadata value that has multiple values. See: https://bit.ly/2SC9c2u
+     * @param {Key|string} [configuration.key=null] The key to use for rendering. The chord sheet will be
+     * transposed from the song's original key (as indicated by the `{key}` directive) to the specified key.
+     * Note that transposing will only work if the original song key is set.
      * @param {boolean} [configuration.expandChorusDirective=false] Whether or not to expand `{chorus}` directives
      * by rendering the last defined chorus inline after the directive.
-     * @param {boolean} [configuration.useUnicodeModifiers=false] Whether or not to use unicode flat and sharp symbols.
+     * @param {boolean} [configuration.useUnicodeModifiers=false] Whether or not to use unicode flat and sharp
+     * symbols.
+     * @param {boolean} [configuration.normalizeChords=true] Whether or not to automatically normalize chords
      */ constructor(configuration = null){
         this.configuration = new (0, $bbcfd2c49e8e9957$export$2e2bcd8739ae039)(configuration || {});
     }
@@ -8233,14 +8236,16 @@ function $dfecd32049fa58e9$var$chordTransposeDistance(capo, transposeKey, songKe
     }
     return transpose;
 }
-function $dfecd32049fa58e9$export$596ec52955da9472(chordString, line, song, { renderKey: renderKey = null , useUnicodeModifier: useUnicodeModifier = false  } = {}) {
+function $dfecd32049fa58e9$export$596ec52955da9472(chordString, line, song, { renderKey: renderKey = null , useUnicodeModifier: useUnicodeModifier = false , normalizeChords: normalizeChords = true  } = {}) {
     const chord = (0, $26f57998457eb2d4$export$2e2bcd8739ae039).parse(chordString);
     const songKey = song.key;
     const capo = parseInt(song.metadata.getSingle((0, $5e9ede69210ec54a$export$866f445d49bad88e)), 10);
     if (!chord) return chordString;
     const effectiveTransposeDistance = $dfecd32049fa58e9$var$chordTransposeDistance(capo, line.transposeKey, songKey, renderKey);
     const effectiveKey = renderKey || (0, $bff5407e03fdc8ee$export$2e2bcd8739ae039).wrap(line.key || song.key)?.transpose(effectiveTransposeDistance) || null;
-    return chord.transpose(effectiveTransposeDistance).normalize(effectiveKey).toString({
+    const transposedChord = chord.transpose(effectiveTransposeDistance);
+    const normalizedChord = normalizeChords ? transposedChord.normalize(effectiveKey) : transposedChord;
+    return normalizedChord.toString({
         useUnicodeModifier: useUnicodeModifier
     });
 }
@@ -8315,7 +8320,8 @@ var $93f055b77b2d269f$export$2e2bcd8739ae039 = ({ configuration: configuration ,
                   <div class="column">
                     <div class="chord"${(0, $376e205ced98486b$export$ca030c9435779e4b)(line.chordFont)}>${(0, $dfecd32049fa58e9$export$596ec52955da9472)(item.chords, line, song, {
                             renderKey: key,
-                            useUnicodeModifier: configuration.useUnicodeModifiers
+                            useUnicodeModifier: configuration.useUnicodeModifiers,
+                            normalizeChords: configuration.normalizeChords
                         })}</div>
                     <div class="lyrics"${(0, $376e205ced98486b$export$ca030c9435779e4b)(line.textFont)}>${item.lyrics}</div>
                   </div>
@@ -8402,7 +8408,8 @@ var $5381a6b1b90601c7$export$2e2bcd8739ae039 = ({ configuration: configuration ,
                       ${(0, $376e205ced98486b$export$a55877ca9db47377)((0, $376e205ced98486b$export$17c9e635b932873b)(item), ()=>`
                         <td class="chord"${(0, $376e205ced98486b$export$ca030c9435779e4b)(line.chordFont)}>${(0, $dfecd32049fa58e9$export$596ec52955da9472)(item.chords, line, song, {
                                     renderKey: key,
-                                    useUnicodeModifier: configuration.useUnicodeModifiers
+                                    useUnicodeModifier: configuration.useUnicodeModifiers,
+                                    normalizeChords: configuration.normalizeChords
                                 })}</td>
                       `)}
                     `)}
@@ -8547,22 +8554,25 @@ var $5b02ea769c63fd56$export$2e2bcd8739ae039 = $5b02ea769c63fd56$var$HtmlTableFo
         return null;
     }
     chordLyricsPairLength(chordLyricsPair, line) {
-        const chords = (0, $dfecd32049fa58e9$export$596ec52955da9472)(chordLyricsPair.chords, line, this.song, {
-            renderKey: this.configuration.key
-        });
+        const chords = this.renderChords(chordLyricsPair, line);
         const { lyrics: lyrics  } = chordLyricsPair;
         const chordsLength = (chords || "").length;
         const lyricsLength = (lyrics || "").length;
         if (chordsLength >= lyricsLength) return chordsLength + 1;
         return Math.max(chordsLength, lyricsLength);
     }
+    renderChords(chordLyricsPair, line) {
+        const chords = (0, $dfecd32049fa58e9$export$596ec52955da9472)(chordLyricsPair.chords, line, this.song, {
+            renderKey: this.configuration.key,
+            useUnicodeModifier: this.configuration.useUnicodeModifiers,
+            normalizeChords: this.configuration.normalizeChords
+        });
+        return chords;
+    }
     formatItemTop(item, _metadata, line) {
         if (item instanceof (0, $5e9ede69210ec54a$export$2e2bcd8739ae039) && item.isRenderable()) return item.value || "";
         if (item instanceof (0, $d454f4215ba01af2$export$2e2bcd8739ae039)) {
-            const chords = (0, $dfecd32049fa58e9$export$596ec52955da9472)(item.chords, line, this.song, {
-                renderKey: this.configuration.key,
-                useUnicodeModifier: this.configuration.useUnicodeModifiers
-            });
+            const chords = this.renderChords(item, line);
             return (0, $21a34a464e7bc609$export$bc3bea8325045070)(chords, this.chordLyricsPairLength(item, line));
         }
         return "";