@hymnbook/abc 0.1.1 → 0.2.0

package/dist/index.cjs

@@ -381,10 +381,10 @@ var processAbcLyrics = (object) => {
     )
   );
 };
-var combineMelodyAndLyrics = (melody, lyrics) => {
+var combineMelodyAndLyrics = (melody, lyrics, options = { trimLines: false }) => {
   const song = new AbcSong();
   const rawMelody = extractInfoFields(melody, song);
-  const melodyLines = rawMelody.replaceAll(/\n+/g, "\n").trim().split("\n");
+  const melodyLines = rawMelody.replaceAll(/\n+/g, "\n").trim().split("\n").map((it) => it.trim()).map((it) => options.trimLines ? it.replaceAll(/(^y+|y+$)*/gi, "").replaceAll(/ *y* *(\|+]*) *y* */gi, " $1 ").trim() : it);
   const lyricLines = lyrics.replaceAll(/\n+/g, "\n").trim().split("\n");
   const mixedMelody = [];
   for (let i = 0; i < Math.max(melodyLines.length, lyricLines.length); i++) {
@@ -399,12 +399,12 @@ var getForVerse = (melody, verse) => melody.subMelodies.find((it) => (
   // `.includes()` won't work due to the Realm data type of `verseUuids`.
   it.verseUuids.some((it2) => it2 == verse.uuid)
 ));
-var generateAbcForVerse = (verse, activeMelody) => {
+var generateAbcForVerse = (verse, activeMelody, options = { trimLines: false }) => {
   if (activeMelody === void 0) {
     return "";
   }
   const melody = getForVerse(activeMelody, verse)?.melody || activeMelody.melody;
-  return combineMelodyAndLyrics(melody, verse.abcLyrics || "");
+  return combineMelodyAndLyrics(melody, verse.abcLyrics || "", options);
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {

package/dist/index.d.cts

@@ -264,8 +264,11 @@ declare const convertStringToAbcTune: (abc: string) => TuneObject;
  * Combine multi line lyrics line with a multi line melody into a single ABC notation string.
  * @param melody
  * @param lyrics
+ * @param options
  */
-declare const combineMelodyAndLyrics: (melody: string, lyrics: string) => string;
+declare const combineMelodyAndLyrics: (melody: string, lyrics: string, options?: {
+    trimLines?: boolean;
+}) => string;
 
 type Verse = {
     uuid: string;
@@ -281,7 +284,16 @@ type AbcMelody = {
 };
 
 declare const getForVerse: (melody: AbcMelody, verse: Verse) => AbcSubMelody | undefined;
-declare const generateAbcForVerse: (verse: Verse, activeMelody?: AbcMelody) => string;
+/**
+ * Combine an ABC melody with the lyrics of a verse into a single ABC notation string.
+ *
+ * @param verse
+ * @param activeMelody - The active melody to use. The method returns an empty string if this is undefined.
+ * @param options { trimLines?: boolean } - Whether to trim `y` spacers from start/end of lines.
+ */
+declare const generateAbcForVerse: (verse: Verse, activeMelody?: AbcMelody, options?: {
+    trimLines?: boolean;
+}) => string;
 
 declare class ValidationError extends Error {
 }

package/dist/index.d.ts

@@ -264,8 +264,11 @@ declare const convertStringToAbcTune: (abc: string) => TuneObject;
  * Combine multi line lyrics line with a multi line melody into a single ABC notation string.
  * @param melody
  * @param lyrics
+ * @param options
  */
-declare const combineMelodyAndLyrics: (melody: string, lyrics: string) => string;
+declare const combineMelodyAndLyrics: (melody: string, lyrics: string, options?: {
+    trimLines?: boolean;
+}) => string;
 
 type Verse = {
     uuid: string;
@@ -281,7 +284,16 @@ type AbcMelody = {
 };
 
 declare const getForVerse: (melody: AbcMelody, verse: Verse) => AbcSubMelody | undefined;
-declare const generateAbcForVerse: (verse: Verse, activeMelody?: AbcMelody) => string;
+/**
+ * Combine an ABC melody with the lyrics of a verse into a single ABC notation string.
+ *
+ * @param verse
+ * @param activeMelody - The active melody to use. The method returns an empty string if this is undefined.
+ * @param options { trimLines?: boolean } - Whether to trim `y` spacers from start/end of lines.
+ */
+declare const generateAbcForVerse: (verse: Verse, activeMelody?: AbcMelody, options?: {
+    trimLines?: boolean;
+}) => string;
 
 declare class ValidationError extends Error {
 }

package/dist/index.js

@@ -333,10 +333,10 @@ var processAbcLyrics = (object) => {
     )
   );
 };
-var combineMelodyAndLyrics = (melody, lyrics) => {
+var combineMelodyAndLyrics = (melody, lyrics, options = { trimLines: false }) => {
   const song = new AbcSong();
   const rawMelody = extractInfoFields(melody, song);
-  const melodyLines = rawMelody.replaceAll(/\n+/g, "\n").trim().split("\n");
+  const melodyLines = rawMelody.replaceAll(/\n+/g, "\n").trim().split("\n").map((it) => it.trim()).map((it) => options.trimLines ? it.replaceAll(/(^y+|y+$)*/gi, "").replaceAll(/ *y* *(\|+]*) *y* */gi, " $1 ").trim() : it);
   const lyricLines = lyrics.replaceAll(/\n+/g, "\n").trim().split("\n");
   const mixedMelody = [];
   for (let i = 0; i < Math.max(melodyLines.length, lyricLines.length); i++) {
@@ -351,12 +351,12 @@ var getForVerse = (melody, verse) => melody.subMelodies.find((it) => (
   // `.includes()` won't work due to the Realm data type of `verseUuids`.
   it.verseUuids.some((it2) => it2 == verse.uuid)
 ));
-var generateAbcForVerse = (verse, activeMelody) => {
+var generateAbcForVerse = (verse, activeMelody, options = { trimLines: false }) => {
   if (activeMelody === void 0) {
     return "";
   }
   const melody = getForVerse(activeMelody, verse)?.melody || activeMelody.melody;
-  return combineMelodyAndLyrics(melody, verse.abcLyrics || "");
+  return combineMelodyAndLyrics(melody, verse.abcLyrics || "", options);
 };
 export {
   AbcSong,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hymnbook/abc",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "",
   "type": "module",
   "main": "./dist/index.js",
@@ -9,10 +9,11 @@
   "scripts": {
     "test": "node --experimental-vm-modules node_modules/.bin/jest",
     "build": "tsup",
-    "publish": "npm run test && npm run build && npm publish --access public",
-    "publish-patch": "npm version patch && npm run publish",
-    "publish-minor": "npm version minor && npm run publish",
-    "publish-major": "npm version major && npm run publish"
+    "link": "npm run build && rm -f /Users/samuel/workspace/js/hymnbook2/node_modules/@hymnbook/abc/dist/*; ln /Users/samuel/workspace/js/hymnbook-abc/dist/* /Users/samuel/workspace/js/hymnbook2/node_modules/@hymnbook/abc/dist/",
+    "build-publish": "npm run build && npm publish --access public",
+    "publish-patch": "npm run test && npm version patch && npm run build-publish",
+    "publish-minor": "npm run test && npm version minor && npm run build-publish",
+    "publish-major": "npm run test && npm version major && npm run build-publish"
   },
   "repository": {
     "type": "git",

package/src/based.ts

@@ -7,13 +7,21 @@ export const getForVerse = (melody: AbcMelody, verse: Verse): AbcSubMelody | und
     // `.includes()` won't work due to the Realm data type of `verseUuids`.
     it.verseUuids.some(it => it == verse.uuid));
 
+/**
+ * Combine an ABC melody with the lyrics of a verse into a single ABC notation string.
+ *
+ * @param verse
+ * @param activeMelody - The active melody to use. The method returns an empty string if this is undefined.
+ * @param options { trimLines?: boolean } - Whether to trim `y` spacers from start/end of lines.
+ */
 export const generateAbcForVerse = (
   verse: Verse,
-  activeMelody?: AbcMelody
+  activeMelody?: AbcMelody,
+  options: { trimLines?: boolean } = { trimLines: false },
 ): string => {
   if (activeMelody === undefined) {
     return "";
   }
   const melody = getForVerse(activeMelody, verse)?.melody || activeMelody.melody;
-  return combineMelodyAndLyrics(melody, verse.abcLyrics || "")
+  return combineMelodyAndLyrics(melody, verse.abcLyrics || "", options)
 };

package/src/parser.ts

@@ -247,8 +247,13 @@ const processAbcLyrics = (object: Array<TuneObject>) => {
  * Combine multi line lyrics line with a multi line melody into a single ABC notation string.
  * @param melody
  * @param lyrics
+ * @param options
  */
-export const combineMelodyAndLyrics = (melody: string, lyrics: string): string => {
+export const combineMelodyAndLyrics = (
+  melody: string,
+  lyrics: string,
+  options: { trimLines?: boolean } = { trimLines: false },
+): string => {
   const song = new AbcSong();
   const rawMelody = extractInfoFields(melody, song);
 
@@ -256,6 +261,13 @@ export const combineMelodyAndLyrics = (melody: string, lyrics: string): string =
     .replaceAll(/\n+/g, "\n")
     .trim()
     .split("\n")
+    .map(it => it.trim())
+    .map(it => options.trimLines
+      ? it
+        .replaceAll(/(^y+|y+$)*/gi, "")
+        .replaceAll(/ *y* *(\|+]*) *y* */gi, " $1 ")
+        .trim()
+      : it);
   const lyricLines = lyrics
     .replaceAll(/\n+/g, "\n")
     .trim()