@anthonypena/marked-toc-for-series 1.0.0

package/.eslintrc.cjs

@@ -0,0 +1,4 @@
+module.exports = {
+  plugins: ['@anthonypena'],
+  extends: ['plugin:@anthonypena/recommended'],
+};

package/.prettierignore

@@ -0,0 +1,2 @@
+dist/
+node_modules/

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Anthony Pena
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,77 @@
+# @anthonypena/marked-toc-for-series
+
+## Install
+
+```Bash
+npm i @anthonypena/marked-toc-for-series
+```
+
+## Examples
+
+### Add the plugin to your Marked instance
+
+```TypeScript
+import { markedDjotDiv } from '@anthonypena/marked-toc-for-series';
+import { Marked } from 'marked';
+
+const marked = new Marked();
+
+marked.use(markedTocForSeries({
+    title: 'Série',
+    series: {
+        'this-is-the-serie-id': {
+            articles: [
+                { label: 'First one', url: 'https://example.com/first-one' },
+                { label: 'Second one', url: '/second-one' },
+            ]
+        },
+        'another-serie': {
+            // ...
+        }
+    }
+}));
+```
+
+## Transformation
+
+From:
+
+```Markdown
+# Title
+
+<!-- TOC-SERIE:this-is-the-serie-id -->
+
+Some content...
+```
+
+to:
+
+```Html
+<h1>Title</h1>
+
+<nav data-serie="this-is-the-serie-id">
+    <h2>Série</h2>
+    <ul>
+        <li><a href="https://example.com/first-one">First one</a></li>
+        <li><a href="/second-one">Second one</a></li>
+    </ul>
+</nav>
+
+<p>Some content...</p>
+```
+
+> Note: This package does not provide build in style. You need to implement yourself style associated to classes you define.
+
+## Docs
+
+### Parameters
+
+#### `title` (optional): the title you wan
+
+Default: undefined
+
+If defined, a title with an `<h2>` tag will be added, if not defined (undefined or null or empty) no title will be present.
+
+#### `series`: the series definition
+
+A dictionnary of serie definition.

package/dist/index.d.mts

@@ -0,0 +1,25 @@
+import { marked } from 'marked';
+
+type SeriesDef = Record<string, SerieDef>;
+interface MarkedTocForSeriesOptions {
+    title?: string | undefined | null;
+    series: SeriesDef;
+}
+interface SerieDef {
+    articles: ArticleDef[];
+}
+interface ArticleDef {
+    label: string;
+    url: string;
+}
+declare function markedTocForSeries({ title, series, }: MarkedTocForSeriesOptions): marked.MarkedExtension;
+interface TocForSeriesToken extends marked.Tokens.Generic {
+    type: 'tocForSeries';
+    serieId: string;
+    raw: string;
+}
+declare function isTocForSeriesToken(token: TocForSeriesToken | {
+    type: unknown;
+}): token is TocForSeriesToken;
+
+export { type ArticleDef, type MarkedTocForSeriesOptions, type SerieDef, type SeriesDef, isTocForSeriesToken, markedTocForSeries };

package/dist/index.mjs

