chordsheetjs 15.5.2 → 15.6.0-canary.0

package/lib/bundle.js

@@ -5392,17 +5392,25 @@ ${error.stack}`);
         [$7251dad5f4a4c35f$var$TEXTSIZE_SHORT]: (0, $d21c5c7a462f3c34$export$f0dee7f48597f09a),
         [$7251dad5f4a4c35f$var$TITLE_SHORT]: (0, $d21c5c7a462f3c34$export$f1e53f710478ceb4)
       };
+      var $7251dad5f4a4c35f$var$SHORT_ALIASES = Object.entries($7251dad5f4a4c35f$var$ALIASES).reduce((acc, [shortName, longName]) => {
+        if (!(longName in acc)) acc[longName] = shortName;
+        return acc;
+      }, {});
       var $7251dad5f4a4c35f$var$TAG_REGEX = /^([^:\s]+)(:?\s*(.+))?$/;
       var $7251dad5f4a4c35f$var$CUSTOM_META_TAG_NAME_REGEX = /^x_(.+)$/;
       function $7251dad5f4a4c35f$export$3ef04055cb4a269a(tagName) {
         return $7251dad5f4a4c35f$export$75d737e15c3fab80.includes(tagName);
       }
-      var $7251dad5f4a4c35f$var$translateTagNameAlias = (name) => {
+      var $7251dad5f4a4c35f$export$b1fb291dbbae74dd = (name) => {
         if (!name) return name;
         const sanitizedName = name.trim();
         if (sanitizedName in $7251dad5f4a4c35f$var$ALIASES) return $7251dad5f4a4c35f$var$ALIASES[sanitizedName];
         return sanitizedName;
       };
+      var $7251dad5f4a4c35f$export$5b25cb93653f4dde = (name) => {
+        const longName = $7251dad5f4a4c35f$export$b1fb291dbbae74dd(name);
+        return $7251dad5f4a4c35f$var$SHORT_ALIASES[longName] || longName;
+      };
       var $7251dad5f4a4c35f$var$Tag = class _$7251dad5f4a4c35f$var$Tag extends (0, $c5ce4fc4f57fe810$export$2e2bcd8739ae039) {
         static [Symbol.hasInstance](instance) {
           return (0, $5d58e7f5804fd974$export$c2feda9b9903876a)(instance, (0, $5d58e7f5804fd974$export$76ece97d1f94609e));
@@ -5479,7 +5487,7 @@ ${error.stack}`);
           return this.name === (0, $d21c5c7a462f3c34$export$74f94c628b84d921);
         }
         set name(name) {
-          this._name = $7251dad5f4a4c35f$var$translateTagNameAlias(name);
+          this._name = $7251dad5f4a4c35f$export$b1fb291dbbae74dd(name);
           this._originalName = name;
         }
         /**
@@ -5597,6 +5605,7 @@ ${error.stack}`);
       var $287d3e472e1fbd90$export$82f9bd327a40ea54 = {
         decapo: false,
         delegates: $287d3e472e1fbd90$export$7d00225c1398f6c0,
+        directiveNameNormalization: "none",
         evaluate: false,
         expandChorusDirective: false,
         instrument: null,
@@ -6338,6 +6347,8 @@ ${error.stack}`);
         /**
         * Instantiate
         * @param {DeepPartial<T>} [configuration={}] options
+        * @param {'none'|'prefer-long'|'prefer-short'} [configuration.directiveNameNormalization='none'] Whether to
+        * preserve directive names, prefer long directive names, or prefer short aliases where available.
         * @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={}]
@@ -6610,9 +6621,21 @@ ${formattedContentLines}`;
           return "";
         }
         formatTag(tag) {
-          if (tag.hasAttributes()) return `{${tag.originalName}: ${this.formatTagAttributes(tag)}}`;
-          if (tag.hasValue()) return `{${tag.originalName}: ${tag.value}}`;
-          return `{${tag.originalName}}`;
+          const directiveName = this.formatDirectiveName(tag);
+          if (tag.hasAttributes()) return `{${directiveName}: ${this.formatTagAttributes(tag)}}`;
+          if (tag.hasValue()) return `{${directiveName}: ${tag.value}}`;
+          return `{${directiveName}}`;
+        }
+        formatDirectiveName(tag) {
+          switch (this.configuration.directiveNameNormalization) {
+            case "prefer-long":
+              return (0, $7251dad5f4a4c35f$export$b1fb291dbbae74dd)(tag.name);
+            case "prefer-short":
+              return (0, $7251dad5f4a4c35f$export$5b25cb93653f4dde)(tag.name);
+            case "none":
+            default:
+              return tag.originalName;
+          }
         }
         formatTagAttributes(tag) {
           const keys = Object.keys(tag.attributes);
@@ -8676,7 +8699,10 @@ Or set the song key before changing key:
           const eagerChord = this.notation && chordString ? (0, $177a605b8569b31c$export$2e2bcd8739ae039).parse(chordString, {
             notation: this.notation
           }) : null;
-          return new (0, $551a223fc13b5c10$export$2e2bcd8739ae039)(eagerChord ? eagerChord.toString() : chordString, lyrics, annotation, eagerChord, isRhythmSymbol || false);
+          return new (0, $551a223fc13b5c10$export$2e2bcd8739ae039)(eagerChord ? eagerChord.toString() : chordString, lyrics, annotation, eagerChord, isRhythmSymbol || this.isRhythmSymbol(chordString));
+        }
+        isRhythmSymbol(chordString) {
+          return chordString === "|" || chordString === "/";
         }
         parseTag(astComponent) {
           const { name, value, location: { offset = null, line = null, column = null } = {}, chordDefinition, attributes, selector, isNegated } = astComponent;
@@ -13743,6 +13769,15 @@ Or set the song key before changing key:
         stripPangoMarkup: $1883202621c13add$export$3dd9b04564de283e,
         processMetadata: $f9c5006b26957916$export$5c964b66c4a8abfb
       };
+      var $2d92af868d7c705a$var$DIRECTION_KEYWORDS = [
+        "verse",
+        "chorus",
+        "bridge",
+        "tag",
+        "interlude",
+        "instrumental",
+        "intro"
+      ];
       var $2d92af868d7c705a$var$ChordsOverWordsFormatter = class extends (0, $ed0d9ddbbe7224cd$export$2e2bcd8739ae039) {
         /**
         * Formats a song into a plain text chord sheet
@@ -13768,9 +13803,10 @@ Or set the song key before changing key:
           const songMetadata = this.song.getMetadata(this.configuration);
           const orderedMetadata = (0, $f9c5006b26957916$export$5c964b66c4a8abfb)(songMetadata.ownMetadata(), this.configuration.metadata);
           const metadata = orderedMetadata.map(([key, value]) => {
-            if (Array.isArray(value)) return `${key}: ${value.join(",")}`;
-            if (typeof value === "undefined" || value === null || value === "") return `${key}:`;
-            return `${key}: ${value}`;
+            const directiveName = this.formatMetadataName(key);
+            if (Array.isArray(value)) return `${directiveName}: ${value.join(",")}`;
+            if (typeof value === "undefined" || value === null || value === "") return `${directiveName}:`;
+            return `${directiveName}: ${value}`;
           }).join("\n");
           return metadata ? `${metadata}
 
@@ -13837,12 +13873,40 @@ Or set the song key before changing key:
         }
         formatItemBottom(item, metadata, line) {
           if (typeof item === "string") return item;
-          if (item instanceof (0, $7251dad5f4a4c35f$export$2e2bcd8739ae039) && item.isRenderable()) return item.label;
+          if (item instanceof (0, $7251dad5f4a4c35f$export$2e2bcd8739ae039) && item.isRenderable()) return this.formatTag(item);
           if (item instanceof (0, $551a223fc13b5c10$export$2e2bcd8739ae039)) return this.formatChordLyricsPair(item, line);
           if ("evaluate" in item) return this.formatEvaluatable(item, metadata);
           if (item instanceof (0, $4b6dd3e4b817bd81$export$2e2bcd8739ae039)) return "\\ ";
           return "";
         }
+        formatTag(item) {
+          if (item.isComment() && !this.isBareCommentLabel(item.label)) return `${this.formatDirectiveName(item)}: ${item.label}`;
+          return item.label;
+        }
+        formatDirectiveName(tag) {
+          return this.formatTagName(tag.name, tag.originalName);
+        }
+        formatMetadataName(name) {
+          return this.formatTagName(name, this.findOriginalMetadataName(name));
+        }
+        formatTagName(name, originalName) {
+          switch (this.configuration.directiveNameNormalization) {
+            case "prefer-long":
+              return (0, $7251dad5f4a4c35f$export$b1fb291dbbae74dd)(name);
+            case "prefer-short":
+              return (0, $7251dad5f4a4c35f$export$5b25cb93653f4dde)(name);
+            case "none":
+            default:
+              return originalName;
+          }
+        }
+        findOriginalMetadataName(name) {
+          const item = this.song.lines.flatMap((line) => line.items).find((lineItem) => lineItem instanceof (0, $7251dad5f4a4c35f$export$2e2bcd8739ae039) && lineItem.isMetaTag() && lineItem.name === name);
+          return item instanceof (0, $7251dad5f4a4c35f$export$2e2bcd8739ae039) ? item.originalName : name;
+        }
+        isBareCommentLabel(label) {
+          return $2d92af868d7c705a$var$DIRECTION_KEYWORDS.some((keyword) => label.trim().toLowerCase().startsWith(keyword));
+        }
         formatEvaluatable(item, metadata) {
           return item.evaluate(metadata, this.configuration.metadata.separator);
         }
@@ -28448,7 +28512,7 @@ ${template}
           const renderedChords = this.renderChordText(chords, line);
           const measurements = this.calculateMeasurements(renderedChords, lyrics, nextItem, lyricsOnly);
           return {
-            item: new (0, $551a223fc13b5c10$export$2e2bcd8739ae039)(chords, lyrics),
+            item: new (0, $551a223fc13b5c10$export$2e2bcd8739ae039)(chords, lyrics, splitItem.annotation, null, splitItem.isRhythmSymbol),
             width: measurements.totalWidth,
             chordHeight: measurements.chordHeight
           };
@@ -28560,11 +28624,7 @@ ${template}
           const firstLyrics = splitLines[0];
           const secondLyrics = splitLines.slice(1).join(" ");
           return [
-            {
-              item: new (0, $551a223fc13b5c10$export$2e2bcd8739ae039)(item.item.chords, firstLyrics),
-              width: this.measurer.measureTextWidth(firstLyrics, lyricsFont),
-              chordHeight: item.chordHeight
-            },
+            this.createSplitMeasuredItem(item, firstLyrics, item.item.chords, item.item.isRhythmSymbol),
             {
               item: new (0, $551a223fc13b5c10$export$2e2bcd8739ae039)("", secondLyrics),
               width: this.measurer.measureTextWidth(secondLyrics, lyricsFont),
@@ -28572,6 +28632,14 @@ ${template}
             }
           ];
         }
+        createSplitMeasuredItem(originalItem, lyrics, chords, isRhythmSymbol) {
+          const annotation = originalItem.item instanceof (0, $551a223fc13b5c10$export$2e2bcd8739ae039) ? originalItem.item.annotation : null;
+          return {
+            item: new (0, $551a223fc13b5c10$export$2e2bcd8739ae039)(chords, lyrics, annotation, null, isRhythmSymbol),
+            width: this.measurer.measureTextWidth(lyrics, this.config.fonts.lyrics),
+            chordHeight: originalItem.chordHeight
+          };
+        }
         /**
         * Removes hyphens from lyrics for lyrics-only mode
         */
