Test and export templateHelpers

Usage: ```javascript import templateHelpers from 'chordsheetjs'; const { isChordLyricsPair, lineHasContents, isTag, isComment, stripHTML, each, when, hasTextContents, lineClasses, paragraphClasses, evaluate, fontStyleTag, } = templateHelpers; ``` Resolves #934
martijnversluis · Aug 31, 2023 · 6e1ff35 · 6e1ff35
1 parent 78602f1
commit 6e1ff35
Show file tree

Hide file tree

Showing 6 changed files with 325 additions and 18 deletions.
diff --git a/src/formatter/templates/html_div_formatter.ts b/src/formatter/templates/html_div_formatter.ts
@@ -3,11 +3,12 @@ import { renderChord } from '../../helpers';
 
 import {
   each,
-  evaluate, fontStyleTag,
+  evaluate,
+  fontStyleTag,
   isChordLyricsPair,
   isComment,
   isEvaluatable,
-  isTag, keep,
+  isTag,
   lineClasses,
   lineHasContents,
   paragraphClasses,

diff --git a/src/index.ts b/src/index.ts
@@ -18,6 +18,22 @@ import Ternary from './chord_sheet/chord_pro/ternary';
 import TextFormatter from './formatter/text_formatter';
 import UltimateGuitarParser from './parser/ultimate_guitar_parser';
 
+import {
+  isEvaluatable,
+  isChordLyricsPair,
+  lineHasContents,
+  isTag,
+  isComment,
+  stripHTML,
+  each,
+  when,
+  hasTextContents,
+  lineClasses,
+  paragraphClasses,
+  evaluate,
+  fontStyleTag,
+} from './template_helpers';
+
 import {
   CHORUS,
   INDETERMINATE,
@@ -51,6 +67,22 @@ export { default as Ternary } from './chord_sheet/chord_pro/ternary';
 export { default as TextFormatter } from './formatter/text_formatter';
 export { default as UltimateGuitarParser } from './parser/ultimate_guitar_parser';
 
+export const templateHelpers = {
+  isEvaluatable,
+  isChordLyricsPair,
+  lineHasContents,
+  isTag,
+  isComment,
+  stripHTML,
+  each,
+  when,
+  hasTextContents,
+  lineClasses,
+  paragraphClasses,
+  evaluate,
+  fontStyleTag,
+};
+
 export {
   CHORUS,
   INDETERMINATE,
@@ -87,4 +119,5 @@ export default {
   NONE,
   TAB,
   VERSE,
+  templateHelpers,
 };
diff --git a/src/template_helpers.ts b/src/template_helpers.ts
@@ -18,10 +18,6 @@ interface WhenCallback {
   (): string;
 }
 
-interface KeepCallback {
-  (_items: any[]): string;
-}
-
 export { isEvaluatable } from './utilities';
 
 export const isChordLyricsPair = (item: Item): boolean => item instanceof ChordLyricsPair;
@@ -44,10 +40,6 @@ export function when(condition: any, callback: WhenCallback): string {
   return condition ? callback() : '';
 }
 
-export function keep(variables: any[], callback: KeepCallback): string {
-  return callback.call(null, variables);
-}
-
 export const hasTextContents = (line: Line): boolean => (
   line.items.some((item) => (
     (item instanceof ChordLyricsPair && !isEmptyString(item.lyrics))
@@ -76,13 +68,9 @@ export const paragraphClasses = (paragraph: Paragraph): string => {
   return classes.join(' ');
 };
 
-export const evaluate = (item: Evaluatable, metadata: Metadata, configuration: Configuration): string => {
-  if (!metadata) {
-    throw new Error('cannot evaluate, metadata is null');
-  }
-
-  return item.evaluate(metadata, configuration.get('metadata.separator'));
-};
+export const evaluate = (item: Evaluatable, metadata: Metadata, configuration: Configuration): string => (
+  item.evaluate(metadata, configuration.get('metadata.separator'))
+);
 
 export function fontStyleTag(font: Font) {
   const cssString = font.toCssString();

diff --git a/test/default_export.test.ts b/test/default_export.test.ts
@@ -24,6 +24,7 @@ describe('default export', () => {
     'INDETERMINATE',
     'VERSE',
     'NONE',
+    'templateHelpers',
   ].forEach((constantName) => {
     it(`contains ${constantName}`, () => {
       expect(typeof chordsheetjs[constantName]).not.toEqual('undefined');

diff --git a/test/parser/chord_pro_parser.test.ts b/test/parser/chord_pro_parser.test.ts
@@ -3,7 +3,8 @@ import {
   CHORUS,
   NONE,
   VERSE,
-  TAB, Ternary,
+  TAB,
+  Ternary,
 } from '../../src';
 
 import '../matchers';