@@ -0,0 +1,242 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __commonJS = (cb, mod) => function __require() {
+  return mod || (0, cb[__getOwnPropNames(cb)[0]])((mod = { exports: {} }).exports, mod), mod.exports;
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+
+// ../fp/dist/basic.js
+var require_basic = __commonJS({
+  "../fp/dist/basic.js"(exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.notf = exports.not = exports.identity = exports.noop = void 0;
+    function noop() {
+    }
+    exports.noop = noop;
+    function identity(x) {
+      return x;
+    }
+    exports.identity = identity;
+    function not(x) {
+      return !x;
+    }
+    exports.not = not;
+    function notf(f) {
+      return (...args) => not(f(...args));
+    }
+    exports.notf = notf;
+  }
+});
+
+// ../fp/dist/predicates.js
+var require_predicates = __commonJS({
+  "../fp/dist/predicates.js"(exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.isNotDefinedOrEmpty = exports.isDefinedAndNotEmpty = exports.isNotEmpty = exports.isEmpty = exports.isNotDefined = exports.isDefined = void 0;
+    function isDefined2(x) {
+      return x != void 0;
+    }
+    exports.isDefined = isDefined2;
+    function isNotDefined2(x) {
+      return x == void 0;
+    }
+    exports.isNotDefined = isNotDefined2;
+    function isEmpty(x) {
+      return x.length === 0;
+    }
+    exports.isEmpty = isEmpty;
+    function isNotEmpty(x) {
+      return x.length > 0;
+    }
+    exports.isNotEmpty = isNotEmpty;
+    function isDefinedAndNotEmpty2(x) {
+      return isDefined2(x) && isNotEmpty(x);
+    }
+    exports.isDefinedAndNotEmpty = isDefinedAndNotEmpty2;
+    function isNotDefinedOrEmpty2(x) {
+      return isNotDefined2(x) || isEmpty(x);
+    }
+    exports.isNotDefinedOrEmpty = isNotDefinedOrEmpty2;
+  }
+});
+
+// ../fp/dist/clone.js
+var require_clone = __commonJS({
+  "../fp/dist/clone.js"(exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.deepClone = void 0;
+    var predicates_1 = require_predicates();
+    function deepClone(x) {
+      if (x instanceof Date) {
+        return new Date(x.getTime());
+      }
+      if (typeof x === "bigint") {
+        return BigInt(x.toString());
+      }
+      if ((0, predicates_1.isNotDefined)(x) || typeof x === "boolean" || typeof x === "number" || x === Number.NEGATIVE_INFINITY || x === Number.POSITIVE_INFINITY) {
+        return x;
+      }
+      if (Array.isArray(x)) {
+        return x.map(deepClone);
+      }
+      if (typeof x === "object") {
+        return Object.fromEntries(
+          // eslint-disable-next-line @typescript-eslint/no-explicit-any
+          Object.entries(x).map(([k, v]) => [
+            k,
+            deepClone(v)
+          ])
+        );
+      }
+      return JSON.parse(JSON.stringify(x));
+    }
+    exports.deepClone = deepClone;
+  }
+});
+
+// ../fp/dist/equality.js
+var require_equality = __commonJS({
+  "../fp/dist/equality.js"(exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.isDifferent = exports.isEqual = void 0;
+    var basic_1 = require_basic();
+    function isEqual(a, b) {
+      if (typeof a !== typeof b) {
+        return false;
+      }
+      if (typeof a === "boolean" || typeof a === "number" || typeof a === "function" || typeof a === "string" || typeof a === "undefined" || a === null) {
+        return a === b;
+      }
+      if (a instanceof Date && b instanceof Date) {
+        return a.getTime() === b.getTime();
+      }
+      let aa = a;
+      let bb = b;
+      if (typeof a === "bigint") {
+        aa = a.toString();
+      }
+      if (typeof b === "bigint") {
+        bb = b.toString();
+      }
+      return JSON.stringify(aa) === JSON.stringify(bb);
+    }
+    exports.isEqual = isEqual;
+    function isDifferent(a, b) {
+      return (0, basic_1.not)(isEqual(a, b));
+    }
+    exports.isDifferent = isDifferent;
+  }
+});
+
+// ../fp/dist/index.js
+var require_dist = __commonJS({
+  "../fp/dist/index.js"(exports) {
+    "use strict";
+    var __createBinding = exports && exports.__createBinding || (Object.create ? function(o, m, k, k2) {
+      if (k2 === void 0) k2 = k;
+      var desc = Object.getOwnPropertyDescriptor(m, k);
+      if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+        desc = { enumerable: true, get: function() {
+          return m[k];
+        } };
+      }
+      Object.defineProperty(o, k2, desc);
+    } : function(o, m, k, k2) {
+      if (k2 === void 0) k2 = k;
+      o[k2] = m[k];
+    });
+    var __exportStar = exports && exports.__exportStar || function(m, exports2) {
+      for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports2, p)) __createBinding(exports2, m, p);
+    };
+    Object.defineProperty(exports, "__esModule", { value: true });
+    __exportStar(require_basic(), exports);
+    __exportStar(require_clone(), exports);
+    __exportStar(require_equality(), exports);
+    __exportStar(require_predicates(), exports);
+  }
+});
+
+// src/marked-toc-for-series.ts
+var import_fp = __toESM(require_dist());
+function markedTocForSeries({
+  title,
+  series
+}) {
+  return {
+    extensions: [
+      {
+        name: "tocForSeries",
+        level: "block",
+        start(src) {
+          var _a;
+          return (_a = src.match(/<!-- TOC-SERIE:.* -->/)) == null ? void 0 : _a.index;
+        },
+        tokenizer(src) {
+          const match = /^<!-- TOC-SERIE:(.*) -->?/.exec(src);
+          if ((0, import_fp.isDefined)(match)) {
+            const type = "tocForSeries";
+            const raw = src.slice(0, src.indexOf("-->") + 3);
+            const serieId = match == null ? void 0 : match[1];
+            const token = { type, raw, serieId };
+            return token;
+          }
+          return void 0;
+        },
+        renderer(token) {
+          if (!isTocForSeriesToken(token)) {
+            return false;
+          }
+          const serie = series[token.serieId];
+          if ((0, import_fp.isNotDefined)(serie) || (0, import_fp.isNotDefinedOrEmpty)(serie.articles)) {
+            return "";
+          }
+          const titleHtml = (0, import_fp.isDefinedAndNotEmpty)(title) ? `<h2>${title}</h2>` : void 0;
+          return rows(
+            `<nav data-serie="${token.serieId}">`,
+            titleHtml,
+            "<ul>",
+            ...serie.articles.map(
+              (article) => `<li><a href="${article.url}">${article.label}</a></li>`
+            ),
+            "</ul>",
+            "</nav>"
+          );
+        }
+      }
+    ]
+  };
+}
+function isTocForSeriesToken(token) {
+  return token.type === "tocForSeries";
+}
+function rows(...s) {
+  return s.filter(import_fp.isDefinedAndNotEmpty).join("\n") + "\n";
+}
+export {
+  isTocForSeriesToken,
+  markedTocForSeries
+};
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../fp/dist/basic.js","../../fp/dist/predicates.js","../../fp/dist/clone.js","../../fp/dist/equality.js","../../fp/dist/index.js","../src/marked-toc-for-series.ts"],"sourcesContent":["\"use strict\";\nObject.defineProperty(exports, \"__esModule\", { value: true });\nexports.notf = exports.not = exports.identity = exports.noop = void 0;\nfunction noop() { }\nexports.noop = noop;\nfunction identity(x) {\n    return x;\n}\nexports.identity = identity;\nfunction not(x) {\n    return !x;\n}\nexports.not = not;\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nfunction notf(f) {\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    return ((...args) => not(f(...args)));\n}\nexports.notf = notf;\n","\"use strict\";\nObject.defineProperty(exports, \"__esModule\", { value: true });\nexports.isNotDefinedOrEmpty = exports.isDefinedAndNotEmpty = exports.isNotEmpty = exports.isEmpty = exports.isNotDefined = exports.isDefined = void 0;\nfunction isDefined(x) {\n    return x != undefined;\n}\nexports.isDefined = isDefined;\nfunction isNotDefined(x) {\n    return x == undefined;\n}\nexports.isNotDefined = isNotDefined;\nfunction isEmpty(x) {\n    return x.length === 0;\n}\nexports.isEmpty = isEmpty;\nfunction isNotEmpty(x) {\n    return x.length > 0;\n}\nexports.isNotEmpty = isNotEmpty;\nfunction isDefinedAndNotEmpty(x) {\n    return isDefined(x) && isNotEmpty(x);\n}\nexports.isDefinedAndNotEmpty = isDefinedAndNotEmpty;\nfunction isNotDefinedOrEmpty(x) {\n    return isNotDefined(x) || isEmpty(x);\n}\nexports.isNotDefinedOrEmpty = isNotDefinedOrEmpty;\n","\"use strict\";\nObject.defineProperty(exports, \"__esModule\", { value: true });\nexports.deepClone = void 0;\nconst predicates_1 = require(\"./predicates\");\nfunction deepClone(x) {\n    if (x instanceof Date) {\n        return new Date(x.getTime());\n    }\n    if (typeof x === 'bigint') {\n        return BigInt(x.toString());\n    }\n    if ((0, predicates_1.isNotDefined)(x) ||\n        typeof x === 'boolean' ||\n        typeof x === 'number' ||\n        x === Number.NEGATIVE_INFINITY ||\n        x === Number.POSITIVE_INFINITY) {\n        return x;\n    }\n    if (Array.isArray(x)) {\n        return x.map(deepClone);\n    }\n    if (typeof x === 'object') {\n        return Object.fromEntries(\n        // eslint-disable-next-line @typescript-eslint/no-explicit-any\n        Object.entries(x).map(([k, v]) => [\n            k,\n            deepClone(v),\n        ]));\n    }\n    return JSON.parse(JSON.stringify(x));\n}\nexports.deepClone = deepClone;\n","\"use strict\";\nObject.defineProperty(exports, \"__esModule\", { value: true });\nexports.isDifferent = exports.isEqual = void 0;\nconst basic_1 = require(\"./basic\");\nfunction isEqual(a, b) {\n    if (typeof a !== typeof b) {\n        return false;\n    }\n    if (typeof a === 'boolean' ||\n        typeof a === 'number' ||\n        typeof a === 'function' ||\n        typeof a === 'string' ||\n        typeof a === 'undefined' ||\n        a === null) {\n        return a === b;\n    }\n    if (a instanceof Date && b instanceof Date) {\n        return a.getTime() === b.getTime();\n    }\n    let aa = a;\n    let bb = b;\n    if (typeof a === 'bigint') {\n        aa = a.toString();\n    }\n    if (typeof b === 'bigint') {\n        bb = b.toString();\n    }\n    return JSON.stringify(aa) === JSON.stringify(bb);\n}\nexports.isEqual = isEqual;\nfunction isDifferent(a, b) {\n    return (0, basic_1.not)(isEqual(a, b));\n}\nexports.isDifferent = isDifferent;\n","\"use strict\";\nvar __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {\n    if (k2 === undefined) k2 = k;\n    var desc = Object.getOwnPropertyDescriptor(m, k);\n    if (!desc || (\"get\" in desc ? !m.__esModule : desc.writable || desc.configurable)) {\n      desc = { enumerable: true, get: function() { return m[k]; } };\n    }\n    Object.defineProperty(o, k2, desc);\n}) : (function(o, m, k, k2) {\n    if (k2 === undefined) k2 = k;\n    o[k2] = m[k];\n}));\nvar __exportStar = (this && this.__exportStar) || function(m, exports) {\n    for (var p in m) if (p !== \"default\" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);\n};\nObject.defineProperty(exports, \"__esModule\", { value: true });\n__exportStar(require(\"./basic\"), exports);\n__exportStar(require(\"./clone\"), exports);\n__exportStar(require(\"./equality\"), exports);\n__exportStar(require(\"./predicates\"), exports);\n","import { marked } from 'marked';\nimport {\n  isDefined,\n  isDefinedAndNotEmpty,\n  isNotDefined,\n  isNotDefinedOrEmpty,\n} from '@anthonypena/fp';\n\nexport type SeriesDef = Record<string, SerieDef>;\n\nexport interface MarkedTocForSeriesOptions {\n  title?: string | undefined | null;\n  series: SeriesDef;\n}\n\nexport interface SerieDef {\n  articles: ArticleDef[];\n}\n\nexport interface ArticleDef {\n  label: string;\n  url: string;\n}\n\nexport function markedTocForSeries({\n  title,\n  series,\n}: MarkedTocForSeriesOptions): marked.MarkedExtension {\n  return {\n    extensions: [\n      {\n        name: 'tocForSeries',\n        level: 'block',\n        start(src) {\n          return src.match(/<!-- TOC-SERIE:.* -->/)?.index;\n        },\n        tokenizer(src): TocForSeriesToken | undefined {\n          const match = /^<!-- TOC-SERIE:(.*) -->?/.exec(src);\n          if (isDefined(match)) {\n            const type = 'tocForSeries';\n            const raw = src.slice(0, src.indexOf('-->') + 3);\n            const serieId = match?.[1];\n            const token: TocForSeriesToken = { type, raw, serieId };\n            return token;\n          }\n          return undefined;\n        },\n        renderer(token) {\n          if (!isTocForSeriesToken(token)) {\n            return false;\n          }\n          const serie = series[token.serieId];\n          if (isNotDefined(serie) || isNotDefinedOrEmpty(serie.articles)) {\n            return '';\n          }\n\n          const titleHtml = isDefinedAndNotEmpty(title)\n            ? `<h2>${title}</h2>`\n            : undefined;\n          return rows(\n            `<nav data-serie=\"${token.serieId}\">`,\n            titleHtml,\n            '<ul>',\n            ...serie.articles.map(\n              (article) =>\n                `<li><a href=\"${article.url}\">${article.label}</a></li>`,\n            ),\n            '</ul>',\n            '</nav>',\n          );\n        },\n      },\n    ],\n  };\n}\n\ninterface TocForSeriesToken extends marked.Tokens.Generic {\n  type: 'tocForSeries';\n  serieId: string;\n  raw: string;\n}\n\nexport function isTocForSeriesToken(\n  token: TocForSeriesToken | { type: unknown },\n): token is TocForSeriesToken {\n  return token.type === 'tocForSeries';\n}\n\nfunction rows(...s: (string | undefined | null)[]): string {\n  return s.filter(isDefinedAndNotEmpty).join('\\n') + '\\n';\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AACA,WAAO,eAAe,SAAS,cAAc,EAAE,OAAO,KAAK,CAAC;AAC5D,YAAQ,OAAO,QAAQ,MAAM,QAAQ,WAAW,QAAQ,OAAO;AAC/D,aAAS,OAAO;AAAA,IAAE;AAClB,YAAQ,OAAO;AACf,aAAS,SAAS,GAAG;AACjB,aAAO;AAAA,IACX;AACA,YAAQ,WAAW;AACnB,aAAS,IAAI,GAAG;AACZ,aAAO,CAAC;AAAA,IACZ;AACA,YAAQ,MAAM;AAEd,aAAS,KAAK,GAAG;AAEb,aAAQ,IAAI,SAAS,IAAI,EAAE,GAAG,IAAI,CAAC;AAAA,IACvC;AACA,YAAQ,OAAO;AAAA;AAAA;;;AClBf;AAAA;AAAA;AACA,WAAO,eAAe,SAAS,cAAc,EAAE,OAAO,KAAK,CAAC;AAC5D,YAAQ,sBAAsB,QAAQ,uBAAuB,QAAQ,aAAa,QAAQ,UAAU,QAAQ,eAAe,QAAQ,YAAY;AAC/I,aAASA,WAAU,GAAG;AAClB,aAAO,KAAK;AAAA,IAChB;AACA,YAAQ,YAAYA;AACpB,aAASC,cAAa,GAAG;AACrB,aAAO,KAAK;AAAA,IAChB;AACA,YAAQ,eAAeA;AACvB,aAAS,QAAQ,GAAG;AAChB,aAAO,EAAE,WAAW;AAAA,IACxB;AACA,YAAQ,UAAU;AAClB,aAAS,WAAW,GAAG;AACnB,aAAO,EAAE,SAAS;AAAA,IACtB;AACA,YAAQ,aAAa;AACrB,aAASC,sBAAqB,GAAG;AAC7B,aAAOF,WAAU,CAAC,KAAK,WAAW,CAAC;AAAA,IACvC;AACA,YAAQ,uBAAuBE;AAC/B,aAASC,qBAAoB,GAAG;AAC5B,aAAOF,cAAa,CAAC,KAAK,QAAQ,CAAC;AAAA,IACvC;AACA,YAAQ,sBAAsBE;AAAA;AAAA;;;AC1B9B;AAAA;AAAA;AACA,WAAO,eAAe,SAAS,cAAc,EAAE,OAAO,KAAK,CAAC;AAC5D,YAAQ,YAAY;AACpB,QAAM,eAAe;AACrB,aAAS,UAAU,GAAG;AAClB,UAAI,aAAa,MAAM;AACnB,eAAO,IAAI,KAAK,EAAE,QAAQ,CAAC;AAAA,MAC/B;AACA,UAAI,OAAO,MAAM,UAAU;AACvB,eAAO,OAAO,EAAE,SAAS,CAAC;AAAA,MAC9B;AACA,WAAK,GAAG,aAAa,cAAc,CAAC,KAChC,OAAO,MAAM,aACb,OAAO,MAAM,YACb,MAAM,OAAO,qBACb,MAAM,OAAO,mBAAmB;AAChC,eAAO;AAAA,MACX;AACA,UAAI,MAAM,QAAQ,CAAC,GAAG;AAClB,eAAO,EAAE,IAAI,SAAS;AAAA,MAC1B;AACA,UAAI,OAAO,MAAM,UAAU;AACvB,eAAO,OAAO;AAAA;AAAA,UAEd,OAAO,QAAQ,CAAC,EAAE,IAAI,CAAC,CAAC,GAAG,CAAC,MAAM;AAAA,YAC9B;AAAA,YACA,UAAU,CAAC;AAAA,UACf,CAAC;AAAA,QAAC;AAAA,MACN;AACA,aAAO,KAAK,MAAM,KAAK,UAAU,CAAC,CAAC;AAAA,IACvC;AACA,YAAQ,YAAY;AAAA;AAAA;;;AC/BpB;AAAA;AAAA;AACA,WAAO,eAAe,SAAS,cAAc,EAAE,OAAO,KAAK,CAAC;AAC5D,YAAQ,cAAc,QAAQ,UAAU;AACxC,QAAM,UAAU;AAChB,aAAS,QAAQ,GAAG,GAAG;AACnB,UAAI,OAAO,MAAM,OAAO,GAAG;AACvB,eAAO;AAAA,MACX;AACA,UAAI,OAAO,MAAM,aACb,OAAO,MAAM,YACb,OAAO,MAAM,cACb,OAAO,MAAM,YACb,OAAO,MAAM,eACb,MAAM,MAAM;AACZ,eAAO,MAAM;AAAA,MACjB;AACA,UAAI,aAAa,QAAQ,aAAa,MAAM;AACxC,eAAO,EAAE,QAAQ,MAAM,EAAE,QAAQ;AAAA,MACrC;AACA,UAAI,KAAK;AACT,UAAI,KAAK;AACT,UAAI,OAAO,MAAM,UAAU;AACvB,aAAK,EAAE,SAAS;AAAA,MACpB;AACA,UAAI,OAAO,MAAM,UAAU;AACvB,aAAK,EAAE,SAAS;AAAA,MACpB;AACA,aAAO,KAAK,UAAU,EAAE,MAAM,KAAK,UAAU,EAAE;AAAA,IACnD;AACA,YAAQ,UAAU;AAClB,aAAS,YAAY,GAAG,GAAG;AACvB,cAAQ,GAAG,QAAQ,KAAK,QAAQ,GAAG,CAAC,CAAC;AAAA,IACzC;AACA,YAAQ,cAAc;AAAA;AAAA;;;ACjCtB;AAAA;AAAA;AACA,QAAI,kBAAmB,WAAQ,QAAK,oBAAqB,OAAO,SAAU,SAAS,GAAG,GAAG,GAAG,IAAI;AAC5F,UAAI,OAAO,OAAW,MAAK;AAC3B,UAAI,OAAO,OAAO,yBAAyB,GAAG,CAAC;AAC/C,UAAI,CAAC,SAAS,SAAS,OAAO,CAAC,EAAE,aAAa,KAAK,YAAY,KAAK,eAAe;AACjF,eAAO,EAAE,YAAY,MAAM,KAAK,WAAW;AAAE,iBAAO,EAAE,CAAC;AAAA,QAAG,EAAE;AAAA,MAC9D;AACA,aAAO,eAAe,GAAG,IAAI,IAAI;AAAA,IACrC,IAAM,SAAS,GAAG,GAAG,GAAG,IAAI;AACxB,UAAI,OAAO,OAAW,MAAK;AAC3B,QAAE,EAAE,IAAI,EAAE,CAAC;AAAA,IACf;AACA,QAAI,eAAgB,WAAQ,QAAK,gBAAiB,SAAS,GAAGC,UAAS;AACnE,eAAS,KAAK,EAAG,KAAI,MAAM,aAAa,CAAC,OAAO,UAAU,eAAe,KAAKA,UAAS,CAAC,EAAG,iBAAgBA,UAAS,GAAG,CAAC;AAAA,IAC5H;AACA,WAAO,eAAe,SAAS,cAAc,EAAE,OAAO,KAAK,CAAC;AAC5D,iBAAa,iBAAoB,OAAO;AACxC,iBAAa,iBAAoB,OAAO;AACxC,iBAAa,oBAAuB,OAAO;AAC3C,iBAAa,sBAAyB,OAAO;AAAA;AAAA;;;AClB7C,gBAKO;AAkBA,SAAS,mBAAmB;AAAA,EACjC;AAAA,EACA;AACF,GAAsD;AACpD,SAAO;AAAA,IACL,YAAY;AAAA,MACV;AAAA,QACE,MAAM;AAAA,QACN,OAAO;AAAA,QACP,MAAM,KAAK;AAjCnB;AAkCU,kBAAO,SAAI,MAAM,uBAAuB,MAAjC,mBAAoC;AAAA,QAC7C;AAAA,QACA,UAAU,KAAoC;AAC5C,gBAAM,QAAQ,4BAA4B,KAAK,GAAG;AAClD,kBAAI,qBAAU,KAAK,GAAG;AACpB,kBAAM,OAAO;AACb,kBAAM,MAAM,IAAI,MAAM,GAAG,IAAI,QAAQ,KAAK,IAAI,CAAC;AAC/C,kBAAM,UAAU,+BAAQ;AACxB,kBAAM,QAA2B,EAAE,MAAM,KAAK,QAAQ;AACtD,mBAAO;AAAA,UACT;AACA,iBAAO;AAAA,QACT;AAAA,QACA,SAAS,OAAO;AACd,cAAI,CAAC,oBAAoB,KAAK,GAAG;AAC/B,mBAAO;AAAA,UACT;AACA,gBAAM,QAAQ,OAAO,MAAM,OAAO;AAClC,kBAAI,wBAAa,KAAK,SAAK,+BAAoB,MAAM,QAAQ,GAAG;AAC9D,mBAAO;AAAA,UACT;AAEA,gBAAM,gBAAY,gCAAqB,KAAK,IACxC,OAAO,KAAK,UACZ;AACJ,iBAAO;AAAA,YACL,oBAAoB,MAAM,OAAO;AAAA,YACjC;AAAA,YACA;AAAA,YACA,GAAG,MAAM,SAAS;AAAA,cAChB,CAAC,YACC,gBAAgB,QAAQ,GAAG,KAAK,QAAQ,KAAK;AAAA,YACjD;AAAA,YACA;AAAA,YACA;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACF;AAQO,SAAS,oBACd,OAC4B;AAC5B,SAAO,MAAM,SAAS;AACxB;AAEA,SAAS,QAAQ,GAA0C;AACzD,SAAO,EAAE,OAAO,8BAAoB,EAAE,KAAK,IAAI,IAAI;AACrD;","names":["isDefined","isNotDefined","isDefinedAndNotEmpty","isNotDefinedOrEmpty","exports"]}

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@anthonypena/marked-toc-for-series",
+  "version": "1.0.0",
+  "description": "Plugin add table of content for series of urls.",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "private": false,
+  "keywords": [
+    "marked"
+  ],
+  "author": "Anthony Pena",
+  "license": "MIT",
+  "dependencies": {
+    "@anthonypena/fp": "1.0.1"
+  },
+  "devDependencies": {
+    "@types/marked": "^5.0.0",
+    "eslint": "^8.57.0",
+    "marked": "^5.0.0",
+    "npm-run-all": "^4.1.5",
+    "prettier": "^3.2.5",
+    "rimraf": "^5.0.5",
+    "tsup": "^8.5.0",
+    "typescript": "^5.4.3",
+    "vitest": "^1.4.0",
+    "@anthonypena/tsconfig": "0.1.0",
+    "@anthonypena/prettier-config": "0.1.0",
+    "@anthonypena/eslint-plugin": "0.1.0"
+  },
+  "peerDependencies": {
+    "marked": "=5.x"
+  },
+  "prettier": "@anthonypena/prettier-config",
+  "scripts": {
+    "clean": "rimraf ./dist",
+    "build-ts": "tsup src/index.ts",
+    "build": "run-s clean build-ts",
+    "test": "vitest",
+    "pretty": "prettier . --check",
+    "pretty-fix": "prettier . --write",
+    "lint": "eslint --ext ts,tsx,js,tsx src",
+    "lint-fix": "pnpm lint --fix"
+  }
+}

