chordsheetjs 5.3.0 → 6.1.0

package/lib/chord_sheet/tag.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports["default"] = exports._KEY = exports.YEAR = exports.TRANSPOSE = exports.TITLE = exports.TIME = exports.TEMPO = exports.SUBTITLE = exports.START_OF_VERSE = exports.START_OF_TAB = exports.START_OF_CHORUS = exports.READ_ONLY_TAGS = exports.META_TAGS = exports.LYRICIST = exports.KEY = exports.END_OF_VERSE = exports.END_OF_TAB = exports.END_OF_CHORUS = exports.DURATION = exports.COPYRIGHT = exports.COMPOSER = exports.COMMENT = exports.CAPO = exports.ARTIST = exports.ALBUM = void 0;
+exports["default"] = exports._KEY = exports.YEAR = exports.TRANSPOSE = exports.TITLE = exports.TIME = exports.TEMPO = exports.SUBTITLE = exports.START_OF_VERSE = exports.START_OF_TAB = exports.START_OF_CHORUS = exports.READ_ONLY_TAGS = exports.NEW_KEY = exports.META_TAGS = exports.LYRICIST = exports.KEY = exports.END_OF_VERSE = exports.END_OF_TAB = exports.END_OF_CHORUS = exports.DURATION = exports.COPYRIGHT = exports.COMPOSER = exports.COMMENT = exports.CAPO = exports.ARTIST = exports.ALBUM = void 0;
 exports.isReadonlyTag = isReadonlyTag;
 
 var _ALIASES;
@@ -162,11 +162,18 @@ var TITLE = 'title';
 exports.TITLE = TITLE;
 var TRANSPOSE = 'transpose';
 /**
- * Year meta directive. See https://www.chordpro.org/chordpro/directives-year/
+ * New Key meta directive. See: https://github.com/PraiseCharts/ChordChartJS/issues/53
  * @type {string}
  */
 
 exports.TRANSPOSE = TRANSPOSE;
+var NEW_KEY = 'new_key';
+/**
+ * Year meta directive. See https://www.chordpro.org/chordpro/directives-year/
+ * @type {string}
+ */
+
+exports.NEW_KEY = NEW_KEY;
 var YEAR = 'year';
 exports.YEAR = YEAR;
 var TITLE_SHORT = 't';
@@ -176,12 +183,13 @@ var START_OF_CHORUS_SHORT = 'soc';
 var END_OF_CHORUS_SHORT = 'eoc';
 var START_OF_TAB_SHORT = 'sot';
 var END_OF_TAB_SHORT = 'eot';
+var NEW_KEY_SHORT = 'nk';
 var RENDERABLE_TAGS = [COMMENT];
 var META_TAGS = [ALBUM, ARTIST, CAPO, COMPOSER, COPYRIGHT, DURATION, KEY, LYRICIST, TEMPO, TIME, TITLE, SUBTITLE, YEAR];
 exports.META_TAGS = META_TAGS;
 var READ_ONLY_TAGS = [_KEY];
 exports.READ_ONLY_TAGS = READ_ONLY_TAGS;
