chordsheetjs 4.8.0 → 5.0.0

package/lib/key.js

@@ -0,0 +1,292 @@
+"use strict";
+
+function _typeof(obj) { "@babel/helpers - typeof"; if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }; } return _typeof(obj); }
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+
+var _note = _interopRequireDefault(require("./note"));
+
+var _constants = require("./constants");
+
+var _MODIFIER_TRANSPOSITI;
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (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 = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
+
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+
+function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
+
+function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); return Constructor; }
+
+function _classPrivateMethodInitSpec(obj, privateSet) { _checkPrivateRedeclaration(obj, privateSet); privateSet.add(obj); }
+
+function _checkPrivateRedeclaration(obj, privateCollection) { if (privateCollection.has(obj)) { throw new TypeError("Cannot initialize the same private elements twice on an object"); } }
+
+function _classPrivateMethodGet(receiver, privateSet, fn) { if (!privateSet.has(receiver)) { throw new TypeError("attempted to get private field on non-instance"); } return fn; }
+
+function _wrapRegExp() { _wrapRegExp = function _wrapRegExp(re, groups) { return new BabelRegExp(re, undefined, groups); }; var _super = RegExp.prototype; var _groups = new WeakMap(); function BabelRegExp(re, flags, groups) { var _this = new RegExp(re, flags); _groups.set(_this, groups || _groups.get(re)); return _setPrototypeOf(_this, BabelRegExp.prototype); } _inherits(BabelRegExp, RegExp); BabelRegExp.prototype.exec = function (str) { var result = _super.exec.call(this, str); if (result) result.groups = buildGroups(result, this); return result; }; BabelRegExp.prototype[Symbol.replace] = function (str, substitution) { if (typeof substitution === "string") { var groups = _groups.get(this); return _super[Symbol.replace].call(this, str, substitution.replace(/\$<([^>]+)>/g, function (_, name) { return "$" + groups[name]; })); } else if (typeof substitution === "function") { var _this = this; return _super[Symbol.replace].call(this, str, function () { var args = arguments; if (_typeof(args[args.length - 1]) !== "object") { args = [].slice.call(args); args.push(buildGroups(args, _this)); } return substitution.apply(this, args); }); } else { return _super[Symbol.replace].call(this, str, substitution); } }; function buildGroups(result, re) { var g = _groups.get(re); return Object.keys(g).reduce(function (groups, name) { groups[name] = result[g[name]]; return groups; }, Object.create(null)); } return _wrapRegExp.apply(this, arguments); }
+
+function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function"); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, writable: true, configurable: true } }); if (superClass) _setPrototypeOf(subClass, superClass); }
+
+function _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf || function _setPrototypeOf(o, p) { o.__proto__ = p; return o; }; return _setPrototypeOf(o, p); }
+
+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 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, {
+  note: 1,
+  modifier: 2
+});
+
+var numericKeyRegex = /*#__PURE__*/_wrapRegExp(/^(#|b)?([1-7])$/, {
+  modifier: 1,
+  note: 2
+});
+
+var regexes = [symbolKeyRegex, numericKeyRegex];
+
+var _set = /*#__PURE__*/new WeakSet();
+
+var Key = /*#__PURE__*/function () {
+  function Key(_ref) {
+    var note = _ref.note,
+        _ref$modifier = _ref.modifier,
+        modifier = _ref$modifier === void 0 ? null : _ref$modifier;
+
+    _classCallCheck(this, Key);
+
+    _classPrivateMethodInitSpec(this, _set);
+
+    this.note = note instanceof _note["default"] ? note : new _note["default"](note);
+    this.modifier = modifier || null;
+  }
+
+  _createClass(Key, [{
+    key: "clone",
+    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() + (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) {
+      return this.note.is(type);
+    }
+  }, {
+    key: "isNumeric",
+    value: function isNumeric() {
+      return this.is(_constants.NUMERIC);
+    }
+  }, {
+    key: "isChordSymbol",
+    value: function isChordSymbol() {
+      return this.is(_constants.SYMBOL);
+    }
+  }, {
+    key: "toNumeric",
+    value: function toNumeric(key) {
+      if (this.isNumeric()) {
+        return this.clone();
+      }
+
+      var numericKey = new Key({
+        note: 1
+      });
+      var symbolKey = key.clone();
+      var reference = this.clone().normalize().useModifier(key.modifier);
+
+      while (!symbolKey.equals(reference)) {
+        numericKey = numericKey.transposeUp().useModifier(key.modifier);
+        symbolKey = symbolKey.transposeUp().normalize().useModifier(key.modifier);
+      }
+
+      return numericKey;
+    }
+  }, {
+    key: "equals",
+    value: function equals(_ref2) {
+      var note = _ref2.note,
+          modifier = _ref2.modifier;
+      return this.note.equals(note) && this.modifier === modifier;
+    }
+  }, {
+    key: "toNumericString",
+    value: function toNumericString(key) {
+      return this.toNumeric(key).toString();
+    }
+  }, {
+    key: "toString",
+    value: function toString() {
+      if (this.is(_constants.NUMERIC)) {
+        return "".concat(this.modifier || '').concat(this.note);
+      }
+
+      return "".concat(this.note).concat(this.modifier || '');
+    }
+  }, {
+    key: "transpose",
+    value: function transpose(delta) {
+      if (delta === 0) {
+        return this;
+      }
+
+      var originalModifier = this.modifier;
+      var transposedKey = this.clone();
+      var func = delta < 0 ? 'transposeDown' : 'transposeUp';
+
+      for (var i = 0, count = Math.abs(delta); i < count; i += 1) {
+        transposedKey = transposedKey[func]();
+      }
+
+      return transposedKey.useModifier(originalModifier);
+    }
+  }, {
+    key: "transposeUp",
+    value: function transposeUp() {
+      if (this.modifier === FLAT) {
+        return _classPrivateMethodGet(this, _set, _set2).call(this, {
+          modifier: null
+        });
+      }
+
+      if (this.note.isOneOf(3, 7, 'E', 'B')) {
+        return _classPrivateMethodGet(this, _set, _set2).call(this, {
+          note: this.note.up()
+        });
+      }
+
+      if (this.modifier === SHARP) {
+        return _classPrivateMethodGet(this, _set, _set2).call(this, {
+          note: this.note.up(),
+          modifier: null
+        });
+      }
+
+      return _classPrivateMethodGet(this, _set, _set2).call(this, {
+        modifier: SHARP
+      });
+    }
+  }, {
+    key: "transposeDown",
+    value: function transposeDown() {
+      if (this.modifier === SHARP) {
+        return _classPrivateMethodGet(this, _set, _set2).call(this, {
+          modifier: null
+        });
+      }
+
+      if (this.note.isOneOf(1, 4, 'C', 'F')) {
+        return _classPrivateMethodGet(this, _set, _set2).call(this, {
+          note: this.note.down()
+        });
+      }
+
+      if (this.modifier === FLAT) {
+        return _classPrivateMethodGet(this, _set, _set2).call(this, {
+          note: this.note.down(),
+          modifier: null
+        });
+      }
+
+      return _classPrivateMethodGet(this, _set, _set2).call(this, {
+        modifier: FLAT
+      });
+    }
+  }, {
+    key: "useModifier",
+    value: function useModifier(newModifier) {
+      if (this.modifier === FLAT && newModifier === SHARP) {
+        return _classPrivateMethodGet(this, _set, _set2).call(this, {
+          note: this.note.down(),
+          modifier: SHARP
+        });
+      }
+
+      if (this.modifier === SHARP && newModifier === FLAT) {
+        return _classPrivateMethodGet(this, _set, _set2).call(this, {
+          note: this.note.up(),
+          modifier: FLAT
+        });
+      }
+
+      return this.clone();
+    }
+  }, {
+    key: "normalize",
+    value: function normalize() {
+      if (this.modifier === SHARP && this.note.isOneOf(3, 7, 'E', 'B')) {
+        return _classPrivateMethodGet(this, _set, _set2).call(this, {
+          note: this.note.up(),
+          modifier: null
+        });
+      }
+
+      if (this.modifier === FLAT && this.note.isOneOf(1, 4, 'C', 'F')) {
+        return _classPrivateMethodGet(this, _set, _set2).call(this, {
+          note: this.note.down(),
+          modifier: null
+        });
+      }
+
+      return this.clone();
+    }
+  }], [{
+    key: "parse",
+    value: function parse(keyString) {
+      for (var i = 0, count = regexes.length; i < count; i += 1) {
+        var match = keyString.match(regexes[i]);
+
+        if (match) {
+          return new Key(match.groups);
+        }
+      }
+
+      return null;
+    }
+  }, {
+    key: "wrap",
+    value: function wrap(keyStringOrObject) {
+      if (keyStringOrObject instanceof Key) {
+        return keyStringOrObject;
+      }
+
+      return this.parse(keyStringOrObject);
+    }
+  }]);
+
+  return Key;
+}();
+
+function _set2(attributes) {
+  return new this.constructor(_objectSpread({
+    note: this.note.clone(),
+    modifier: this.modifier
+  }, attributes));
+}
+
+var _default = Key;
+exports["default"] = _default;