package/src/index.ts

@@ -0,0 +1 @@
+export * from './marked-toc-for-series';

package/src/marked-toc-for-series.spec.ts

@@ -0,0 +1,55 @@
+import { Marked } from 'marked';
+import { describe, expect, it } from 'vitest';
+
+import { markedTocForSeries } from './marked-toc-for-series';
+
+describe(markedTocForSeries.name, () => {
+  it.each([
+    [
+      '<!-- TOC-SERIE:some -->',
+      undefined,
+      {
+        some: {
+          articles: [
+            { label: 'foo', url: 'http://example.com/foo' },
+            { label: 'bar baz', url: 'http://example.com/bar-baz' },
+          ],
+        },
+      },
+      '<nav data-serie="some">\n<ul>\n<li><a href="http://example.com/foo">foo</a></li>\n<li><a href="http://example.com/bar-baz">bar baz</a></li>\n</ul>\n</nav>\n',
+    ],
+    [
+      '<!-- TOC-SERIE:serie-id-with-dash -->',
+      'Serie',
+      {
+        'serie-id-with-dash': {
+          articles: [
+            { label: 'foo', url: 'http://example.com/foo' },
+            { label: 'bar baz', url: 'http://example.com/bar-baz' },
+          ],
+        },
+      },
+      '<nav data-serie="serie-id-with-dash">\n<h2>Serie</h2>\n<ul>\n<li><a href="http://example.com/foo">foo</a></li>\n<li><a href="http://example.com/bar-baz">bar baz</a></li>\n</ul>\n</nav>\n',
+    ],
+    [
+      '<!-- TOC-SERIE:serie_id_with_underscore -->',
+      'Série',
+      {
+        serie_id_with_underscore: {
+          articles: [
+            { label: 'foo', url: 'http://example.com/foo' },
+            { label: 'bar baz', url: 'http://example.com/bar-baz' },
+          ],
+        },
+      },
+      '<nav data-serie="serie_id_with_underscore">\n<h2>Série</h2>\n<ul>\n<li><a href="http://example.com/foo">foo</a></li>\n<li><a href="http://example.com/bar-baz">bar baz</a></li>\n</ul>\n</nav>\n',
+    ],
+    ['<!-- TOC-SERIE:empty -->', 'Yolo', { empty: { articles: [] } }, ''],
+    ['<!-- TOC-SERIE:not-existing -->', '', { some: { articles: [] } }, ''],
+  ])('should create TOC "%s"', (md, title, series, html) => {
+    const marked = new Marked({ headerIds: false, mangle: false });
+    marked.use(markedTocForSeries({ title, series }));
+
+    expect(marked.parse(md)).toBe(html);
+  });
+});

