fix(deps): convert to esm, cleanup tests and update unify ecosystem libs

.eslintrc.js → .eslintrc.cjs

@@ -1,5 +1,5 @@
 /*
- * Copyright 2019 Adobe. All rights reserved.
+ * 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
@@ -13,7 +13,18 @@
 module.exports = {
  root: true,
  extends: '@adobe/helix',
+ env: {
+ node: true,
+ es6: true,
+ },
+ parserOptions: {
+ sourceType: 'module',
+ ecmaVersion: 2020,
+ },
  rules: {
+ 'import/extensions': [2, 'ignorePackages'],
+ 'import/prefer-default-export': 0,
+
  // Allow while (true) infinite loops
  'no-constant-condition': ['error', { checkLoops: false }],
 
@@ -24,4 +35,8 @@ module.exports = {
  // parameters is definitely desirable
  'no-param-reassign': 'off',
  },
+ globals: {
+ __rootdir: true,
+ __testdir: true,
+ },
 };

.gitignore

@@ -3,4 +3,5 @@ pipeline.log
 logs/pipeline.log
 .nyc_output
 logs/debug
-coverage
+coverage
+junit/

.husky/pre-commit

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

.mocha-multi.json

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

.nycrc.json

@@ -0,0 +1,10 @@
+{
+ "reporter": [
+ "lcov",
+ "text"
+ ],
+ "check-coverage": true,
+ "lines": 77,
+ "branches": 67,
+ "statements": 77
+}

bin/schema2ts.js

@@ -11,9 +11,8 @@
  */
 
 /* eslint-disable import/no-extraneous-dependencies */
-const { compileFromFile } = require('json-schema-to-typescript');
-const { writeFileSync } = require('fs-extra');
-const fs = require('fs-extra');
+import { compileFromFile } from 'json-schema-to-typescript';
+import fs from 'fs-extra';
 
 const options = {
  $refOptions: {
@@ -52,5 +51,5 @@ const options = {
  */`,
 };
 
-compileFromFile('docs/context.schema.json', options).then((ts) => writeFileSync('src/context.d.ts', ts));
-compileFromFile('docs/action.schema.json', options).then((ts) => writeFileSync('src/action.d.ts', ts));
+compileFromFile('docs/context.schema.json', options).then((ts) => fs.writeFileSync('src/context.d.ts', ts));
+compileFromFile('docs/action.schema.json', options).then((ts) => fs.writeFileSync('src/action.d.ts', ts));

docs/README.md

@@ -4,11 +4,11 @@
 
 * [Action](./action.md "Tracks the OpenWhisk action invocation") – `https://ns.adobe.com/helix/pipeline/action`
 
-* [Content](./content.md "The content as retrieved from the repository and enriched in the pipeline") – `https://ns.adobe.com/helix/pipeline/content`
+* [Content](./content.md "The content object represents the content that is being processed in the pipeline") – `https://ns.adobe.com/helix/pipeline/content`
 
 * [Context](./context.md "The context thingie") – `https://ns.adobe.com/helix/pipeline/context`
 
-* [MDAST](./mdast.md "A node in the Markdown AST") – `https://ns.adobe.com/helix/pipeline/mdast`
+* [MDAST](./mdast.md "The Markdown AST is 100% API compatible with the UnifiedJS MDAST data structure") – `https://ns.adobe.com/helix/pipeline/mdast`
 
 * [Meta](./meta.md "Content and Section Metadata Properties") – `https://ns.adobe.com/helix/pipeline/meta`
 

docs/content.md

@@ -4,7 +4,15 @@
 https://ns.adobe.com/helix/pipeline/content
 ```
 
-The content as retrieved from the repository and enriched in the pipeline.
+The `content` object represents the content that is being processed in the pipeline.
+
+With each step of the pipeline, the `content` will be enriched and gain additional properties.
+
+In a typical processing, `content` will start empty, and then gain a [`body`](#body) as the resource is fetched from the content repository.
+
+In the second step, the `body` will be parsed using a Markdown parser, resulting in the populated [`mdast`](#mdast) property, which is a representation of the Markdown.
+
+After that, the Markdown AST is processed furthermore to extract [`sections`](#meta), [`title`](#title), [`intro`](#intro), and [`meta`](#meta).
 
 | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
 | :------------------ | :--------- | :---------- | :----------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------- |

docs/mdast-properties-align-items.md

@@ -23,4 +23,5 @@ https://ns.adobe.com/helix/pipeline/mdast#/properties/align/items
 | `"left"` | |
 | `"right"` | |
 | `"center"` | |
+| `"none"` | |
 | `null` | |

docs/mdast.md

@@ -4,7 +4,9 @@
 https://ns.adobe.com/helix/pipeline/mdast
 ```
 
-A node in the Markdown AST
+The Markdown AST is 100% API compatible with the [UnifiedJS MDAST](https://github.com/syntax-tree/mdast) data structure.
+
+All [MDAST Utilities](https://github.com/syntax-tree/mdast#list-of-utilities) are compatible and can be used for easy processing of MDAST trees.
 
 | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
 | :------------------ | :--------- | :----- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------ |