@@ -28599,11 +28667,11 @@ ${template}
                 items.push(new (0, $551a223fc13b5c10$export$2e2bcd8739ae039)("", adjustedFragment, ""));
               }
             }
-            if (index === 0 && lyricFragments.length === 1) items.push(new (0, $551a223fc13b5c10$export$2e2bcd8739ae039)(chords, fragment, annotation));
+            if (index === 0 && lyricFragments.length === 1) items.push(new (0, $551a223fc13b5c10$export$2e2bcd8739ae039)(chords, fragment, annotation, null, pair.isRhythmSymbol));
             else if (index === 0 && lyricFragments.length > 1) {
               let commaAdjustedFragment = fragment;
               commaAdjustedFragment += ",";
-              items.push(new (0, $551a223fc13b5c10$export$2e2bcd8739ae039)(chords, commaAdjustedFragment, annotation));
+              items.push(new (0, $551a223fc13b5c10$export$2e2bcd8739ae039)(chords, commaAdjustedFragment, annotation, null, pair.isRhythmSymbol));
             }
           });
           return items;
@@ -28745,7 +28813,7 @@ ${template}
             this.layoutFactory.createLineLayout(items, line)
           ];
           if (softBreakIndices.length === 0) return this.handleNoSoftBreaks(items, availableWidth, line);