-var ALIASES = (_ALIASES = {}, _defineProperty(_ALIASES, TITLE_SHORT, TITLE), _defineProperty(_ALIASES, SUBTITLE_SHORT, SUBTITLE), _defineProperty(_ALIASES, COMMENT_SHORT, COMMENT), _defineProperty(_ALIASES, START_OF_CHORUS_SHORT, START_OF_CHORUS), _defineProperty(_ALIASES, END_OF_CHORUS_SHORT, END_OF_CHORUS), _defineProperty(_ALIASES, START_OF_TAB_SHORT, START_OF_TAB), _defineProperty(_ALIASES, END_OF_TAB_SHORT, END_OF_TAB), _ALIASES);
+var ALIASES = (_ALIASES = {}, _defineProperty(_ALIASES, TITLE_SHORT, TITLE), _defineProperty(_ALIASES, SUBTITLE_SHORT, SUBTITLE), _defineProperty(_ALIASES, COMMENT_SHORT, COMMENT), _defineProperty(_ALIASES, START_OF_CHORUS_SHORT, START_OF_CHORUS), _defineProperty(_ALIASES, END_OF_CHORUS_SHORT, END_OF_CHORUS), _defineProperty(_ALIASES, START_OF_TAB_SHORT, START_OF_TAB), _defineProperty(_ALIASES, END_OF_TAB_SHORT, END_OF_TAB), _defineProperty(_ALIASES, NEW_KEY_SHORT, NEW_KEY), _ALIASES);
 var META_TAG_REGEX = /^meta:\s*([^:\s]+)(\s*(.+))?$/;
 var TAG_REGEX = /^([^:\s]+)(:?\s*(.+))?$/;
 var CUSTOM_META_TAG_NAME_REGEX = /^x_(.+)$/;
