@adobe/helix-markdown-support 2.0.0 → 3.1.1

package/.circleci/config.yml

@@ -1,8 +1,8 @@
 version: 2.1
 executors:
-  node12:
+  node14:
     docker:
-      - image: circleci/node:12
+      - image: circleci/node:14
     environment:
       NPM_CONFIG_PREFIX: ~/.npm-global
 
@@ -29,7 +29,7 @@ commands:
 
 jobs:
   build:
-    executor: node12
+    executor: node14
 
     steps:
       - setup

package/.eslintrc.cjs

@@ -0,0 +1,27 @@
+/*
+ * Copyright 2019 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+module.exports = {
+  root: true,
+  extends: '@adobe/helix',
+  env: {
+    node: true,
+    es6: true,
+  },
+  parserOptions: {
+    sourceType: 'module',
+    ecmaVersion: 2020,
+  },
+  rules: {
+    'import/extensions': 0,
+  },
+};

package/.github/workflows/semantic-release.yaml

@@ -10,10 +10,10 @@ jobs:
     if: "!contains(github.event.head_commit.message, '[skip ci]')"
     steps:
       - uses: actions/checkout@v2
-      - name: Use Node.js 12.x
+      - name: Use Node.js 14.x
         uses: actions/setup-node@v2
         with:
-          node-version: '12.x'
+          node-version: '14.x'
       - run: npm install
       - run: npm test
       - run: npm run semantic-release

package/.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx lint-staged

package/.mocha-multi.json

@@ -0,0 +1,6 @@
+{
+    "reporterEnabled": "spec,xunit",
+    "xunitReporterOptions": {
+        "output": "junit/test-results.xml"
+    }
+}

package/.releaserc.cjs

@@ -0,0 +1,16 @@
+module.exports = {
+    plugins: [
+      "@semantic-release/commit-analyzer",
+      "@semantic-release/release-notes-generator",
+      ["@semantic-release/changelog", {
+        "changelogFile": "CHANGELOG.md",
+      }],
+      "@semantic-release/npm",
+      ["@semantic-release/git", {
+        "assets": ["package.json", "CHANGELOG.md"],
+        "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
+      }],
+      ["@semantic-release/github", {}]
+    ],
+  branches: [ 'main' ],
+  };

package/CHANGELOG.md

@@ -1,3 +1,36 @@
+## [3.1.1](https://github.com/adobe/helix-markdown-support/compare/v3.1.0...v3.1.1) (2022-01-15)
+
+
+### Bug Fixes
+
+* **deps:** update external fixes ([791a84b](https://github.com/adobe/helix-markdown-support/commit/791a84b8c3ac94b745522668ffac59e10b98a4c2))
+
+# [3.1.0](https://github.com/adobe/helix-markdown-support/compare/v3.0.0...v3.1.0) (2022-01-14)
+
+
+### Features
+
+* improve sanitize-headings to move leading images before heading ([292dc72](https://github.com/adobe/helix-markdown-support/commit/292dc72dbe43def0d97e8f1c528eeb065b3bff12)), closes [#83](https://github.com/adobe/helix-markdown-support/issues/83)
+
+# [3.0.0](https://github.com/adobe/helix-markdown-support/compare/v2.0.1...v3.0.0) (2021-12-07)
+
+
+### Features
+
+* convert to esm ([0b5e09b](https://github.com/adobe/helix-markdown-support/commit/0b5e09bac1e7e26128d7af8f25c85eadc82ff56c))
+
+
+### BREAKING CHANGES
+
+* only esm supported
+
+## [2.0.1](https://github.com/adobe/helix-markdown-support/compare/v2.0.0...v2.0.1) (2021-07-23)
+
+
+### Bug Fixes
+
+* allow html in table cells ([9afe468](https://github.com/adobe/helix-markdown-support/commit/9afe468057101b28d17ae218f45666e1ec9829c6))
+
 # [2.0.0](https://github.com/adobe/helix-markdown-support/compare/v1.5.0...v2.0.0) (2021-06-09)
 
 

package/package.json

@@ -1,12 +1,14 @@
 {
   "name": "@adobe/helix-markdown-support",
-  "version": "2.0.0",
+  "version": "3.1.1",
   "description": "Helix Markdown Support",
+  "type": "module",
   "scripts": {
-    "test": " nyc mocha",
-    "test-ci": "nyc mocha --reporter xunit --reporter-options output=./junit/test-results.xml && codecov",
+    "test": " c8 mocha",
+    "test-ci": "c8 mocha && codecov",
     "lint": "eslint .",
-    "semantic-release": "semantic-release"
+    "semantic-release": "semantic-release",
+    "prepare": "husky install"
   },
   "repository": {
     "type": "git",
@@ -20,47 +22,44 @@
   "homepage": "https://github.com/adobe/helix-markdown-support#readme",
   "main": "src/index.js",
   "dependencies": {
-    "hast-util-to-html": "7.1.3",
+    "hast-util-to-html": "8.0.3",
     "js-yaml": "4.1.0",
-    "mdast-util-to-hast": "10.2.0",
+    "mdast-util-to-hast": "12.1.0",
     "unist-util-find": "1.0.2",
-    "unist-util-visit": "2.0.3"
+    "unist-util-visit": "4.1.0"
+  },
+  "mocha": {
+    "spec": "test/**/*.test.js",
+    "recursive": "true",
+    "reporter": "mocha-multi-reporters",
+    "reporter-options": "configFile=.mocha-multi.json"
   },
   "peerDependencies": {
-    "unified": "9.x"
+    "unified": "10.x"
   },
   "devDependencies": {
-    "@adobe/eslint-config-helix": "1.1.5",
-    "@semantic-release/changelog": "5.0.1",
-    "@semantic-release/git": "9.0.0",
-    "@semantic-release/npm": "7.1.3",
-    "ajv": "8.5.0",
-    "codecov": "3.8.2",
-    "commitizen": "4.2.4",
-    "cz-conventional-changelog": "3.3.0",
-    "eslint": "7.28.0",
+    "@adobe/eslint-config-helix": "1.3.2",
+    "@semantic-release/changelog": "6.0.1",
+    "@semantic-release/git": "10.0.1",
+    "c8": "7.11.0",
+    "codecov": "3.8.3",
+    "eslint": "8.6.0",
     "eslint-plugin-header": "3.1.1",
-    "eslint-plugin-import": "2.23.4",
-    "fs-extra": "10.0.0",
-    "ghooks": "2.0.4",
+    "eslint-plugin-import": "2.25.4",
+    "husky": "7.0.4",
     "junit-report-builder": "3.0.0",
-    "lint-staged": "11.0.0",
+    "lint-staged": "12.1.7",
     "mdast-builder": "1.1.1",
-    "mocha": "9.0.0",
-    "nyc": "15.1.0",
-    "remark-gfm": "1.0.0",
-    "remark-parse": "9.0.0",
-    "remark-stringify": "9.0.1",
-    "semantic-release": "17.4.3",
-    "unified": "9.2.1",
-    "unist-util-inspect": "6.0.1"
+    "mocha": "9.1.4",
+    "mocha-multi-reporters": "1.5.1",
+    "remark-gfm": "3.0.1",
+    "remark-parse": "10.0.1",
+    "remark-stringify": "10.0.2",
+    "semantic-release": "18.0.1",
+    "unified": "10.1.1",
+    "unist-util-inspect": "7.0.0"
   },
   "lint-staged": {
     "*.js": "eslint"
-  },
-  "config": {
-    "ghooks": {
-      "pre-commit": "npx lint-staged"
-    }
   }
 }