package/lib/note.js

@@ -0,0 +1,132 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+
+var _constants = require("./constants");
+
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+
+function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
+
+function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); return Constructor; }
+
+var A = 'A'.charCodeAt(0);
+var G = 'G'.charCodeAt(0);
+var TRANSPOSE_DISTANCE = [null, 0, 2, 4, 5, 7, 9, 11];
+
+function keyToCharCode(key) {
+  return key.toUpperCase().charCodeAt(0);
+}
+
+function clamp(note, min, max) {
+  var newNote = note;
+
+  if (newNote < min) {
+    newNote += 7;
+  } else if (newNote > max) {
+    newNote -= 7;
+  }
+
+  return newNote;
+}
+
+var Note = /*#__PURE__*/function () {
+  function Note(note) {
+    _classCallCheck(this, Note);
+
+    if (/^[A-Ga-g]$/.test(note)) {
+      this.note = note.toUpperCase();
+      this.type = _constants.SYMBOL;
+    } else if (/^[1-7]$/.test(note)) {
+      this.note = parseInt(note, 10);
+      this.type = _constants.NUMERIC;
+    } else {
+      throw new Error("Invalid note ".concat(note));
+    }
+  }
+
+  _createClass(Note, [{
+    key: "equals",
+    value: function equals(otherNote) {
+      return this.note === otherNote.note && this.type === otherNote.type;
+    }
+  }, {
+    key: "clone",
+    value: function clone() {
+      return new this.constructor(this.note);
+    }
+  }, {
+    key: "up",
+    value: function up() {
+      return this.change(1);
+    }
+  }, {
+    key: "down",
+    value: function down() {
+      return this.change(-1);
+    }
+  }, {
+    key: "isOneOf",
+    value: function isOneOf() {
+      for (var _len = arguments.length, options = new Array(_len), _key = 0; _key < _len; _key++) {
+        options[_key] = arguments[_key];
+      }
+
+      return options.includes(this.note);
+    }
+  }, {
+    key: "isNumeric",
+    value: function isNumeric() {
+      return this.is(_constants.NUMERIC);
+    }
+  }, {
+    key: "isChordSymbol",
+    value: function isChordSymbol() {
+      return this.is(_constants.SYMBOL);
+    }
+  }, {
+    key: "is",
+    value: function is(noteType) {
+      return this.type === noteType;
+    }
+  }, {
+    key: "getTransposeDistance",
+    value: function getTransposeDistance() {
+      return TRANSPOSE_DISTANCE[this.note];
+    }
+  }, {
+    key: "change",
+    value: function change(delta) {
+      if (this.isNumeric()) {
+        var newNote = clamp(this.note + delta, 1, 7);
+
+        if (newNote < 1) {
+          newNote += 7;
+        } else if (newNote > 7) {
+          newNote -= 7;
+        }
+
+        return new Note(newNote);
+      }
+
+      var charCode;
+      charCode = keyToCharCode(this.note);
+      charCode += delta;
+      charCode = clamp(charCode, A, G);
+      return new Note(String.fromCharCode(charCode));
+    }
+  }, {
+    key: "toString",
+    value: function toString() {
+      return "".concat(this.note);
+    }
+  }]);
+
+  return Note;
+}();
+
+var _default = Note;
+exports["default"] = _default;