@@ -263,7 +271,7 @@ var Tag = /*#__PURE__*/function () {
      */
     function get() {
       if (this._value) {
-        return this._value.trim();
+        return "".concat(this._value).trim();
       }
 
       return this._value || null;
@@ -309,13 +317,19 @@ var Tag = /*#__PURE__*/function () {
   }, {
     key: "clone",
     value: function clone() {
-      return new Tag(this.name, this.value);
+      return new Tag(this._originalName, this.value);
     }
   }, {
     key: "toString",
     value: function toString() {
       return "Tag(name=".concat(this.name, ", value=").concat(this.name, ")");
     }
+  }, {
+    key: "set",
+    value: function set(_ref2) {
+      var value = _ref2.value;
+      return new Tag(this._originalName, value);
+    }
   }], [{
     key: "parse",
     value: function parse(tag) {

package/lib/formatter/templates/html_div_formatter.js

@@ -379,7 +379,7 @@ templates['html_div_formatter'] = template({
       return undefined;
     };
 
-    return "<div class=\"column\"><div class=\"chord\">" + alias3((lookupProperty(helpers, "renderChord") || depth0 && lookupProperty(depth0, "renderChord") || alias2).call(alias1, depth0 != null ? lookupProperty(depth0, "chords") : depth0, (stack1 = blockParams[3][0]) != null ? lookupProperty(stack1, "key") : stack1, (stack1 = (stack1 = data && lookupProperty(data, "root")) && lookupProperty(stack1, "song")) && lookupProperty(stack1, "key"), {
+    return "<div class=\"column\"><div class=\"chord\">" + alias3((lookupProperty(helpers, "renderChord") || depth0 && lookupProperty(depth0, "renderChord") || alias2).call(alias1, depth0 != null ? lookupProperty(depth0, "chords") : depth0, (stack1 = blockParams[3][0]) != null ? lookupProperty(stack1, "key") : stack1, (stack1 = blockParams[3][0]) != null ? lookupProperty(stack1, "transposeKey") : stack1, (stack1 = data && lookupProperty(data, "root")) && lookupProperty(stack1, "song"), {
       "name": "renderChord",
       "hash": {},
       "data": data,
@@ -391,7 +391,7 @@ templates['html_div_formatter'] = template({
         },
         "end": {
           "line": 18,
-          "column": 103
+          "column": 117
         }
       }
     })) + "</div><div class=\"lyrics\">" + alias3((helper = (helper = lookupProperty(helpers, "lyrics") || (depth0 != null ? lookupProperty(depth0, "lyrics") : depth0)) != null ? helper : alias2, typeof helper === "function" ? helper.call(alias1, {
@@ -402,11 +402,11 @@ templates['html_div_formatter'] = template({
       "loc": {
         "start": {
           "line": 18,
-          "column": 129
+          "column": 143
         },
         "end": {
           "line": 18,
-          "column": 139
+          "column": 153
         }
       }
     }) : helper)) + "</div></div>";

package/lib/formatter/templates/html_table_formatter.js

@@ -416,7 +416,7 @@ templates['html_table_formatter'] = template({
       return undefined;
     };
 
-    return "<td class=\"chord\">" + container.escapeExpression((lookupProperty(helpers, "renderChord") || depth0 && lookupProperty(depth0, "renderChord") || container.hooks.helperMissing).call(depth0 != null ? depth0 : container.nullContext || {}, depth0 != null ? lookupProperty(depth0, "chords") : depth0, (stack1 = blockParams[4][0]) != null ? lookupProperty(stack1, "key") : stack1, (stack1 = (stack1 = data && lookupProperty(data, "root")) && lookupProperty(stack1, "song")) && lookupProperty(stack1, "key"), {
+    return "<td class=\"chord\">" + container.escapeExpression((lookupProperty(helpers, "renderChord") || depth0 && lookupProperty(depth0, "renderChord") || container.hooks.helperMissing).call(depth0 != null ? depth0 : container.nullContext || {}, depth0 != null ? lookupProperty(depth0, "chords") : depth0, (stack1 = blockParams[4][0]) != null ? lookupProperty(stack1, "key") : stack1, (stack1 = blockParams[4][0]) != null ? lookupProperty(stack1, "transposeKey") : stack1, (stack1 = data && lookupProperty(data, "root")) && lookupProperty(stack1, "song"), {
       "name": "renderChord",
       "hash": {},
       "data": data,
@@ -428,7 +428,7 @@ templates['html_table_formatter'] = template({
         },
         "end": {
           "line": 21,
-          "column": 88
+          "column": 102
         }
       }
     })) + "</td>";

package/lib/formatter/text_formatter.js

@@ -115,7 +115,7 @@ var TextFormatter = /*#__PURE__*/function () {
   }, {
     key: "chordLyricsPairLength",
     value: function chordLyricsPairLength(chordLyricsPair, line) {
-      var chords = (0, _helpers.renderChord)(chordLyricsPair.chords, line.key, this.song.key);
+      var chords = (0, _helpers.renderChord)(chordLyricsPair.chords, line.key, line.transposeKey, this.song);
       var lyrics = chordLyricsPair.lyrics;
       var chordsLength = (chords || '').length;
       var lyricsLength = (lyrics || '').length;
@@ -134,7 +134,7 @@ var TextFormatter = /*#__PURE__*/function () {
       }
 
       if (item instanceof _chord_lyrics_pair["default"]) {
-        var chords = (0, _helpers.renderChord)(item.chords, line.key, this.song.key);
+        var chords = (0, _helpers.renderChord)(item.chords, line.key, line.transposeKey, this.song);
         return (0, _utilities.padLeft)(chords, this.chordLyricsPairLength(item, line));
       }
 

package/lib/helpers.js

@@ -4,6 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.renderChord = renderChord;
+exports.transposeDistance = transposeDistance;
 
 var _chord = _interopRequireDefault(require("./chord"));
 
@@ -13,20 +14,43 @@ var _key = _interopRequireDefault(require("./key"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
 
-function transposeDistance(lineKey, songKey) {
-  if (/^\d+$/.test(lineKey)) {
-    return parseInt(lineKey, 10);
+function transposeDistance(transposeKey, songKey) {
+  if (/^\d+$/.test(transposeKey)) {
+    return parseInt(transposeKey, 10);
   }
 
-  return _key["default"].distance(songKey, lineKey);
+  return _key["default"].distance(songKey, transposeKey);
 }
-/* eslint import/prefer-default-export: 0 */
 
+function chordTransposeDistance(capo, transposeKey, songKey) {
+  var transpose = -1 * (capo || 0);
 
-function renderChord(chord, lineKey, songKey) {
-  if ((0, _utilities.presence)(chord) && (0, _utilities.presence)(lineKey) && (0, _utilities.presence)(songKey)) {
-    return _chord["default"].parse(chord).transpose(transposeDistance(lineKey, songKey)).useModifier(lineKey.modifier).toString();
+  if ((0, _utilities.isPresent)(transposeKey) && (0, _utilities.isPresent)(songKey)) {
+    transpose += transposeDistance(transposeKey, songKey);
   }
 
-  return chord;
+  return transpose;
+}
+
+function renderChord(chord, lineKey, transposeKey, song) {
+  var chordObj = _chord["default"].parse(chord);
+
+  var capo = song.capo,
+      songKey = song.key;
+
+  if (!chordObj) {
+    return chord;
+  }
+
+  chordObj = chordObj.transpose(chordTransposeDistance(capo, transposeKey, songKey));
+
+  if ((0, _utilities.isPresent)(transposeKey)) {
+    chordObj = chordObj.useModifier(transposeKey.modifier);
+  }
+
+  if ((0, _utilities.isPresent)(lineKey)) {
+    chordObj = chordObj.normalize(lineKey);
+  }
+
+  return chordObj.toString();
 }

package/lib/key.js

@@ -11,6 +11,8 @@ var _note = _interopRequireDefault(require("./note"));
 
 var _constants = require("./constants");
 
+var _enharmonicNormalize = _interopRequireDefault(require("./normalize_mappings/enharmonic-normalize"));
+
 var _MODIFIER_TRANSPOSITI;
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
@@ -43,14 +45,16 @@ var FLAT = 'b';
 var SHARP = '#';
 var MODIFIER_TRANSPOSITION = (_MODIFIER_TRANSPOSITI = {}, _defineProperty(_MODIFIER_TRANSPOSITI, SHARP, 1), _defineProperty(_MODIFIER_TRANSPOSITI, FLAT, -1), _MODIFIER_TRANSPOSITI);
 
-var symbolKeyRegex = /*#__PURE__*/_wrapRegExp(/^([A-G])(#|b)?$/i, {
+var symbolKeyRegex = /*#__PURE__*/_wrapRegExp(/^([A-G])(#|b)?(m)?$/i, {
   note: 1,
-  modifier: 2
+  modifier: 2,
+  minor: 3
 });
 
-var numericKeyRegex = /*#__PURE__*/_wrapRegExp(/^(#|b)?([1-7])$/, {
+var numericKeyRegex = /*#__PURE__*/_wrapRegExp(/^(#|b)?([1-7])(m)?$/, {
   modifier: 1,
-  note: 2
+  note: 2,
+  minor: 3
 });
 
 var numeralKeyRegex = /*#__PURE__*/_wrapRegExp(/^(#|b)?(I{1,3}|IV|VI{0,2}|i{1,3}|iv|vi{0,2})$/, {
@@ -66,7 +70,9 @@ var Key = /*#__PURE__*/function () {
   function Key(_ref) {
     var note = _ref.note,
         _ref$modifier = _ref.modifier,
-        modifier = _ref$modifier === void 0 ? null : _ref$modifier;
+        modifier = _ref$modifier === void 0 ? null : _ref$modifier,
+        _ref$minor = _ref.minor,
+        minor = _ref$minor === void 0 ? false : _ref$minor;
 
     _classCallCheck(this, Key);
 
@@ -74,6 +80,7 @@ var Key = /*#__PURE__*/function () {
 
     this.note = note instanceof _note["default"] ? note : _note["default"].parse(note);
     this.modifier = modifier || null;
+    this.minor = !!minor || false;
   }
 
   _createClass(Key, [{
@@ -100,6 +107,21 @@ var Key = /*#__PURE__*/function () {
     value: function clone() {
       return _classPrivateMethodGet(this, _set, _set2).call(this, {});
     }
+  }, {
+    key: "toChordSymbol",
+    value: function toChordSymbol(key) {
+      if (this.is(_constants.SYMBOL)) {
+        return this.clone();
+      }
+
+      var transposeDistance = this.note.getTransposeDistance(key.minor) + (MODIFIER_TRANSPOSITION[this.modifier] || 0);
+      return key.transpose(transposeDistance).normalize().useModifier(key.modifier);
+    }
+  }, {
+    key: "toChordSymbolString",
+    value: function toChordSymbolString(key) {
+      return this.toChordSymbol(key).toString();
+    }
   }, {
     key: "is",
     value: function is(type) {
@@ -127,21 +149,6 @@ var Key = /*#__PURE__*/function () {
           modifier = _ref2.modifier;
       return this.note.equals(note) && this.modifier === modifier;
     }
-  }, {
-    key: "toChordSymbol",
-    value: function toChordSymbol(key) {
-      if (this.is(_constants.SYMBOL)) {
-        return this.clone();
-      }
-
-      var transposeDistance = this.note.getTransposeDistance() + (MODIFIER_TRANSPOSITION[this.modifier] || 0);
-      return key.transpose(transposeDistance).normalize().useModifier(key.modifier);
-    }
-  }, {
-    key: "toChordSymbolString",
-    value: function toChordSymbolString(key) {
-      return this.toChordSymbol(key).toString();
-    }
   }, {
     key: "toNumeric",
     value: function toNumeric(key) {
@@ -159,11 +166,11 @@ var Key = /*#__PURE__*/function () {
         note: 1
       });
       var symbolKey = key.clone();
-      var reference = this.clone().normalize().useModifier(key.modifier);
+      var reference = this.clone().normalize().useModifier(key.modifier).normalizeEnharmonics(key);
 
       while (!symbolKey.equals(reference)) {
         numericKey = numericKey.transposeUp().useModifier(key.modifier);
-        symbolKey = symbolKey.transposeUp().normalize().useModifier(key.modifier);
+        symbolKey = symbolKey.transposeUp().normalize().useModifier(key.modifier).normalizeEnharmonics(key);
       }
 
       return numericKey;
@@ -190,11 +197,11 @@ var Key = /*#__PURE__*/function () {
         note: 'I'
       });
       var symbolKey = key.clone();
-      var reference = this.clone().normalize().useModifier(key.modifier);
+      var reference = this.clone().normalize().useModifier(key.modifier).normalizeEnharmonics(key);
 
       while (!symbolKey.equals(reference)) {
         numeralKey = numeralKey.transposeUp().useModifier(key.modifier);
-        symbolKey = symbolKey.transposeUp().normalize().useModifier(key.modifier);
+        symbolKey = symbolKey.transposeUp().normalize().useModifier(key.modifier).normalizeEnharmonics(key);
       }
 
       return numeralKey;
@@ -318,6 +325,21 @@ var Key = /*#__PURE__*/function () {
         });
       }
 
+      return this.clone();
+    }
+  }, {
+    key: "normalizeEnharmonics",
+    value: function normalizeEnharmonics(key) {
+      if (key) {
+        var rootKeyString = key.minor ? "".concat(key, "m") : key.toString();
+        var enharmonics = _enharmonicNormalize["default"][rootKeyString];
+        var thisKeyString = this.toString();
+
+        if (enharmonics && enharmonics[thisKeyString]) {
+          return Key.parse(enharmonics[thisKeyString]);
+        }
+      }
+
       return this.clone();
     }
   }], [{
@@ -355,7 +377,8 @@ var Key = /*#__PURE__*/function () {
 function _set2(attributes) {
   return new this.constructor(_objectSpread({
     note: this.note.clone(),
-    modifier: this.modifier
+    modifier: this.modifier,
+    minor: !!this.minor
   }, attributes));
 }
 

package/lib/normalize_mappings/enharmonic-normalize.js

@@ -0,0 +1,124 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {
+  'Ab': {
+    'B': 'Cb'
+  },
+  'Cb': {
+    'B': 'Cb',
+    'A#': 'Bb',
+    'E': 'Fb'
+  },
+  'C': {
+    'C#': 'Db',
+    'D#': 'Eb',
+    'F#': 'Gb',
+    'G#': 'Ab',
+    'A#': 'Bb'
+  },
+  'C#': {
+    'D#': 'Eb',
+    'A#': 'Bb'
+  },
+  'Db': {
+    'B': 'Cb'
+  },
+  'D': {
+    'D#': 'Eb',
+    'A#': 'Bb'
+  },
+  'E': {
+    'Ab': 'G#',
+    'A#': 'Bb',
+    'D#': 'Eb'
+  },
+  'F': {
+    'A#': 'Bb',
+    'F#': 'Gb',
+    'C#': 'Db',
+    'D#': 'Eb',
+    'G#': 'Ab'
+  },
+  'F#': {
+    'A#': 'Bb',
+    'D#': 'Eb'
+  },
+  'Gb': {
+    'A#': 'Bb',
+    'D#': 'Eb',
+    'G#': 'Ab',
+    'B': 'Cb',
+    'E': 'Fb'
+  },
+  'G': {
+    'A#': 'Bb',
+    'D#': 'Eb',
+    'G#': 'Ab'
+  },
+  'G#': {
+    'A#': 'Bb',
+    'D#': 'Eb'
+  },
+  'Am': {
+    'Gb': 'G',
+    'G#': 'Ab',
+    'F#': 'Gb',
+    'C#': 'Db',
+    'D#': 'Eb',
+    'A#': 'Bb'
+  },
+  'Bbm': {
+    'Cb': 'B'
+  },
+  'Bm': {
+    'A#': 'Bb',
+    'D#': 'Eb'
+  },
+  'C#m': {
+    'A#': 'Bb',
+    'D#': 'Eb'
+  },
+  'Cm': {
+    'G#': 'Ab',
+    'A#': 'Bb',
+    'D#': 'Eb',
+    'F#': 'Gb',
+    'C#': 'Db'
+  },
+  'Dm': {
+    'A#': 'Bb',
+    'D#': 'Eb'
+  },
+  'Em': {
+    'A#': 'Bb',
+    'D#': 'Eb'
+  },
+  'F#m': {
+    'A#': 'Bb',
+    'D#': 'Eb',
+    'Gb': 'F#',
+    'Ab': 'G#',
+    'Db': 'C#'
+  },
+  'Fm': {
+    'G#': 'Ab',
+    'A#': 'Bb',
+    'D#': 'Eb',
+    'F#': 'Gb',
+    'C#': 'Db'
+  },
+  'Gm': {
+    'G#': 'Ab',
+    'A#': 'Bb',
+    'D#': 'Eb'
+  },
+  'G#m': {
+    'A#': 'Bb',
+    'D#': 'Eb'
+  }
+};
+exports["default"] = _default;

package/lib/normalize_mappings/generate-suffix-normalize-mapping.js

@@ -0,0 +1,36 @@
+"use strict";
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
+var fs = require('fs');
+
+console.warn('\x1b[34m', '👷 Building suffix normalize mapping from suffix-mapping.txt');
+fs.readFile('src/normalize_mappings/suffix-mapping.txt', function (err, data) {
+  if (err) throw err;
+  var suffixs = [];
+  data.toString().split('\n').map(function (line) {
+    var items = line.split(',');
+    var cleanStringsArray = [];
+    items.forEach(function (item) {
+      cleanStringsArray.push(item.trim());
+    });
+    suffixs.push(cleanStringsArray);
+    return suffixs;
+  });
+  var flatObject = {};
+  suffixs.forEach(function (line) {
+    line.forEach(function (item) {
+      flatObject = _objectSpread(_defineProperty({}, item, line[0]), flatObject);
+    });
+  });
+  var suffixMappingJson = JSON.stringify(flatObject, null, 2);
+  var suffixMappingJs = "export default ".concat(suffixMappingJson, ";\n");
+  fs.writeFile('src/normalize_mappings/suffix-normalize-mapping.js', suffixMappingJs, 'utf-8', function (error) {
+    if (error) throw error;
+    console.warn('\x1b[32m', '✨ Sucessfully built suffix-normalize-mapping.js');
+  });
+});