-          const { firstChunk, secondChunk } = this.splitAtBestSoftBreak(items, softBreakIndices, totalWidth);
+          const { firstChunk, secondChunk } = this.splitAtBestSoftBreak(items, softBreakIndices, totalWidth, availableWidth);
           if (firstChunk.length === 0) return this.breakContent(secondChunk, availableWidth, line);
           const firstLayout = this.layoutFactory.createLineLayout(firstChunk, line);
           return [
@@ -28762,8 +28830,9 @@ ${template}
             this.layoutFactory.createLineLayout(items, line)
           ];
           if (breakIndex === 0) return this.handleOversizedFirstItem(items, availableWidth, line);
-          const firstChunk = items.slice(0, breakIndex);
-          const secondChunk = items.slice(breakIndex);
+          let firstChunk = items.slice(0, breakIndex);
+          let secondChunk = items.slice(breakIndex);
+          ({ firstChunk, secondChunk } = this.avoidLeadingRhythmSymbol(firstChunk, secondChunk, availableWidth));
           this.removeTrailingComma(firstChunk);
           return [
             this.layoutFactory.createLineLayout(firstChunk, line),
@@ -28822,26 +28891,123 @@ ${template}
         shouldReturnSingleLayout(totalWidth, availableWidth) {
           return totalWidth <= availableWidth;
         }
-        splitAtBestSoftBreak(items, softBreakIndices, totalWidth) {
+        splitAtBestSoftBreak(items, softBreakIndices, totalWidth, availableWidth) {
+          const bestBreak = this.findBestSoftBreak(items, softBreakIndices, totalWidth);
+          const softBreak = items[bestBreak.index];
+          let firstChunk = items.slice(0, bestBreak.index);
+          let secondChunk = items.slice(bestBreak.index + 1);
+          ({ firstChunk, secondChunk } = this.avoidLeadingRhythmSymbol(firstChunk, secondChunk, availableWidth, softBreak));
+          this.removeTrailingComma(firstChunk);
+          this.capitalizeNextItem(secondChunk, secondChunk, 0);
+          return {
+            firstChunk,
+            secondChunk
+          };
+        }
+        findBestSoftBreak(items, softBreakIndices, totalWidth) {
           const targetWidth = totalWidth / 2;
           const breakOptions = softBreakIndices.map((idx) => ({
             index: idx,
             widthUpToBreak: this.getWidthUpToIndex(items, idx)
           }));
-          const bestBreak = breakOptions.reduce((best, current) => {
-            const currentDistance = Math.abs(current.widthUpToBreak - targetWidth);
-            const bestDistance = Math.abs(best.widthUpToBreak - targetWidth);
-            if (currentDistance === bestDistance) return current.index > best.index ? current : best;
-            return currentDistance < bestDistance ? current : best;
-          });
-          const firstChunk = items.slice(0, bestBreak.index);
-          const secondChunk = items.slice(bestBreak.index + 1);
-          this.removeTrailingComma(firstChunk);
-          this.capitalizeNextItem(secondChunk, secondChunk, 0);
-          return {
+          return breakOptions.reduce((best, current) => this.selectBetterSoftBreak(best, current, targetWidth));
+        }
+        selectBetterSoftBreak(best, current, targetWidth) {
+          const currentDistance = Math.abs(current.widthUpToBreak - targetWidth);
+          const bestDistance = Math.abs(best.widthUpToBreak - targetWidth);
+          if (currentDistance === bestDistance) return current.index > best.index ? current : best;
+          return currentDistance < bestDistance ? current : best;
+        }
+        /**
+        * Avoid wrapping a line so that the next visual line starts with a rhythm symbol.
+        *
+        * Prefer keeping the leading rhythm symbol(s) with the previous line, but only
+        * when the previous line still fits. If they do not fit, break earlier by
+        * moving the nearest preceding non-rhythm chord to the next line. Width checks
+        * are recalculated in the final line context so trailing chord-spacing is not
+        * counted for a line-ending rhythm symbol such as `|`.
+        */
+        avoidLeadingRhythmSymbol(firstChunk, secondChunk, availableWidth, separator = null) {
+          if (!this.shouldAvoidLeadingRhythmSymbol(secondChunk)) return {
+            firstChunk,
+            secondChunk
+          };
+          return this.tryMoveLeadingRhythmSymbolsToFirstChunk(firstChunk, secondChunk, availableWidth, separator) || this.movePrecedingChordToSecondChunk(firstChunk, secondChunk, separator);
+        }
+        shouldAvoidLeadingRhythmSymbol(secondChunk) {
+          const leadingRhythmSymbolCount = this.countLeadingRhythmSymbols(secondChunk);
+          return this.startsWithRhythmSymbol(secondChunk) && this.hasChordAfterLeadingRhythmSymbols(secondChunk, leadingRhythmSymbolCount);
+        }
+        tryMoveLeadingRhythmSymbolsToFirstChunk(firstChunk, secondChunk, availableWidth, separator) {
+          const leadingRhythmSymbolCount = this.countLeadingRhythmSymbols(secondChunk);
+          const separatorItems = separator ? [
+            separator
+          ] : [];
+          const laterFirstChunk = [
+            ...firstChunk,
+            ...separatorItems,
+            ...secondChunk.slice(0, leadingRhythmSymbolCount)
+          ];
+          const laterSecondChunk = secondChunk.slice(leadingRhythmSymbolCount);
+          if (this.calculateLineContextWidth(laterFirstChunk) <= availableWidth) return {
+            firstChunk: laterFirstChunk,
+            secondChunk: laterSecondChunk
+          };
+          return null;
+        }
+        movePrecedingChordToSecondChunk(firstChunk, secondChunk, separator) {
+          const precedingChordIndex = this.findLastNonRhythmChordIndex(firstChunk);
+          if (precedingChordIndex <= 0) return {
             firstChunk,
             secondChunk
           };
+          return {
+            firstChunk: firstChunk.slice(0, precedingChordIndex),
+            secondChunk: [
+              ...firstChunk.slice(precedingChordIndex),
+              ...this.separatorItems(separator),
+              ...secondChunk
+            ]
+          };
+        }
+        separatorItems(separator) {
+          return separator ? [
+            separator
+          ] : [];
+        }
+        startsWithRhythmSymbol(items) {
+          return this.isRhythmSymbolItem(items[0]);
+        }
+        countLeadingRhythmSymbols(items) {
+          let count = 0;
+          while (count < items.length && this.isRhythmSymbolItem(items[count])) count += 1;
+          return count;
+        }
+        hasChordAfterLeadingRhythmSymbols(items, leadingRhythmSymbolCount) {
+          return this.isNonRhythmChordItem(items[leadingRhythmSymbolCount]);
+        }
+        findLastNonRhythmChordIndex(items) {
+          for (let index = items.length - 1; index >= 0; index -= 1) {
+            if (this.isNonRhythmChordItem(items[index])) return index;
+          }
+          return -1;
+        }
+        isRhythmSymbolItem(item) {
+          return item?.item instanceof (0, $551a223fc13b5c10$export$2e2bcd8739ae039) && item.item.isRhythmSymbol;
+        }
+        isNonRhythmChordItem(item) {
+          return item?.item instanceof (0, $551a223fc13b5c10$export$2e2bcd8739ae039) && !item.item.isRhythmSymbol && (item.item.chords || "").trim() !== "";
+        }
+        calculateLineContextWidth(items) {
+          return items.reduce((width, item, index) => {
+            const nextItem = items[index + 1] || null;
+            return width + this.recalculateWidthForLineContext(item, nextItem);
+          }, 0);
+        }
+        recalculateWidthForLineContext(item, nextItem) {
+          if (item.item instanceof (0, $551a223fc13b5c10$export$2e2bcd8739ae039)) return this.recalculateChordLyricWidth(item, nextItem);
+          if (!nextItem && item.item instanceof (0, $4b6dd3e4b817bd81$export$2e2bcd8739ae039)) return 0;
+          return item.width;
         }
         removeTrailingComma(items) {
           const lastItem = items[items.length - 1];
@@ -29716,7 +29882,7 @@ ${template}
         }
       };
       var $a5a21ced491ea51f$export$2e2bcd8739ae039 = $a5a21ced491ea51f$var$UltimateGuitarParser;
-      var $ae92e002ce14f11a$export$2e2bcd8739ae039 = "15.5.2";
+      var $ae92e002ce14f11a$export$2e2bcd8739ae039 = "15.6.0-canary.0";
       var $2a7926da41d163b3$export$191a710ad3c9a989 = {
         configure: $181068e44290b873$export$8d21e34596265fa2,
         getDefaultConfig: $fe1d3ba9df1ecad5$export$ed30944e0fe6ae5c,