@canopycanopycanopy/b-ber-parser-footnotes 3.0.8-nav-memo.4 → 3.0.8-next.61

package/README.md

@@ -1,9 +1,25 @@
-# `@canopycanopycanopy/b-ber-parser-footnotes`
+# b-ber-parser-footnotes
 
-The `b-ber-parser-footnotes` package is used internally parse footnotes in Markdown.
+A markdown-it plugin that parses both inline (`^[…]`) and reference-style (`[^label]` / `[^label]: …`) footnotes from Markdown source and renders them as EPUB-compatible HTML. It emits footnote reference links with `epub:type="noteref"` and footnote list items with `epub:type="footnote"`, and injects hidden back-links (↵) into the footnote body. After processing a document the plugin strips the footnote block from the main token stream and passes it to a callback so the build pipeline can write footnotes to a separate `notes.xhtml` file. A `Counter` helper tracks numbering across pages, supporting both per-document and globally-grouped footnote lists (controlled by `bberState.config.group_footnotes`).
 
-## Install
+## Usage
 
+This plugin is consumed by the b-ber build pipeline's `render` and `footnotes` build steps:
+
+```js
+import footnotePlugin from '@canopycanopycanopy/b-ber-parser-footnotes'
+
+md.use(footnotePlugin, footnoteTokens => {
+  // footnoteTokens is the extracted footnote block for this document
+})
 ```
-$ npm i -g @canopycanopycanopy/b-ber-parser-footnotes
+
+The callback receives the collected footnote tokens; the pipeline writes them to `notes.xhtml`.
+
+## Dev
+
+```
+npm test
 ```
+
+The test suite currently contains only a `test.todo` placeholder — no assertions are implemented yet.

package/dist/index.js

@@ -1,11 +1,16 @@
 "use strict";
 
+var _Object$defineProperty = require("@babel/runtime-corejs3/core-js-stable/object/define-property");
 var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault");
+_Object$defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = footnotePlugin;
 var _isArray = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/array/is-array"));
 var _slice = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/instance/slice"));
 var _filter = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/instance/filter"));
 var _concat = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/instance/concat"));
-var _lodash = _interopRequireDefault(require("lodash.isundefined"));
+var _isUndefined = _interopRequireDefault(require("lodash/isUndefined"));
 var _State = _interopRequireDefault(require("@canopycanopycanopy/b-ber-lib/State"));
 var _counter = _interopRequireDefault(require("./counter"));
 /* eslint-disable camelcase */
@@ -36,7 +41,7 @@ function renderFootnoteRef(tokens, idx, options, env, slf) {
   const ref = counter.getRef();
   return `<a epub:type="noteref" class="footnote-ref" href="notes.xhtml#fn${ref}" id="fnref${ref}">${caption}</a>`;
 }
-function renderFootnoteBlockOpen( /* tokens, idx, options */
+function renderFootnoteBlockOpen(/* tokens, idx, options */
 ) {
   const start = counter.listCounter(_State.default.config.group_footnotes, _State.default.footnotes.length);
   return `<ol class="footnotes" start="${start}">`;
@@ -83,13 +88,13 @@ function renderFootnoteOpen(tokens, idx, _options, env, _self) {
 function renderFootnoteClose() {
   return '</li>';
 }
-function renderFootnoteAnchor( /*tokens, idx, options,env, slf */
+function renderFootnoteAnchor(/*tokens, idx, options,env, slf */
 ) {
   /* ↩ with escape code to prevent display as Apple Emoji on iOS */
   // return ' <a href="#fnref' + id + '">\u21a9\uFE0E</a>';
   return '';
 }
-module.exports = function footnotePlugin(md, callback) {
+function footnotePlugin(md, callback) {
   const {
     parseLinkLabel
   } = md.helpers;
@@ -248,7 +253,7 @@ module.exports = function footnotePlugin(md, callback) {
     if (pos >= max) return false;
     pos++;
     const label = (0, _slice.default)(_context3 = state.src).call(_context3, start + 2, pos - 1);
-    if ((0, _lodash.default)(state.env.footnotes.refs[`:${label}`])) return false;
+    if ((0, _isUndefined.default)(state.env.footnotes.refs[`:${label}`])) return false;
     if (!silent) {
       if (!state.env.footnotes.list) state.env.footnotes.list = [];
       if (state.env.footnotes.refs[`:${label}`] < 0) {
@@ -398,4 +403,4 @@ module.exports = function footnotePlugin(md, callback) {
   md.inline.ruler.after('image', 'footnote_inline', footnoteInline);
   md.inline.ruler.after('footnote_inline', 'footnote_ref', footnoteRef);
   md.core.ruler.after('inline', 'footnote_tail', footnoteTail);
-};
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@canopycanopycanopy/b-ber-parser-footnotes",
-  "version": "3.0.8-nav-memo.4+d47a9aae",
+  "version": "3.0.8-next.61+2bbec564",
   "description": "",
   "main": "dist/index.js",
   "scripts": {
@@ -25,13 +25,11 @@
     "rimraf": "^2.7.1"
   },
   "dependencies": {
-    "@canopycanopycanopy/b-ber-lib": "3.0.8-nav-memo.4+d47a9aae",
-    "@canopycanopycanopy/b-ber-logger": "3.0.8-nav-memo.4+d47a9aae",
-    "@canopycanopycanopy/b-ber-shapes-directives": "3.0.8-nav-memo.4+d47a9aae",
-    "@canopycanopycanopy/b-ber-templates": "3.0.8-nav-memo.4+d47a9aae",
-    "lodash": "^4.17.21",
-    "lodash.isundefined": "^3.0.1",
-    "tar": "^6.1.11"
+    "@canopycanopycanopy/b-ber-lib": "3.0.8-next.61+2bbec564",
+    "@canopycanopycanopy/b-ber-logger": "3.0.8-next.61+2bbec564",
+    "@canopycanopycanopy/b-ber-shapes-directives": "3.0.8-next.61+2bbec564",
+    "@canopycanopycanopy/b-ber-templates": "3.0.8-next.61+2bbec564",
+    "lodash": "^4.17.21"
   },
   "files": [
     "dist"
@@ -50,5 +48,5 @@
       "url": "https://maxwellsimmer.com"
     }
   ],
-  "gitHead": "d47a9aae74dec3e3225e363b2434c7abe0fcf21b"
+  "gitHead": "2bbec5643278f53becb0d2ba1f55edfe379d5587"
 }