@adobe/helix-markdown-support 6.0.1 → 6.1.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [6.1.0](https://github.com/adobe/helix-markdown-support/compare/v6.0.2...v6.1.0) (2023-01-20)
+
+
+### Features
+
+* add remark-gfm-nolink ([#167](https://github.com/adobe/helix-markdown-support/issues/167)) ([f10fa62](https://github.com/adobe/helix-markdown-support/commit/f10fa627d8a844c0d01a5727a01ecdea4177f36e))
+
+## [6.0.2](https://github.com/adobe/helix-markdown-support/compare/v6.0.1...v6.0.2) (2023-01-20)
+
+
+### Bug Fixes
+
+* add root phrasing helper ([#166](https://github.com/adobe/helix-markdown-support/issues/166)) ([4a875b5](https://github.com/adobe/helix-markdown-support/commit/4a875b545e191ad7a10e749256c1955972c5a08e))
+
 ## [6.0.1](https://github.com/adobe/helix-markdown-support/compare/v6.0.0...v6.0.1) (2023-01-18)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-markdown-support",
-  "version": "6.0.1",
+  "version": "6.1.0",
   "description": "Helix Markdown Support",
   "type": "module",
   "scripts": {
@@ -27,8 +27,19 @@
   "dependencies": {
     "hast-util-to-html": "8.0.4",
     "js-yaml": "4.1.0",
+    "mdast-util-gfm-footnote": "1.0.1",
+    "mdast-util-gfm-strikethrough": "1.0.2",
+    "mdast-util-gfm-table": "1.0.6",
+    "mdast-util-gfm-task-list-item": "1.0.1",
+    "mdast-util-phrasing": "3.0.0",
     "mdast-util-to-hast": "12.2.5",
+    "micromark-extension-gfm-footnote": "1.0.4",
+    "micromark-extension-gfm-strikethrough": "1.0.4",
+    "micromark-extension-gfm-table": "1.0.5",
+    "micromark-extension-gfm-tagfilter": "1.0.1",
+    "micromark-extension-gfm-task-list-item": "1.0.3",
     "micromark-util-character": "1.1.0",
+    "micromark-util-combine-extensions": "1.0.0",
     "micromark-util-symbol": "1.0.1",
     "unist-util-find": "1.0.2",
     "unist-util-visit": "4.1.1"
@@ -62,8 +73,10 @@
     "mocha": "10.2.0",
     "mocha-multi-reporters": "1.5.1",
     "rehype-format": "4.0.1",
+    "rehype-stringify": "9.0.3",
     "remark-gfm": "3.0.1",
     "remark-parse": "10.0.1",
+    "remark-rehype": "10.1.0",
     "remark-stringify": "10.0.2",
     "semantic-release": "19.0.5",
     "unified": "10.1.2",

package/src/index.js

@@ -16,8 +16,10 @@ 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 fixRootPhrasing } from './mdast-fix-root-phrasing.js';
 export { default as sanitizeLinks } from './mdast-sanitize-links.js';
 export { default as sanitizeText } from './mdast-sanitize-text.js';
 export { default as sanitizeTextAndFormats } from './mdast-sanitize-text-and-formats.js';
 export { default as imageReferences } from './mdast-image-references.js';
 export { default as dereference } from './mdast-dereference.js';
+export { default as remarkGfmNoLink } from './remark-gfm-nolink.js';

package/src/mdast-fix-root-phrasing.js

@@ -0,0 +1,45 @@
+/*
+ * Copyright 2021 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.
+ */
+import { phrasing } from 'mdast-util-phrasing';
+
+function wrap(children, from, to) {
+  const para = {
+    type: 'paragraph',
+  };
+  para.children = children.splice(from, to - from, para);
+}
+
+/**
+ * ensures that the root node has no phrasing children.
+ *
+ * @param {object} tree
+ * @returns {object} The modified (original) tree.
+ */
+export default function fixRootPhrasing(tree) {
+  const { children } = tree;
+  let firstPhrasing = -1;
+  for (let i = 0; i < children.length; i += 1) {
+    if (phrasing(children[i])) {
+      if (firstPhrasing < 0) {
+        firstPhrasing = i;
+      }
+    } else if (firstPhrasing >= 0) {
+      wrap(children, firstPhrasing, i);
+      i = firstPhrasing;
+      firstPhrasing = -1;
+    }
+  }
+  if (firstPhrasing >= 0) {
+    wrap(children, firstPhrasing, children.length);
+  }
+  return tree;
+}

package/src/mdast-util-gfm-nolink.js

@@ -0,0 +1,93 @@
+/*
+ * Copyright 2021 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.
+ */
+
+/*
+copied from
+https://github.com/micromark/micromark-extension-gfm/blob/7bc6b6f3baf941f877d7b2111e9257b21b13b37e/index.js
+
+(The MIT License)
+
+Copyright (c) 2020 Titus Wormer <tituswormer@gmail.com>
+
+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.
+ */
+
+/**
+ * @typedef {import('mdast-util-from-markdown').Extension} FromMarkdownExtension
+ * @typedef {import('mdast-util-to-markdown').Options} ToMarkdownExtension
+ *
+ * @typedef {import('mdast-util-gfm-table').Options} Options
+ */
+
+// import {
+//   gfmAutolinkLiteralFromMarkdown,
+//   gfmAutolinkLiteralToMarkdown
+// } from 'mdast-util-gfm-autolink-literal'
+import {
+  gfmFootnoteFromMarkdown,
+  gfmFootnoteToMarkdown,
+} from 'mdast-util-gfm-footnote';
+import {
+  gfmStrikethroughFromMarkdown,
+  gfmStrikethroughToMarkdown,
+} from 'mdast-util-gfm-strikethrough';
+import { gfmTableFromMarkdown, gfmTableToMarkdown } from 'mdast-util-gfm-table';
+import {
+  gfmTaskListItemFromMarkdown,
+  gfmTaskListItemToMarkdown,
+} from 'mdast-util-gfm-task-list-item';
+
+/**
+ * @returns {Array.<FromMarkdownExtension>}
+ */
+export function gfmFromMarkdown() {
+  return [
+    gfmFootnoteFromMarkdown(),
+    gfmStrikethroughFromMarkdown,
+    gfmTableFromMarkdown,
+    // gfmAutolinkLiteralFromMarkdown,
+    gfmTaskListItemFromMarkdown,
+  ];
+}
+
+/**
+ * @param {Options} [options]
+ * @returns {ToMarkdownExtension}
+ */
+export function gfmToMarkdown(options) {
+  return {
+    extensions: [
+      // gfmAutolinkLiteralToMarkdown,
+      gfmFootnoteToMarkdown(),
+      gfmStrikethroughToMarkdown,
+      gfmTableToMarkdown(options),
+      gfmTaskListItemToMarkdown,
+    ],
+  };
+}

package/src/micromark-extension-gfm-nolink.js

@@ -0,0 +1,112 @@
+/*
+ * Copyright 2021 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.
+ */
+
+/*
+copied from
+https://github.com/micromark/micromark-extension-gfm/blob/942585eba9ec22fd9818638d42a7c8e62a7208b0/index.js
+
+(The MIT License)
+
+Copyright (c) 2020 Titus Wormer <tituswormer@gmail.com>
+
+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.
+ */
+
+/**
+ * @typedef {import('micromark-util-types').Extension} Extension
+ * @typedef {import('micromark-util-types').HtmlExtension} HtmlExtension
+ * @typedef {import('micromark-extension-gfm-strikethrough').Options} Options
+ * @typedef {import('micromark-extension-gfm-footnote').HtmlOptions} HtmlOptions
+ */
+
+import {
+  combineExtensions,
+  combineHtmlExtensions,
+} from 'micromark-util-combine-extensions';
+// import {
+//   gfmAutolinkLiteral,
+//   gfmAutolinkLiteralHtml,
+// } from 'micromark-extension-gfm-autolink-literal';
+import { gfmFootnote, gfmFootnoteHtml } from 'micromark-extension-gfm-footnote';
+import {
+  gfmStrikethrough,
+  gfmStrikethroughHtml,
+} from 'micromark-extension-gfm-strikethrough';
+import { gfmTable, gfmTableHtml } from 'micromark-extension-gfm-table';
+import { gfmTagfilterHtml } from 'micromark-extension-gfm-tagfilter';
+import {
+  gfmTaskListItem,
+  gfmTaskListItemHtml,
+} from 'micromark-extension-gfm-task-list-item';
+
+/**
+ * Add support for parsing GFM in markdown.
+ *
+ * Function that can be called to get a syntax extension for micromark (passed
+ * in `extensions`).
+ *
+ * @param {Options} [options]
+ *   Configuration (optional).
+ *   Passed to `micromark-extens-gfm-strikethrough`.
+ * @returns {Extension}
+ *   Syntax extension for micromark (passed in `extensions`).
+ */
+export function gfm(options) {
+  return combineExtensions([
+    // gfmAutolinkLiteral,
+    gfmFootnote(),
+    gfmStrikethrough(options),
+    gfmTable,
+    gfmTaskListItem,
+  ]);
+}
+
+/**
+ * Add support for turning GFM in markdown to HTML.
+ *
+ * Function that can be called to get an HTML extension for micromark (passed
+ * in `htmlExtensions`).
+ *
+ * @param {HtmlOptions} [options]
+ *   Configuration (optional).
+ *   Passed to `micromark-extens-gfm-footnote`.
+ * @returns {HtmlExtension}
+ *   HTML extension for micromark (passed in `htmlExtensions`).
+ */
+/* c8 ignore next 10 */
+export function gfmHtml(options) {
+  return combineHtmlExtensions([
+    // gfmAutolinkLiteralHtml,
+    gfmFootnoteHtml(options),
+    gfmStrikethroughHtml,
+    gfmTableHtml,
+    gfmTagfilterHtml,
+    gfmTaskListItemHtml,
+  ]);
+}

package/src/remark-gfm-nolink.js

@@ -0,0 +1,76 @@
+/*
+ * Copyright 2021 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.
+ */
+
+/*
+copied from
+https://github.com/remarkjs/remark-gfm/blob/82542ee281b8aa1e113578a4a254717d0120fcb7/index.js
+
+(The MIT License)
+
+Copyright (c) 2020 Titus Wormer <tituswormer@gmail.com>
+
+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.
+ */
+
+/* eslint-disable no-unused-vars */
+/**
+ * @typedef {import('mdast').Root} Root
+ * @typedef {import('micromark-extension-gfm').Options & import('mdast-util-gfm').Options} Options
+ */
+
+import { gfm } from './micromark-extension-gfm-nolink.js';
+import { gfmFromMarkdown, gfmToMarkdown } from './mdast-util-gfm-nolink.js';
+
+/**
+ * Plugin to support GFM (autolink literals, footnotes, strikethrough, tables, tasklists).
+ *
+ * @this {import('unified').Processor}
+ * @type {import('unified').Plugin<[Options?]|void[], Root>}
+ */
+export default function remarkGfm(options = {}) {
+  const data = this.data();
+
+  /**
+   * @param {string} field
+   * @param {unknown} value
+   */
+  function add(field, value) {
+    const list = /** @type {unknown[]} */ (
+      // Other extensions
+      /* c8 ignore next 2 */
+      data[field] ? data[field] : (data[field] = [])
+    );
+
+    list.push(value);
+  }
+
+  add('micromarkExtensions', gfm(options));
+  add('fromMarkdownExtensions', gfmFromMarkdown());
+  add('toMarkdownExtensions', gfmToMarkdown(options));
+}