package/lib/parser/ultimate_guitar_parser.js

@@ -27,7 +27,7 @@ function _defineProperties(target, props) { for (var i = 0; i < props.length; i+
 
 function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); return Constructor; }
 
-function _get(target, property, receiver) { if (typeof Reflect !== "undefined" && Reflect.get) { _get = Reflect.get; } else { _get = function _get(target, property, receiver) { var base = _superPropBase(target, property); if (!base) return; var desc = Object.getOwnPropertyDescriptor(base, property); if (desc.get) { return desc.get.call(receiver); } return desc.value; }; } return _get(target, property, receiver || target); }
+function _get() { if (typeof Reflect !== "undefined" && Reflect.get) { _get = Reflect.get; } else { _get = function _get(target, property, receiver) { var base = _superPropBase(target, property); if (!base) return; var desc = Object.getOwnPropertyDescriptor(base, property); if (desc.get) { return desc.get.call(arguments.length < 3 ? target : receiver); } return desc.value; }; } return _get.apply(this, arguments); }
 
 function _superPropBase(object, property) { while (!Object.prototype.hasOwnProperty.call(object, property)) { object = _getPrototypeOf(object); if (object === null) break; } return object; }
 

package/lib/utilities.js

@@ -3,7 +3,10 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.pushNew = exports.presence = exports.padLeft = exports.isPresent = exports.isEvaluatable = exports.hasTextContents = exports.hasChordContents = exports.deprecate = void 0;
+exports.deprecate = deprecate;
+exports.hasTextContents = exports.hasChordContents = void 0;
+exports.isEmptyString = isEmptyString;
+exports.pushNew = exports.presence = exports.padLeft = exports.isPresent = exports.isEvaluatable = void 0;
 exports.scopeCss = scopeCss;
 
 var _chord_lyrics_pair = _interopRequireDefault(require("./chord_sheet/chord_lyrics_pair"));
