@adobe/helix-html-pipeline 1.0.0

package/src/utils/path.js

@@ -0,0 +1,103 @@
+/*
+ * 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.
+ */
+
+/**
+ * Returns a path info for the given resource path
+ * @param {string} path request path
+ * @returns {PathInfo} the path info
+ */
+export function getPathInfo(path) {
+  if (!path) {
+    // eslint-disable-next-line no-param-reassign
+    path = '/';
+  }
+  const segs = path.split(/\/+/);
+  segs.shift(); // remove _emptyness_ before first slash
+  if (segs.length < 1) {
+    return null;
+  }
+  if (segs.indexOf('..') >= 0 || segs.indexOf('.') >= 0) {
+    return null;
+  }
+  const info = {
+    selector: '',
+    extension: '.html',
+    originalExtension: '',
+    originalPath: path,
+    originalFilename: segs.pop(),
+  };
+
+  // path         -> web path (no .html, no index)
+  // resourcePath -> content path (.md)
+  let fileName = info.originalFilename;
+  if (!fileName || fileName === 'index.html' || fileName === 'index.md' || fileName === 'index') {
+    // last segment empty or index
+    const lastDot = fileName.lastIndexOf('.');
+    if (lastDot >= 0) {
+      info.originalExtension = fileName.substring(lastDot);
+    }
+    segs.push('');
+    fileName = 'index.md';
+  } else if (fileName.indexOf('.') < 0) {
+    // if last segment has no extension, add `.md`
+    segs.push(fileName);
+    fileName = `${fileName}.md`;
+  } else {
+    // compute selector and extension
+    const firstDot = fileName.indexOf('.');
+    const lastDot = fileName.lastIndexOf('.');
+    info.extension = fileName.substring(lastDot);
+    info.originalExtension = info.extension;
+    const baseName = fileName.substring(0, firstDot);
+    let resExt = info.extension;
+    if (resExt === '.md') {
+      info.extension = '.html';
+      segs.push(baseName);
+    } else if (resExt === '.html') {
+      resExt = '.md';
+      segs.push(baseName);
+    } else {
+      segs.push(`${baseName}${resExt}`);
+    }
+
+    if (lastDot !== firstDot) {
+      info.selector = fileName.substring(firstDot + 1, lastDot);
+      segs[segs.length - 1] = `${baseName}.${info.selector}${info.extension}`;
+    }
+    fileName = `${baseName}${resExt}`;
+  }
+
+  info.path = `/${segs.join('/')}`;
+  segs[segs.length - 1] = fileName;
+  info.resourcePath = `/${segs.join('/')}`;
+  return info;
+}
+
+/**
+ * Validates the path info
+ * @param {PathInfo} info Info to valida
+ * @return {boolean} {@code true} if valid.
+ */
+export function validatePathInfo(info) {
+  if (!info) {
+    return false;
+  }
+
+  // only support empty selector or plain with html
+  if (info.selector) {
+    if (info.selector !== 'plain') {
+      return false;
+    }
+    return info.extension === '.html';
+  }
+  return true;
+}

package/src/utils/remark-gfm-nolink.js

