feat: recode in TS, remove decode function

BREAKING CHANGE: previously: "import bSlug from ..." - now "import { bSlug } from ..." - plus, removed the string decoding
codsen · Dec 25, 2020 · 1af1c80 · 1af1c80
1 parent c2aa395
commit 1af1c80
Show file tree

Hide file tree

Showing 17 changed files with 632 additions and 4,790 deletions.
diff --git a/packages/bitbucket-slug/.npmignore b/packages/bitbucket-slug/.npmignore
@@ -1,4 +1,4 @@
-# .... generated using www.npmjs.com/package/lect ....
+# generated using codsen.com/os/lect 
 #
 #
 #       __         ______     ______     ______  
@@ -23,3 +23,4 @@ test
 .prettierignore
 rollup.config.js
 testStats.md
+tsconfig.json
diff --git a/packages/bitbucket-slug/README.md b/packages/bitbucket-slug/README.md
@@ -34,7 +34,7 @@ npm i bitbucket-slug
 
 ```js
 import { strict as assert } from "assert";
-import bSlug from "bitbucket-slug";
+import { bSlug } from "bitbucket-slug";
 
 assert.equal(
   bSlug("# Let's backwards-engineer BitBucket anchor link slug algorithm"),

diff --git a/packages/bitbucket-slug/coverage/coverage-summary.json b/packages/bitbucket-slug/coverage/coverage-summary.json
@@ -1 +1 @@
-{"total":{"lines":{"total":5,"covered":5,"skipped":0,"pct":100},"statements":{"total":5,"covered":5,"skipped":0,"pct":100},"functions":{"total":1,"covered":1,"skipped":0,"pct":100},"branches":{"total":2,"covered":2,"skipped":0,"pct":100}}}
+{"total":{"lines":{"total":3,"covered":3,"skipped":0,"pct":100},"statements":{"total":3,"covered":3,"skipped":0,"pct":100},"functions":{"total":1,"covered":1,"skipped":0,"pct":100},"branches":{"total":2,"covered":2,"skipped":0,"pct":100}}}
diff --git a/packages/bitbucket-slug/dist/bitbucket-slug.cjs.js b/packages/bitbucket-slug/dist/bitbucket-slug.cjs.js
@@ -9,25 +9,24 @@
 
 'use strict';
 
+Object.defineProperty(exports, '__esModule', { value: true });
+
 var deburr = require('lodash.deburr');
-var ent = require('ent');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
 var deburr__default = /*#__PURE__*/_interopDefaultLegacy(deburr);
-var ent__default = /*#__PURE__*/_interopDefaultLegacy(ent);
 
 function bSlug(str) {
   if (typeof str !== "string") {
     return "";
-  }
-  while (str !== ent__default['default'].decode(str)) {
-    str = ent__default['default'].decode(str);
-  }
-  return "markdown-header-".concat(deburr__default['default'](str).replace(/\]\((.*?)\)/g, "")
-  .replace(/ [-]+ /gi, " ").replace(/[^\w\d\s-]/g, "")
-  .replace(/\s+/g, " ")
-  .toLowerCase().trim().replace(/ /g, "-"));
+  } // characters which will be deleted:
+
+
+  return "markdown-header-" + deburr__default['default'](str).replace(/\]\((.*?)\)/g, "") // remove all within brackets (Markdown links)
+  .replace(/ [-]+ /gi, " ").replace(/[^\w\d\s-]/g, "") // remove non-letters
+  .replace(/\s+/g, " ") // collapse whitespace
+  .toLowerCase().trim().replace(/ /g, "-"); // replace spaces with dashes
 }
 
-module.exports = bSlug;
+exports.bSlug = bSlug;