chordsheetjs 6.0.0 → 6.0.2

package/.husky/pre-commit

@@ -0,0 +1,5 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+yarn readme
+git add README.md

package/README.md

@@ -466,6 +466,9 @@ Inherits from <a href="#ChordSheetParser">ChordSheetParser</a></p>
 <dt><a href="#TITLE">TITLE</a> : <code>string</code></dt>
 <dd><p>Title meta directive. See <a href="https://www.chordpro.org/chordpro/directives-title/">https://www.chordpro.org/chordpro/directives-title/</a></p>
 </dd>
+<dt><a href="#TRANSPOSE">TRANSPOSE</a> : <code>string</code></dt>
+<dd><p>Transpose meta directive. See: <a href="https://www.chordpro.org/chordpro/directives-transpose/">https://www.chordpro.org/chordpro/directives-transpose/</a></p>
+</dd>
 <dt><a href="#YEAR">YEAR</a> : <code>string</code></dt>
 <dd><p>Year meta directive. See <a href="https://www.chordpro.org/chordpro/directives-year/">https://www.chordpro.org/chordpro/directives-year/</a></p>
 </dd>
@@ -1176,8 +1179,11 @@ Represents a Chord, consisting of a root, suffix (quality) and bass
         * [.toChordSymbolString(key)](#Chord+toChordSymbolString) ⇒ <code>string</code>
         * [.isChordSymbol()](#Chord+isChordSymbol) ⇒ <code>boolean</code>
         * [.toNumeric(key)](#Chord+toNumeric) ⇒ [<code>Chord</code>](#Chord)
+        * [.toNumeral(key)](#Chord+toNumeral) ⇒ [<code>Chord</code>](#Chord)
+        * [.toNumeralString(key)](#Chord+toNumeralString) ⇒ <code>string</code>
         * [.isNumeric()](#Chord+isNumeric) ⇒ <code>boolean</code>
         * [.toNumericString(key)](#Chord+toNumericString) ⇒ <code>string</code>
+        * [.isNumeral()](#Chord+isNumeral) ⇒ <code>boolean</code>
         * [.toString()](#Chord+toString) ⇒ <code>string</code>
         * [.normalize()](#Chord+normalize) ⇒ [<code>Chord</code>](#Chord)
         * [.useModifier(newModifier)](#Chord+useModifier) ⇒ [<code>Chord</code>](#Chord)
@@ -1231,7 +1237,7 @@ Determines whether the chord is a chord symbol
 <a name="Chord+toNumeric"></a>
 
 ### chord.toNumeric(key) ⇒ [<code>Chord</code>](#Chord)
-Converts the chord to a numeric chord, using the supplied kye as a reference.
+Converts the chord to a numeric chord, using the supplied key as a reference.
 For example, a chord symbol A# with reference key E will return the numeric chord #4.
 
 **Kind**: instance method of [<code>Chord</code>](#Chord)  
@@ -1241,6 +1247,33 @@ For example, a chord symbol A# with reference key E will return the numeric chor
 | --- | --- | --- |
 | key | <code>Key</code> \| <code>string</code> | the reference key |
 
+<a name="Chord+toNumeral"></a>
+
+### chord.toNumeral(key) ⇒ [<code>Chord</code>](#Chord)
+Converts the chord to a numeral chord, using the supplied key as a reference.
+For example, a chord symbol A# with reference key E will return the numeral chord #IV.
+
+**Kind**: instance method of [<code>Chord</code>](#Chord)  
+**Returns**: [<code>Chord</code>](#Chord) - the numeral chord  
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| key | <code>Key</code> \| <code>string</code> \| <code>null</code> | <code></code> | the reference key. The key is required when converting a chord symbol |
+
+<a name="Chord+toNumeralString"></a>
+
+### chord.toNumeralString(key) ⇒ <code>string</code>
+Converts the chord to a numeral chord string, using the supplied kye as a reference.
+For example, a chord symbol A# with reference key E will return the numeral chord #4.
+
+**Kind**: instance method of [<code>Chord</code>](#Chord)  
+**Returns**: <code>string</code> - the numeral chord string  
+**See**: {toNumeral}  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| key | <code>Key</code> \| <code>string</code> | the reference key |
+
 <a name="Chord+isNumeric"></a>
 
 ### chord.isNumeric() ⇒ <code>boolean</code>
@@ -1261,6 +1294,12 @@ For example, a chord symbol A# with reference key E will return the numeric chor
 | --- | --- | --- |
 | key | <code>Key</code> \| <code>string</code> | the reference key |
 
+<a name="Chord+isNumeral"></a>
+
+### chord.isNumeral() ⇒ <code>boolean</code>
+Determines whether the chord is a numeral
+
+**Kind**: instance method of [<code>Chord</code>](#Chord)  
 <a name="Chord+toString"></a>
 
 ### chord.toString() ⇒ <code>string</code>
@@ -1271,7 +1310,7 @@ Converts the chord to a string, eg `Esus4/G#` or `1sus4/#3`
 <a name="Chord+normalize"></a>
 
 ### chord.normalize() ⇒ [<code>Chord</code>](#Chord)
-Normalizes the chord:
+Normalizes the chord root and bass notes:
 - Fb becomes E
 - Cb becomes B
 - B# becomes C
@@ -1281,7 +1320,8 @@ Normalizes the chord:
 - 7# becomes 1
 - 3# becomes 4
 
-If the chord is already normalized, this will return a copy.
+Besides that it normalizes the suffix. For example, `sus2` becomes `2`, `sus4` becomes `sus`.
+All suffix normalizations can be found in `src/normalize_mappings/suffix-mapping.txt`.
 
 **Kind**: instance method of [<code>Chord</code>](#Chord)  
 **Returns**: [<code>Chord</code>](#Chord) - the normalized chord  
@@ -1484,6 +1524,12 @@ Time meta directive. See https://www.chordpro.org/chordpro/directives-time/
 ## TITLE : <code>string</code>
 Title meta directive. See https://www.chordpro.org/chordpro/directives-title/
 
+**Kind**: global constant  
+<a name="TRANSPOSE"></a>
+
+## TRANSPOSE : <code>string</code>
+Transpose meta directive. See: https://www.chordpro.org/chordpro/directives-transpose/
+
 **Kind**: global constant  
 <a name="YEAR"></a>
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "chordsheetjs",
   "author": "Martijn Versluis",
-  "version": "6.0.0",
+  "version": "6.0.2",
   "description": "A JavaScript library for parsing and formatting chord sheets",
   "main": "lib/index.js",
   "license": "GPL-2.0-only",
@@ -23,9 +23,11 @@
     "eslint": "^8.3.0",
     "eslint-config-airbnb-base": "^15.0.0",
     "eslint-plugin-import": "^2.21.2",
+    "husky": "^7.0.0",
     "jest": "^27.0.1",
     "jsdoc-to-markdown": "^7.1.0",
     "pegjs": "^0.10.0",
+    "pinst": "^2.1.6",
     "print": "^1.2.0"
   },
   "scripts": {
@@ -41,8 +43,11 @@
     "lint": "yarn build:code-generate && node_modules/.bin/eslint --ext .js .",
     "lint:fix": "node_modules/.bin/eslint --fix --ext .js .",
     "readme": "jsdoc2md -f src/**/*.js -f src/*.js --template doc/README.hbs > README.md",
-    "prepublishOnly": "yarn install && yarn test && yarn build",
-    "pretest": "yarn build:code-generate"
+    "prepublishOnly": "pinst --disable && yarn install && yarn test && yarn build",
+    "postpublish": "pinst --enable",
+    "pretest": "yarn build:code-generate",
+    "prepare": "husky install",
+    "_postinstall": "husky install"
   },
   "dependencies": {
     "handlebars": "^4.7.6"

package/d7b54993c4ea66c07a35bd36690482ab620f836e.patch

@@ -1,105 +0,0 @@
-commit d7b54993c4ea66c07a35bd36690482ab620f836e
-Author: Martijn Versluis <martijnversluis@users.noreply.github.com>
-Date:   Sun Jan 30 16:35:24 2022 +0100
-
-    Do not rely on contructor name
-    
-    Due to build tools scrambling constructor names, we can not rely on those
-    for type checking. Thus we have to use `instanceof`. This change removes
-    usages of `constructor.name` and solves the cyclic dependency by moving around
-    some functions.
-    
-    Resolves #421
-
-diff --git a/src/formatter/html_div_formatter.js b/src/formatter/html_div_formatter.js
-index f92f532..b1de230 100644
---- a/src/formatter/html_div_formatter.js
-+++ b/src/formatter/html_div_formatter.js
-@@ -1,6 +1,6 @@
- import Handlebars from 'handlebars';
- 
--import '../handlebars_helpers';
-+import '../template_helpers';
- import HtmlFormatter from './html_formatter';
- import './templates/html_div_formatter';
- import { scopeCss } from '../utilities';
-diff --git a/src/formatter/html_table_formatter.js b/src/formatter/html_table_formatter.js
-index 4883fef..7d7e8ea 100644
---- a/src/formatter/html_table_formatter.js
-+++ b/src/formatter/html_table_formatter.js
-@@ -1,6 +1,6 @@
- import Handlebars from 'handlebars';
- 
--import '../handlebars_helpers';
-+import '../template_helpers';
- import HtmlFormatter from './html_formatter';
- import './templates/html_table_formatter';
- import { scopeCss } from '../utilities';
-diff --git a/src/formatter/text_formatter.js b/src/formatter/text_formatter.js
-index 61385f1..81fe226 100644
---- a/src/formatter/text_formatter.js
-+++ b/src/formatter/text_formatter.js
-@@ -1,10 +1,10 @@
- import ChordLyricsPair from '../chord_sheet/chord_lyrics_pair';
- import Tag from '../chord_sheet/tag';
- import { renderChord } from '../helpers';
-+import { hasTextContents } from '../template_helpers';
- 
- import {
-   hasChordContents,
--  hasTextContents,
-   padLeft,
- } from '../utilities';
- 
-diff --git a/src/handlebars_helpers.js b/src/template_helpers.js
-similarity index 87%
-rename from src/handlebars_helpers.js
-rename to src/template_helpers.js
-index 0e5ff98..b330f87 100644
---- a/src/handlebars_helpers.js
-+++ b/src/template_helpers.js
-@@ -7,12 +7,20 @@ import { renderChord } from './helpers';
- 
- import {
-   hasChordContents,
--  hasTextContents,
-   isEvaluatable,
- } from './utilities';
- 
- const lineHasContents = (line) => line.items.some((item) => item.isRenderable());
- 
-+/* eslint import/prefer-default-export: 0 */
-+export const hasTextContents = (line) => (
-+  line.items.some((item) => (
-+    (item instanceof ChordLyricsPair && item.lyrics)
-+    || (item instanceof Tag && item.isRenderable())
-+    || isEvaluatable(item)
-+  ))
-+);
-+
- HandleBars.registerHelper('isChordLyricsPair', (item) => item instanceof ChordLyricsPair);
- 
- HandleBars.registerHelper('isTag', (item) => item instanceof Tag);
-diff --git a/src/utilities.js b/src/utilities.js
-index 03c69cc..503c811 100644
---- a/src/utilities.js
-+++ b/src/utilities.js
-@@ -8,18 +8,6 @@ export const hasChordContents = (line) => line.items.some((item) => !!item.chord
- 
- export const isEvaluatable = (item) => typeof item.evaluate === 'function';
- 
--function isInstanceOf(object, constructorName) {
--  return object?.constructor?.name === constructorName;
--}
--
--export const hasTextContents = (line) => (
--  line.items.some((item) => (
--    (isInstanceOf(item, 'ChordLyricsPair') && item.lyrics)
--      || (isInstanceOf(item, 'Tag') && item.isRenderable())
--      || isEvaluatable(item)
--  ))
--);
--
- export const padLeft = (str, length) => {
-   let paddedString = str;
-   for (let l = str.length; l < length; l += 1, paddedString += ' ');