package/src/index.js

@@ -10,24 +10,12 @@
  * governing permissions and limitations under the License.
  */
 
-const remarkMatter = require('./remark-matter');
-const robustTables = require('./mdast-robust-tables.js');
-const breaksAsSpaces = require('./remark-breaks-as-spaces.js');
-const sanitizeHeading = require('./mdast-sanitize-heading.js');
-const suppressSpaceCode = require('./mdast-suppress-spacecode.js');
-const sanitizeFormats = require('./mdast-sanitize-formats.js');
-const fixCodeFlow = require('./mdast-fix-code-flow.js');
-const sanitizeLinks = require('./mdast-sanitize-links.js');
-const sanitizeText = require('./mdast-sanitize-text.js');
-
-module.exports = {
-  remarkMatter,
-  robustTables,
-  breaksAsSpaces,
-  sanitizeHeading,
-  suppressSpaceCode,
-  sanitizeFormats,
-  fixCodeFlow,
-  sanitizeLinks,
-  sanitizeText,
-};
+export { default as remarkMatter } from './remark-matter/index.js';
+export { default as robustTables } from './mdast-robust-tables.js';
+export { default as breaksAsSpaces } from './remark-breaks-as-spaces.js';
+export { default as sanitizeHeading } from './mdast-sanitize-heading.js';
+export { default as suppressSpaceCode } from './mdast-suppress-spacecode.js';
+export { default as sanitizeFormats } from './mdast-sanitize-formats.js';
+export { default as fixCodeFlow } from './mdast-fix-code-flow.js';
+export { default as sanitizeLinks } from './mdast-sanitize-links.js';
+export { default as sanitizeText } from './mdast-sanitize-text.js';