@@ -12,6 +15,8 @@ var _tag = _interopRequireDefault(require("./chord_sheet/tag"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
 
+function _typeof(obj) { "@babel/helpers - typeof"; if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }; } return _typeof(obj); }
+
 function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
 
 function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
@@ -66,14 +71,6 @@ var padLeft = function padLeft(str, length) {
 
 exports.padLeft = padLeft;
 
-var deprecate = function deprecate(message) {
-  if (process && process.emitWarning) {
-    process.emitWarning(message);
-  }
-};
-
-exports.deprecate = deprecate;
-
 var isPresent = function isPresent(object) {
   return object && object.length > 0;
 };
@@ -108,4 +105,20 @@ function scopeCss(css, scope) {
     var scopedSelector = "".concat(scope, " ").concat(selector).trim();
     return "\n".concat(scopedSelector, " {\n  ").concat(rules, "\n}").substring(1);
   }).join('\n\n');
+}
+
+function deprecate(message) {
+  try {
+    throw new Error("DEPRECATION: ".concat(message));
+  } catch (e) {
+    if ((typeof process === "undefined" ? "undefined" : _typeof(process)) === 'object' && typeof process.emitWarning === 'function') {
+      process.emitWarning("".concat(message, "\n").concat(e.stack));
+    } else {
+      console.warn("".concat(message, "\n").concat(e.stack));
+    }
+  }
+}
+
+function isEmptyString(string) {
+  return string === null || string === undefined || string === '';
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "chordsheetjs",
   "author": "Martijn Versluis",
-  "version": "4.8.0",
+  "version": "5.0.0",
   "description": "A JavaScript library for parsing and formatting chord sheets",
   "main": "lib/index.js",
   "repository": {
@@ -20,16 +20,16 @@
     "babel-eslint": "^10.1.0",
     "babel-plugin-handlebars-inline-precompile": "^2.1.1",
     "eslint": "^7.2.0",
-    "eslint-config-airbnb-base": "^14.2.0",
+    "eslint-config-airbnb-base": "^15.0.0",
     "eslint-plugin-import": "^2.21.2",
     "jest": "^27.0.1",
-    "jsdoc-to-markdown": "^7.0.1",
+    "jsdoc-to-markdown": "^7.1.0",
     "pegjs": "^0.10.0"
   },
   "scripts": {
     "jest": "jest",
     "test": "yarn lint && yarn jest",
-    "lint": "yarn build:pegjs && node_modules/.bin/eslint --ext .js .",
+    "lint": "yarn build:templates && yarn build:pegjs && node_modules/.bin/eslint --ext .js .",
     "lint:fix": "node_modules/.bin/eslint --fix --ext .js .",
     "build:template": "handlebars \"src/formatter/templates/$TEMPLATE.handlebars\" -f \"src/formatter/templates/$TEMPLATE.js\" --known each --known if --known with --known paragraphClasses --known isChordLyricsPair --known isTag --known isComment --known shouldRenderLine --known hasChordContents --known lineHasContents --known lineClasses --known toUpperCase --known paragraphClasses --commonjs handlebars",
     "build:templates": "TEMPLATE=html_div_formatter yarn build:template && TEMPLATE=html_table_formatter yarn build:template",
@@ -41,7 +41,6 @@
     "pretest": "yarn build:templates && yarn build:pegjs"
   },
   "dependencies": {
-    "chordjs": "^2.0.0",
     "handlebars": "^4.7.6"
   }
 }