@canopycanopycanopy/b-ber-grammar-footnotes 3.1.0 → 4.0.0

package/README.md

@@ -1,9 +1,20 @@
-# `@canopycanopycanopy/b-ber-grammar-footnotes`
+# b-ber-grammar-footnotes
 
-The `b-ber-grammar-footnotes` package renders b-ber's custom `footnotes` Markdown extension (directive) into HTML. More information about b-ber directives can be found in the [All directives](https://github.com/triplecanopy/b-ber/wiki/all-directives) page in the b-ber [Wiki](https://github.com/triplecanopy/b-ber/wiki).
+Handles footnote collection and rendering as a MarkdownIt core rule (not a container directive). After MarkdownIt processes a source file, this package's plugin function receives the full token stream, prepends a `<section class="footnotes break-after">` wrapper with an `<h1>` heading (using the spine entry's title for the current file), appends the closing `</section>`, renders the augmented token stream to HTML, and stores the result in global state under `state.footnotes`. Footnote pages are generated later by `b-ber-parser-footnotes` from that collected state.
 
-## Install
+## Usage
 
+Registered as a MarkdownIt core rule by the rendering engine:
+
+```js
+import footnotes from '@canopycanopycanopy/b-ber-grammar-footnotes'
+// default export is a factory: (self) => plugin(tokens)
 ```
-$ npm i -g @canopycanopycanopy/b-ber-grammar-footnotes
+
+## Dev
+
 ```
+npm test
+```
+
+Tests are in `__tests__/index.test.js`.

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+//#region src/index.d.ts
+declare function markdownItFootnotePlugin(self: any): (tokens: any) => void;
+export = markdownItFootnotePlugin;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/index.ts"],"mappings":";iBAEwB,wBAAA,CAAyB,IAAA,SACxB,MAAM;AAAA"}

package/dist/index.js

@@ -1,59 +1,41 @@
-"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 = markdownItFootnotePlugin;
-var _find = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/instance/find"));
-var _State = _interopRequireDefault(require("@canopycanopycanopy/b-ber-lib/State"));
+let _canopycanopycanopy_b_ber_lib = require("@canopycanopycanopy/b-ber-lib");
+//#region src/index.ts
 function markdownItFootnotePlugin(self) {
-  return function plugin(tokens) {
-    const {
-      fileName
-    } = self;
-    const entry = (0, _find.default)(_State.default).call(_State.default, 'spine.flattened', {
-      fileName
-    });
-    const title = (entry === null || entry === void 0 ? void 0 : entry.title) || fileName;
-
-    // Add footnote container and heading. Doing this here instead of in
-    // `footnotes.js` because we need the file's title
-    tokens.unshift({
-      type: 'block',
-      tag: 'section',
-      attrs: [['class', 'footnotes break-after']],
-      nesting: 1,
-      block: true
-    }, {
-      type: 'block',
-      tag: 'h1',
-      nesting: 1,
-      block: true
-    }, {
-      type: 'text',
-      block: false,
-      content: title
-    }, {
-      type: 'block',
-      tag: 'h1',
-      nesting: -1
-    });
-
-    // add closing section tag
-    tokens.push({
-      type: 'block',
-      tag: 'section',
-      nesting: -1
-    });
-    const notes = self.markdownIt.renderer.render(tokens, 0, {
-      reference: `${fileName}.xhtml`
-    });
-    _State.default.add('footnotes', {
-      fileName,
-      title,
-      notes
-    });
-  };
-}
+	return function plugin(tokens) {
+		const { fileName } = self;
+		const title = _canopycanopycanopy_b_ber_lib.State.find("spine.flattened", { fileName })?.title || fileName;
+		tokens.unshift({
+			type: "block",
+			tag: "section",
+			attrs: [["class", "footnotes break-after"]],
+			nesting: 1,
+			block: true
+		}, {
+			type: "block",
+			tag: "h1",
+			nesting: 1,
+			block: true
+		}, {
+			type: "text",
+			block: false,
+			content: title
+		}, {
+			type: "block",
+			tag: "h1",
+			nesting: -1
+		});
+		tokens.push({
+			type: "block",
+			tag: "section",
+			nesting: -1
+		});
+		const notes = self.markdownIt.renderer.render(tokens, 0, { reference: `${fileName}.xhtml` });
+		_canopycanopycanopy_b_ber_lib.State.add("footnotes", {
+			fileName,
+			title,
+			notes
+		});
+	};
+}
+//#endregion
+module.exports = markdownItFootnotePlugin;

package/package.json

@@ -1,14 +1,12 @@
 {
   "name": "@canopycanopycanopy/b-ber-grammar-footnotes",
-  "version": "3.1.0",
+  "version": "4.0.0",
   "description": "",
   "main": "dist/index.js",
   "scripts": {
-    "prepare:dist": "BABEL_ENV=production babel --config-file ../../babel.config.js -d dist/ src/ --ignore **/__tests__/**",
-    "clean": "rimraf dist",
-    "prepare": "npm run clean && npm run prepare:dist",
-    "build": "npm run prepare",
-    "watch": "BABEL_ENV=production babel --config-file ../../babel.config.js -d dist/ src/ --watch src",
+    "build": "tsdown",
+    "watch": "tsdown --watch",
+    "typecheck": "tsc --noEmit",
     "test": "jest"
   },
   "author": "Triple Canopy <b-ber@canopycanopycanopy.com> (https://triplecanopy.github.io/)",
@@ -17,15 +15,15 @@
     "access": "public"
   },
   "devDependencies": {
-    "@babel/cli": "^7.10.5",
-    "@babel/core": "^7.10.5",
-    "@babel/preset-env": "^7.10.4",
-    "browserslist": "^4.17.4",
-    "jest": "^26.6.3",
-    "rimraf": "^2.7.1"
+    "@swc/core": "^1.15.40",
+    "@swc/jest": "^0.2.39",
+    "jest": "^29.7.0",
+    "rimraf": "^2.7.1",
+    "tsdown": "^0.22.1",
+    "typescript": "^6.0.3"
   },
   "dependencies": {
-    "@canopycanopycanopy/b-ber-lib": "3.1.0",
+    "@canopycanopycanopy/b-ber-lib": "4.0.0",
     "lodash": "^4.17.21",
     "lodash.find": "latest",
     "tar": "^6.1.11"
@@ -47,5 +45,6 @@
       "url": "https://maxwellsimmer.com"
     }
   ],
-  "gitHead": "59963709eda1a8eb12dde95405f8f01086d12cc7"
+  "gitHead": "435b9c7e6b97d3fbdeb21f2308283597040ebfc8",
+  "types": "dist/index.d.ts"
 }