package/src/marked-toc-for-series.ts

@@ -0,0 +1,91 @@
+import { marked } from 'marked';
+import {
+  isDefined,
+  isDefinedAndNotEmpty,
+  isNotDefined,
+  isNotDefinedOrEmpty,
+} from '@anthonypena/fp';
+
+export type SeriesDef = Record<string, SerieDef>;
+
+export interface MarkedTocForSeriesOptions {
+  title?: string | undefined | null;
+  series: SeriesDef;
+}
+
+export interface SerieDef {
+  articles: ArticleDef[];
+}
+
+export interface ArticleDef {
+  label: string;
+  url: string;
+}
+
+export function markedTocForSeries({
+  title,
+  series,
+}: MarkedTocForSeriesOptions): marked.MarkedExtension {
+  return {
+    extensions: [
+      {
+        name: 'tocForSeries',
+        level: 'block',
+        start(src) {
+          return src.match(/<!-- TOC-SERIE:.* -->/)?.index;
+        },
+        tokenizer(src): TocForSeriesToken | undefined {
+          const match = /^<!-- TOC-SERIE:(.*) -->?/.exec(src);
+          if (isDefined(match)) {
+            const type = 'tocForSeries';
+            const raw = src.slice(0, src.indexOf('-->') + 3);
+            const serieId = match?.[1];
+            const token: TocForSeriesToken = { type, raw, serieId };
+            return token;
+          }
+          return undefined;
+        },
+        renderer(token) {
+          if (!isTocForSeriesToken(token)) {
+            return false;
+          }
+          const serie = series[token.serieId];
+          if (isNotDefined(serie) || isNotDefinedOrEmpty(serie.articles)) {
+            return '';
+          }
+
+          const titleHtml = isDefinedAndNotEmpty(title)
+            ? `<h2>${title}</h2>`
+            : undefined;
+          return rows(
+            `<nav data-serie="${token.serieId}">`,
+            titleHtml,
+            '<ul>',
+            ...serie.articles.map(
+              (article) =>
+                `<li><a href="${article.url}">${article.label}</a></li>`,
+            ),
+            '</ul>',
+            '</nav>',
+          );
+        },
+      },
+    ],
+  };
+}
+
+interface TocForSeriesToken extends marked.Tokens.Generic {
+  type: 'tocForSeries';
+  serieId: string;
+  raw: string;
+}
+
+export function isTocForSeriesToken(
+  token: TocForSeriesToken | { type: unknown },
+): token is TocForSeriesToken {
+  return token.type === 'tocForSeries';
+}
+
+function rows(...s: (string | undefined | null)[]): string {
+  return s.filter(isDefinedAndNotEmpty).join('\n') + '\n';
+}

package/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "extends": "@anthonypena/tsconfig/base.json",
+  "compilerOptions": {
+    "outDir": "dist",
+    "lib": ["ES2021"],
+    "module": "CommonJS"
+  },
+  "include": ["src/**/*.ts"],
+  "exclude": ["dist", "node_modules", "src/**/*.spec.ts"]
+}

package/tsup.config.ts

@@ -0,0 +1,12 @@
+import { defineConfig } from 'tsup';
+
+export default defineConfig({
+  entry: ['src/index.ts'],
+  splitting: false,
+  sourcemap: true,
+  format: 'esm',
+  clean: true,
+  dts: true,
+  bundle: true,
+  noExternal: [/^@anthonypena\/.*/],
+});