@putout/processor-markdown 5.2.4 → 5.6.0

package/README.md

@@ -1,9 +1,7 @@
-# @putout/processor-markdown [![NPM version][NPMIMGURL]][NPMURL] [![Dependency Status][DependencyStatusIMGURL]][DependencyStatusURL]
+# @putout/processor-markdown [![NPM version][NPMIMGURL]][NPMURL]
 
 [NPMIMGURL]: https://img.shields.io/npm/v/@putout/processor-markdown.svg?style=flat&longCache=true
 [NPMURL]: https://npmjs.org/package/@putout/processor-markdown "npm"
-[DependencyStatusURL]: https://david-dm.org/coderaiser/putout?path=packages/processor-markdown
-[DependencyStatusIMGURL]: https://david-dm.org/coderaiser/putout.svg?path=packages/processor-markdown
 
 `putout` processor adds ability to get `js`, `json` and `ts` code from markdown files.
 
@@ -23,6 +21,10 @@ npm i @putout/processor-markdown -D
 }
 ```
 
+## Rules
+
+- [Remove dependencies status badges](https://github.com/coderaiser/putout/tree/master/packages/processor-markdown/lib/rules/remove-dependencies-status-badge.md)
+
 ## License
 
 MIT

package/lib/markdown.js

@@ -1,10 +1,9 @@
 'use strict';
 
-const {initParseStore} = require('./parse-store');
-const {createSimport} = require('simport');
 const once = require('once');
 
-const simport = createSimport(__filename);
+const {toPlace} = require('./parse-place');
+const {initParseStore} = require('./parse-store');
 
 const parseStore = initParseStore();
 
@@ -24,18 +23,11 @@ module.exports.files = [
 ];
 
 const loadDependencies = once(async () => {
-    const stringify = await simport('remark-stringify');
-    const preset = await simport('remark-preset-lint-consistent');
-    const jsonProcessor = await simport('@putout/processor-json');
-    
-    // Fix: TypeError: visit is not a function
-    //
-    // remark installs "uninst-util-visit" v2 using npm and has `module.exports = visit`
-    // but v3 has `export const visit = () => {}`
-    // and simport imports nearest version of "uninst-util-visit" which is v2
-    // that's why regular import should be used here while remark not transit to v3
+    const {default: stringify} = await import('remark-stringify');
+    const {default: preset} = await import('remark-preset-lint-consistent');
+    const {default: jsonProcessor} = await import('@putout/processor-json');
+    const {run} = await import('./rules/index.mjs');
     const {visit} = await import('unist-util-visit');
-    // sometimes cannot load unified with simport on node v14
     const {unified} = await import('unified');
     
     return {
@@ -44,6 +36,7 @@ const loadDependencies = once(async () => {
         visit,
         preset,
         jsonProcessor,
+        run,
     };
 });
 
@@ -52,6 +45,7 @@ module.exports.find = async (rawSource) => {
         unified,
         stringify,
         preset,
+        run,
     } = await loadDependencies();
     
     await parseStore.init();
@@ -59,10 +53,12 @@ module.exports.find = async (rawSource) => {
     const {messages} = await unified()
         .use(parseStore)
         .use(preset)
+        .use(run, {fix: false})
         .use(stringify, stringifyOptions)
         .process(rawSource);
     
-    return messages.map(toPlace);
+    return messages
+        .map(toPlace);
 };
 
 module.exports.fix = async (rawSource) => {
@@ -70,19 +66,18 @@ module.exports.fix = async (rawSource) => {
         unified,
         stringify,
         preset,
+        run,
     } = await loadDependencies();
     
     await parseStore.init();
     
-    const {messages, value} = await unified()
+    const {value} = await unified()
         .use(parseStore)
         .use(preset)
+        .use(run, {fix: true})
         .use(stringify, stringifyOptions)
         .process(rawSource);
     
-    if (!messages.length)
-        return rawSource;
-    
     return value;
 };
 
@@ -135,17 +130,6 @@ module.exports.merge = async (rawSource, list) => {
     return value;
 };
 
-function toPlace({reason, line, column, source, ruleId}) {
-    return {
-        message: reason,
-        rule: `${ruleId} (${source})`,
-        position: {
-            line,
-            column,
-        },
-    };
-}
-
 const collect = ({list, visit}) => {
     const jsonProcessor = require('@putout/processor-json');
     

package/lib/parse-place.js

@@ -0,0 +1,37 @@
+'use strict';
+
+module.exports.toPlace = function toPlace({reason, line, column, source, ruleId}) {
+    const {message, rule} = parseWatermark({
+        reason,
+        ruleId,
+        source,
+    });
+    
+    return {
+        message,
+        rule,
+        position: {
+            line,
+            column,
+        },
+    };
+};
+
+function parseWatermark({reason, ruleId, source}) {
+    const [watermark, remarkRule, message] = reason.split(': ');
+    
+    if (watermark === 'putout') {
+        const rule = `${remarkRule} (${source})`;
+        
+        return {
+            rule,
+            message,
+        };
+    }
+    
+    return {
+        message: reason,
+        rule: `${ruleId} (${source})`,
+    };
+}
+

package/lib/parse-store.js

@@ -1,8 +1,5 @@
 'use strict';
 
-const {createSimport} = require('simport');
-const simport = createSimport(__filename);
-
 module.exports.initParseStore = () => {
     let cache = null;
     let parse = null;
@@ -24,7 +21,7 @@ module.exports.initParseStore = () => {
     
     fn.init = async () => {
         cache = null;
-        parse = await simport('remark-parse');
+        ({default: parse} = await import('remark-parse'));
     };
     
     fn.clear = async () => {

package/lib/rules/index.mjs

@@ -0,0 +1,36 @@
+import {lintRule} from 'unified-lint-rule';
+import removeDependenciesStatusBadge from './remove-dependencies-status-badge.mjs';
+import removeTrailingWhitespacesFromHeading from './remove-trailing-whitespaces-from-heading.mjs';
+import mergeHeadingSpceces from './merge-heading-spaces.mjs';
+
+const plugins = [
+    removeDependenciesStatusBadge,
+    removeTrailingWhitespacesFromHeading,
+    mergeHeadingSpceces,
+];
+
+export const run = lintRule('remark-lint:run', (tree, file, options) => {
+    for (const {fix, traverse, report, name} of plugins) {
+        const nodes = [];
+        const push = nodes.push.bind(nodes);
+        
+        traverse(tree, {
+            push,
+        });
+        
+        for (const node of nodes) {
+            if (options.fix) {
+                fix(node, tree);
+                continue;
+            }
+            
+            const message = report(node);
+            file.message(`putout: ${name}: ${message}`, node);
+        }
+    }
+});
+
+export const rules = {
+    plugins,
+};
+

package/lib/rules/merge-heading-spaces.mjs

@@ -0,0 +1,52 @@
+const report = () => 'Merge heading spaces';
+
+const fix = (heading) => {
+    const newChildren = [];
+    
+    for (const [i, node] of heading.children.entries()) {
+        const nextNode = heading.children[i + 1];
+        
+        if (bothSpaces(node, nextNode))
+            continue;
+        
+        newChildren.push(node);
+    }
+    
+    heading.children = newChildren;
+};
+
+const traverse = (tree, {push}) => {
+    const [heading] = tree.children;
+    
+    if (heading.type !== 'heading')
+        return;
+    
+    for (const [i, node] of heading.children.entries()) {
+        const nextNode = heading.children[i + 1];
+        
+        if (bothSpaces(node, nextNode)) {
+            push(heading);
+            break;
+        }
+    }
+};
+
+const bothSpaces = (node, nextNode) => {
+    if (!nextNode)
+        return false;
+    
+    if (node.type !== 'text' || node.value !== ' ')
+        return false;
+    
+    if (nextNode.type !== 'text' || nextNode.value !== ' ')
+        return false;
+    
+    return true;
+};
+
+export default {
+    name: 'merge-heading-spaces',
+    fix,
+    traverse,
+    report,
+};

package/lib/rules/remove-dependencies-status-badge.md

@@ -0,0 +1,14 @@
+# Remove dependencies status badge (remove-dependencies-status-badge)
+
+## Rule Details
+
+```diff
+# @putout/plugin-apply-replace-all [![NPM version][NPMIMGURL]][NPMURL] [![Dependency Status][DependencyStatusIMGURL]][DependencyStatusURL]
+--# @putout/plugin-apply-replace-all [![NPM version][NPMIMGURL]][NPMURL]
+
+[NPMIMGURL]:                https://img.shields.io/npm/v/@putout/plugin-apply-replace-all.svg?style=flat&longCache=true
+[NPMURL]:                   https://npmjs.org/package/@putout/plugin-apply-replace-all "npm"
+-
+-[DependencyStatusURL]:      https://david-dm.org/coderaiser/putout?path=packages/plugin-apply-replace-all
+-[DependencyStatusIMGURL]:   https://david-dm.org/coderaiser/putout.svg?path=packages/plugin-apply-replace-all
+```

package/lib/rules/remove-dependencies-status-badge.mjs

@@ -0,0 +1,53 @@
+const report = () => 'Remove dependencies status badge';
+
+const noop = () => {};
+
+export default {
+    name: 'remove-dependencies-status-badge',
+    traverse,
+    fix,
+    report,
+};
+
+function fix(node, tree) {
+    const children = tree.children.filter(isDependencyStatus());
+    tree.children = children;
+    
+    const [heading] = children;
+    
+    if (heading.type !== 'heading')
+        return;
+    
+    const headingChildren = heading.children.filter(isDependencyLink);
+    tree.children[0].children = headingChildren;
+}
+
+function traverse(tree, {push}) {
+    tree.children.filter(isDependencyStatus(push));
+}
+
+const isDependencyStatus = (push = noop) => (child) => {
+    if (child.type !== 'definition')
+        return true;
+    
+    if (child.label === 'DependencyStatusURL') {
+        push(child);
+        return false;
+    }
+    
+    if (child.label === 'DependencyStatusIMGURL')
+        return false;
+    
+    return true;
+};
+
+const isDependencyLink = (child) => {
+    if (child.type !== 'linkReference')
+        return true;
+    
+    if (child.children[0].label === 'DependencyStatusIMGURL')
+        return false;
+    
+    return true;
+};
+

package/lib/rules/remove-trailing-whitespaces-from-heading.mjs

@@ -0,0 +1,32 @@
+const report = () => 'Avoid trailing whitespaces';
+
+const fix = (heading, tree) => {
+    const latest = heading.children[heading.children.length - 1];
+    
+    if (latest.type === 'text' && latest.value === ' ')
+        heading.children = heading.children.slice(0, -1);
+    
+    if (latest.type === 'text' && / $/.test(latest.value))
+        latest.value = latest.value.slice(0, -1);
+    
+    tree.children[0].children = heading.children;
+};
+
+const traverse = (tree, {push}) => {
+    const [heading] = tree.children;
+    
+    if (heading.type !== 'heading')
+        return;
+    
+    const latest = heading.children[heading.children.length - 1];
+    
+    if (latest.type === 'text' && / $/.test(latest.value))
+        push(heading);
+};
+
+export default {
+    name: 'remove-trailing-whitespaces-from-heading',
+    fix,
+    traverse,
+    report,
+};

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "@putout/processor-markdown",
-  "version": "5.2.4",
+  "version": "5.6.0",
+  "type": "commonjs",
   "author": "coderaiser <mnemonic.enemy@gmail.com> (https://github.com/coderaiser)",
   "description": "putout processor adds ability to parse markdown files and lint js snippets",
-  "homepage": "http://github.com/coderaiser/putout",
+  "homepage": "https://github.com/coderaiser/putout/tree/master/packages/processor-markdown#readme",
   "main": "lib/markdown.js",
   "release": false,
   "tag": false,
@@ -28,8 +29,8 @@
     "remark-parse": "^10.0.0",
     "remark-preset-lint-consistent": "^5.0.0",
     "remark-stringify": "^10.0.0",
-    "simport": "^1.2.0",
     "unified": "^10.0.0",
+    "unified-lint-rule": "^2.1.0",
     "unist-util-visit": "^4.0.0"
   },
   "keywords": [
@@ -38,15 +39,16 @@
     "markdown"
   ],
   "devDependencies": {
-    "@putout/test": "^3.5.0",
+    "@putout/test": "^4.0.0",
     "c8": "^7.5.0",
-    "eslint": "^7.0.0",
+    "eslint": "^8.0.1",
     "eslint-plugin-node": "^11.0.0",
-    "eslint-plugin-putout": "^8.0.0",
+    "eslint-plugin-putout": "^13.0.0",
     "lerna": "^4.0.0",
     "madrun": "^8.0.1",
     "nodemon": "^2.0.1",
-    "putout": "*"
+    "putout": "*",
+    "supertape": "^6.10.0"
   },
   "peerDependencies": {
     "putout": ">=18"