package/src/mdast-fix-code-flow.js

@@ -10,7 +10,7 @@
  * governing permissions and limitations under the License.
  */
 /* eslint-disable no-param-reassign */
-const visit = require('unist-util-visit');
+import { visit, CONTINUE } from 'unist-util-visit';
 
 /**
  * ensures that `code` is at a flow level. i.e. outside a paragraph
@@ -18,7 +18,7 @@ const visit = require('unist-util-visit');
  * @param {object} tree
  * @returns {object} The modified (original) tree.
  */
-function fixCodeFlow(tree) {
+export default function fixCodeFlow(tree) {
   visit(tree, (node, index, parent) => {
     if (node.type === 'paragraph' && node.children) {
       for (let i = 0; i < node.children.length; i += 1) {
@@ -50,9 +50,7 @@ function fixCodeFlow(tree) {
       }
     }
     // return index;
-    return visit.CONTINUE;
+    return CONTINUE;
   });
   return tree;
 }
-
-module.exports = fixCodeFlow;

package/src/mdast-robust-tables.js

@@ -10,9 +10,9 @@
  * governing permissions and limitations under the License.
  */
 /* eslint-disable no-param-reassign */
-const md2hast = require('mdast-util-to-hast');
-const hast2html = require('hast-util-to-html');
-const visit = require('unist-util-visit');
+import { toHast as md2hast } from 'mdast-util-to-hast';
+import { toHtml as hast2html } from 'hast-util-to-html';
+import { visit, CONTINUE } from 'unist-util-visit';
 
 /**
  * Converts tables to HTML
@@ -20,17 +20,15 @@ const visit = require('unist-util-visit');
  * @param {object} tree
  * @returns {object} The modified (original) tree.
  */
-function robustTables(tree) {
+export default function robustTables(tree) {
   visit(tree, (node) => {
     if (node.type !== 'table') {
-      return visit.CONTINUE;
+      return CONTINUE;
     }
     let html = '<table>\n';
-    /* istanbul ignore next */
-    (node.children || []).forEach((row) => {
+    (node.children /* c8 ignore next */ || []).forEach((row) => {
       html += '  <tr>\n';
-      /* istanbul ignore next */
-      (row.children || []).forEach((cell) => {
+      (row.children /* c8 ignore next */ || []).forEach((cell) => {
         let align = '';
         if (cell.align === 'right') {
           align = ' align="right"';
@@ -52,14 +50,17 @@ function robustTables(tree) {
           children = children[0].children;
         }
 
-        /* istanbul ignore next */
-        (children || []).forEach((child) => {
-          const cellHtml = hast2html(md2hast(child));
-          if (child.type === 'code') {
-            // code needs special treatment, otherwise the newlines disappear.
-            html += cellHtml.replace(/\r?\n/g, '<br>');
+        (children /* c8 ignore next */ || []).forEach((child) => {
+          if (child.type === 'html') {
+            html += child.value;
           } else {
-            html += cellHtml.replace(/\r?\n/g, ' ');
+            const cellHtml = hast2html(md2hast(child));
+            if (child.type === 'code') {
+              // code needs special treatment, otherwise the newlines disappear.
+              html += cellHtml.replace(/\r?\n/g, '<br>');
+            } else {
+              html += cellHtml.replace(/\r?\n/g, ' ');
+            }
           }
         });
         html += '</td>\n';
@@ -70,9 +71,7 @@ function robustTables(tree) {
     node.type = 'html';
     node.value = html;
     delete node.children;
-    return visit.CONTINUE;
+    return CONTINUE;
   });
   return tree;
 }
-
-module.exports = robustTables;

package/src/mdast-sanitize-formats.js

@@ -9,7 +9,7 @@
  * OF ANY KIND, either express or implied. See the License for the specific language
  * governing permissions and limitations under the License.
  */
-const visit = require('unist-util-visit');
+import { visit, CONTINUE } from 'unist-util-visit';
 
 /**
  * Sanitizes text:
@@ -19,7 +19,7 @@ const visit = require('unist-util-visit');
  * @param {object} tree
  * @returns {object} The modified (original) tree.
  */
-function sanitizeFormats(tree) {
+export default function sanitizeFormats(tree) {
   visit(tree, (node, index, parent) => {
     const { children: siblings = [] } = parent || {};
     const { children } = node;
@@ -43,9 +43,7 @@ function sanitizeFormats(tree) {
         }
       }
     }
-    return visit.CONTINUE;
+    return CONTINUE;
   });
   return tree;
 }
-
-module.exports = sanitizeFormats;

package/src/mdast-sanitize-heading.js

@@ -9,42 +9,53 @@
  * OF ANY KIND, either express or implied. See the License for the specific language
  * governing permissions and limitations under the License.
  */
-const visit = require('unist-util-visit');
+import { visit } from 'unist-util-visit';
 
 /**
  * Sanitizes headings:
- * - (re)move images
+ * - (re)move images ('before', 'both', 'after')
  *
  * @param {object} tree
+ * @param {object} [opts] options
+ * @param {string} [opts.imageHandling] specifies how images are handled. defaults to 'after'.
  * @returns {object} The modified (original) tree.
  */
-function sanitizeHeading(tree) {
+export default function sanitizeHeading(tree, opts = {}) {
+  const { imageHandling = 'after' } = opts;
   visit(tree, (node, index, parent) => {
     const { children: siblings = [] } = parent || {};
     const { children = [] } = node;
+    let after = index + 1;
     if (node.type === 'heading') {
       for (let i = 0; i < children.length; i += 1) {
         const child = children[i];
         if (child.type === 'image') {
-          // move after heading
-          children.splice(i, 1);
-          i -= 1;
           const para = {
             type: 'paragraph',
             children: [child],
           };
-          siblings.splice(index + 1, 0, para);
+          children.splice(i, 1);
+          i -= 1;
+          if ((i < 0 && imageHandling !== 'after') || imageHandling === 'before') {
+            // move before heading
+            siblings.splice(index, 0, para);
+            // eslint-disable-next-line no-param-reassign
+            index += 1;
+            after = index + 1;
+          } else {
+            // move after heading
+            siblings.splice(after, 0, para);
+            after += 1;
+          }
         }
       }
       // remove empty headings
       if (!children.length) {
         siblings.splice(index, 1);
-        return index;
+        after -= 1;
       }
     }
-    return visit.CONTINUE;
+    return after;
   });
   return tree;
 }
-
-module.exports = sanitizeHeading;

package/src/mdast-sanitize-links.js

@@ -9,8 +9,8 @@
  * OF ANY KIND, either express or implied. See the License for the specific language
  * governing permissions and limitations under the License.
  */
-const visit = require('unist-util-visit');
-const find = require('unist-util-find');
+import { visit, CONTINUE } from 'unist-util-visit';
+import find from 'unist-util-find';
 
 /**
  * Sanitizes links:
@@ -19,7 +19,7 @@ const find = require('unist-util-find');
  * @param {object} tree
  * @returns {object} The modified (original) tree.
  */
-function sanitizeLinks(tree) {
+export default function sanitizeLinks(tree) {
   visit(tree, (node, index, parent) => {
     const { children = [] } = node;
     if (node.type === 'link' && children.length === 1) {
@@ -61,9 +61,7 @@ function sanitizeLinks(tree) {
         }
       }
     }
-    return visit.CONTINUE;
+    return CONTINUE;
   });
   return tree;
 }
-
-module.exports = sanitizeLinks;

package/src/mdast-sanitize-text.js

@@ -9,7 +9,7 @@
  * OF ANY KIND, either express or implied. See the License for the specific language
  * governing permissions and limitations under the License.
  */
-const visit = require('unist-util-visit');
+import { visit, CONTINUE } from 'unist-util-visit';
 
 /**
  * Sanitizes text:
@@ -22,7 +22,7 @@ const visit = require('unist-util-visit');
  * @param {object} tree
  * @returns {object} The modified (original) tree.
  */
-function sanitizeText(tree) {
+export default function sanitizeText(tree) {
   visit(tree, (node, index, parent) => {
     const { children: siblings = [] } = parent || {};
     const { children = [] } = node;
@@ -107,9 +107,7 @@ function sanitizeText(tree) {
         }
       }
     }
-    return visit.CONTINUE;
+    return CONTINUE;
   });
   return tree;
 }
-
-module.exports = sanitizeText;

package/src/mdast-suppress-spacecode.js

@@ -9,7 +9,7 @@
  * OF ANY KIND, either express or implied. See the License for the specific language
  * governing permissions and limitations under the License.
  */
-const visit = require('unist-util-visit');
+import { visit, CONTINUE } from 'unist-util-visit';
 
 /**
  * Looks for text starting with 4 spaces. As this would render as code in some markdown,
@@ -18,7 +18,7 @@ const visit = require('unist-util-visit');
  * @param {object} tree
  * @returns {object} The modified (original) tree.
  */
-function suppressSpaceCode(tree) {
+export default function suppressSpaceCode(tree) {
   visit(tree, (child, index, parent) => {
     const { children } = parent || {};
     if (child.type === 'text'
@@ -27,9 +27,7 @@ function suppressSpaceCode(tree) {
       // eslint-disable-next-line no-param-reassign
       child.value = child.value.replace(/^\s+/, ' ');
     }
-    return visit.CONTINUE;
+    return CONTINUE;
   });
   return tree;
 }
-
-module.exports = suppressSpaceCode;

package/src/remark-breaks-as-spaces.js

@@ -13,7 +13,7 @@
 /**
  * Remark extension that handles soft-breaks correctly.
  */
-function softBreak() {
+export default function softBreak() {
   function handleBreak(node, _, context) {
     if (context.stack.indexOf('tableCell') !== -1) {
       return '   ';
@@ -31,5 +31,3 @@ function softBreak() {
     },
   });
 }
-
-module.exports = softBreak;

package/src/remark-matter/from-markdown.js

@@ -9,7 +9,7 @@
  * OF ANY KIND, either express or implied. See the License for the specific language
  * governing permissions and limitations under the License.
  */
-const jsYaml = require('js-yaml');
+import jsYaml from 'js-yaml';
 
 function open(token) {
   this.enter({ type: 'yaml', value: '', payload: {} }, token);
@@ -38,7 +38,7 @@ function value(token) {
 }
 
 // eslint-disable-next-line no-unused-vars
-function fromMarkdown(options = {}) {
+export default function fromMarkdown(options = {}) {
   return {
     enter: {
       yaml: open,
@@ -49,5 +49,3 @@ function fromMarkdown(options = {}) {
     },
   };
 }
-
-module.exports = fromMarkdown;

package/src/remark-matter/index.js

@@ -9,9 +9,9 @@
  * OF ANY KIND, either express or implied. See the License for the specific language
  * governing permissions and limitations under the License.
  */
-const fromMarkdown = require('./from-markdown.js');
-const toMarkdown = require('./to-markdown.js');
-const syntax = require('./syntax.js');
+import fromMarkdown from './from-markdown.js';
+import toMarkdown from './to-markdown.js';
+import syntax from './syntax.js';
 
 /**
  * Front- and mid-matter remark plugin.
@@ -83,11 +83,11 @@ const syntax = require('./syntax.js');
  * @param {object} options Plugin options
  * @param {Function} options.errorHandler Function that is invoked on yaml parsing errors.
  */
-function matterPlugin(options) {
+export default function matterPlugin(options) {
   const data = this.data();
 
   function add(field, value) {
-    /* istanbul ignore next */
+    /* c8 ignore next 2 */
     if (data[field]) {
       data[field].push(value);
     } else {
@@ -99,5 +99,3 @@ function matterPlugin(options) {
   add('fromMarkdownExtensions', fromMarkdown(options));
   add('toMarkdownExtensions', toMarkdown(options));
 }
-
-module.exports = matterPlugin;

package/src/remark-matter/syntax.js

@@ -10,7 +10,7 @@
  * governing permissions and limitations under the License.
  */
 /* eslint-disable no-use-before-define */
-const jsYaml = require('js-yaml');
+import jsYaml from 'js-yaml';
 
 const type = (v) => ((v !== undefined && v !== null) ? v.constructor : v);
 
@@ -33,11 +33,9 @@ function validYaml(str, errorHandler) {
         if (Array.isArray(payload)) {
           payloadType = 'Array';
         }
-        errorHandler(
-          'Found ambiguous frontmatter block: Block contains valid yaml, but '
+        errorHandler('Found ambiguous frontmatter block: Block contains valid yaml, but '
           + `it's data type is "${payloadType}" instead of Object. `
-          + 'Make sure your yaml blocks contain only key-value pairs at the root level!', str,
-        );
+          + 'Make sure your yaml blocks contain only key-value pairs at the root level!', str);
       }
       return false;
     }
@@ -265,12 +263,10 @@ function parse(options) {
   }
 }
 
-function create(options = {}) {
+export default function create(options = {}) {
   return {
     flow: {
       [CODE_DASH]: [parse(options)],
     },
   };
 }
-
-module.exports = create;

package/src/remark-matter/to-markdown.js

@@ -9,12 +9,10 @@
  * OF ANY KIND, either express or implied. See the License for the specific language
  * governing permissions and limitations under the License.
  */
-function toMarkdown() {
+export default function toMarkdown() {
   return {
     handlers: {
       yaml: (node) => `---\n${node.value.trim()}\n---`,
     },
   };
 }
-
-module.exports = toMarkdown;