@canopycanopycanopy/b-ber-grammar-renderer 3.0.8-nav.0 → 3.0.8-next.61

package/README.md

@@ -1,9 +1,20 @@
-# `@canopycanopycanopy/b-ber-grammar-renderer`
+# b-ber-grammar-renderer
 
-The `b-ber-grammar-renderer` package is used internally by b-ber to render containing custom Markdown extensions (directives) 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).
+The shared MarkdownIt container renderer factory used by block-level grammar packages. Exports a single `createRenderer` function that takes a `render` function, `markerOpen` and `markerClose` regexes, and a `context` object, and returns a MarkdownIt container plugin configuration object with `marker`, `minMarkers`, `markerOpen`, `markerClose`, and a `validateOpen` method. The `validateOpen` method enforces that every opening directive has a unique `id`, tracks open directive ids in global state (`state.cursor`), and validates that exit directives match a previously opened directive. Packages that need custom close-time behaviour (e.g. `b-ber-grammar-pullquote`) do not use this factory and implement their own renderer.
 
-## Install
+## Usage
 
+Imported by `b-ber-grammar-dialogue`, `b-ber-grammar-gallery`, `b-ber-grammar-section`, and `b-ber-grammar-spread`:
+
+```js
+import createRenderer from '@canopycanopycanopy/b-ber-grammar-renderer'
+// Returns a MarkdownIt container plugin config object
 ```
-$ npm i -g @canopycanopycanopy/b-ber-grammar-renderer
+
+## Dev
+
 ```
+npm test
+```
+
+Tests are in `__tests__/index.test.js`.

package/dist/index.js

@@ -8,7 +8,7 @@ _Object$defineProperty(exports, "__esModule", {
 exports.default = void 0;
 var _trim = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/instance/trim"));
 var _indexOf = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/instance/index-of"));
-var _lodash = _interopRequireDefault(require("lodash.isundefined"));
+var _isUndefined = _interopRequireDefault(require("lodash/isUndefined"));
 var _State = _interopRequireDefault(require("@canopycanopycanopy/b-ber-lib/State"));
 var _bBerLogger = _interopRequireDefault(require("@canopycanopycanopy/b-ber-logger"));
 var _bBerShapesDirectives = require("@canopycanopycanopy/b-ber-shapes-directives");
@@ -33,11 +33,11 @@ const renderer = ({
 
     // It's a directive - check to see if it's well-formed.
     const [, type, id] = match;
-    if ((0, _lodash.default)(id)) {
+    if ((0, _isUndefined.default)(id)) {
       // The directive's missing an `id` attribute, so we extract the
       // fileName from `context` which we've stored in back in
       // `md/index.es6`, and passed into our `renderer`
-      _bBerLogger.default.error(`Missing [id] for [${exports.default.name}:start] at ${context.fileName}.md:${line}`);
+      _bBerLogger.default.error(`Missing [id] for [${type}:start] at ${context.fileName}.md:${line}`);
 
       // Let the parser know that this wasn't a match
       return false;
@@ -73,5 +73,4 @@ const renderer = ({
     }
   }
 });
-var _default = renderer;
-exports.default = _default;
+var _default = exports.default = renderer;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@canopycanopycanopy/b-ber-grammar-renderer",
-  "version": "3.0.8-nav.0+24db1e6b",
+  "version": "3.0.8-next.61+2bbec564",
   "description": "",
   "main": "dist/index.js",
   "scripts": {
@@ -25,12 +25,10 @@
     "rimraf": "^2.7.1"
   },
   "dependencies": {
-    "@canopycanopycanopy/b-ber-lib": "3.0.8-nav.0+24db1e6b",
-    "@canopycanopycanopy/b-ber-logger": "3.0.8-nav.0+24db1e6b",
-    "@canopycanopycanopy/b-ber-shapes-directives": "3.0.8-nav.0+24db1e6b",
-    "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",
+    "lodash": "^4.17.21"
   },
   "files": [
     "dist"
@@ -49,5 +47,5 @@
       "url": "https://maxwellsimmer.com"
     }
   ],
-  "gitHead": "24db1e6bb491faae0d52c6dadc09d974a5a31cf5"
+  "gitHead": "2bbec5643278f53becb0d2ba1f55edfe379d5587"
 }