@@ -0,0 +1,128 @@
+/*
+ * 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/syntax-tree/mdast-util-gfm/blob/544cc04ef9980fe152090bf68338444b1ed0e7a4/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('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,
+} 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';
+import { gfmFromMarkdown, gfmToMarkdown } from './mdast-util-gfm-nolink.js';
+
+/**
+ * Support GFM or markdown on github.com.
+ *
+ * @param {Options} [options]
+ * @returns {Extension}
+ */
+export function gfm(options) {
+  return combineExtensions([
+    // gfmAutolinkLiteral,
+    gfmFootnote(),
+    gfmStrikethrough(options),
+    gfmTable,
+    gfmTaskListItem,
+  ]);
+}
+
+/**
+ * Support to compile GFM to HTML.
+ *
+ * @param {HtmlOptions} [options]
+ * @returns {HtmlExtension}
+ */
+// export function gfmHtml(options) {
+//   return combineHtmlExtensions([
+//     // gfmAutolinkLiteralHtml,
+//     gfmFootnoteHtml(options),
+//     gfmStrikethroughHtml,
+//     gfmTableHtml,
+//     gfmTagfilterHtml,
+//     gfmTaskListItemHtml,
+//   ]);
+// }
+
+/**
+ * Plugin to support GFM (autolink literals, footnotes, strikethrough, tables, tasklists).
+ *
+ * @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));
+}

package/src/utils/section-handler.js

@@ -0,0 +1,69 @@
+/*
+ * 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.
+ */
+import { all } from 'mdast-util-to-hast';
+import { wrap } from 'mdast-util-to-hast/lib/wrap.js';
+
+const HELIX_NAMESPACE = 'hlx-';
+const DEFAULT_SECTION_TAG = 'div';
+const DEFAULT_SECTION_CLASS = `${HELIX_NAMESPACE}section`;
+const SYSTEM_META_PROPERTIES = ['tagname'];
+const SYSTEM_HTML_ATTRIBUTES = ['types'];
+const GLOBAL_HTML_ATTRIBUTES = [
+  'accesskey', 'autocapitalize', 'class', 'contenteditable', 'contextmenu', 'dir', 'draggable', 'dropzone', 'hidden',
+  'id', 'inputmode', 'is', 'itemid', 'itemprop', 'itemref', 'itemscope', 'itemtype', 'lang', 'slot', 'spellcheck',
+  'style', 'tabindex', 'title', 'translate',
+];
+
+/**
+ * Get the tag name for the specified section.
+ *
+ * @param {Node} section The MDAST section to get the tag name for
+ * @returns {string} The tag name for the section. Defaults to {@code div}.
+ */
+function getTagName(section) {
+  return (section.meta && section.meta.tagname) || DEFAULT_SECTION_TAG;
+}
+
+function toHtmlAttribute(value) {
+  return Array.isArray(value) ? value.join(' ') : value;
+}
+
+function getAttributes(section) {
+  const attributeKeys = Object.keys(section.meta);
+  // Add system properties as data-hlx-*
+  const attributes = attributeKeys
+    .filter((k) => SYSTEM_HTML_ATTRIBUTES.indexOf(k) > -1)
+    .reduce((result, attr) => Object.assign(result, { [`data-${HELIX_NAMESPACE}${attr}`]: toHtmlAttribute(section.meta[attr]) }), {});
+  return attributeKeys
+    .filter((k) => [...SYSTEM_HTML_ATTRIBUTES, ...SYSTEM_META_PROPERTIES].indexOf(k) === -1)
+    .reduce((result, attr) => {
+      // Add invalid HTML attributes as data-*
+      if (GLOBAL_HTML_ATTRIBUTES.indexOf(attr) === -1 && !attr.startsWith('data-')) {
+        return Object.assign(result, { [`data-${attr}`]: toHtmlAttribute(section.meta[attr]) });
+      }
+      // Add valid HTML attributes
+      return Object.assign(result, { [attr]: toHtmlAttribute(section.meta[attr]) });
+    }, attributes);
+}
+
+export default function sectionHandler() {
+  return function handler(h, node) {
+    const n = { ...node };
+
+    const tagName = getTagName(n);
+    const props = getAttributes(n);
+    props.class = props.class ? `${DEFAULT_SECTION_CLASS} ${props.class}` : DEFAULT_SECTION_CLASS;
+    const children = wrap(all(h, n), true);
+
+    return h(node, tagName, props, children);
+  };
+}

package/src/utils/table-handler.js

@@ -0,0 +1,27 @@
+/*
+ * Copyright 2018 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 { table as fallback } from 'mdast-util-to-hast/lib/handlers/table.js';
+
+export default function table() {
+  return function handler(h, node) {
+    // remove 'none' from align (doesn't occur anymore, maybe leftover from prior versions)
+    if (node.align) {
+      for (let i = 0; i < node.align.length; i += 1) {
+        /* c8 ignore next 3 */
+        if (node.align[i] === 'none') {
+          node.align[i] = null;
+        }
+      }
+    }
+    return fallback(h, node);
+  };
+}