@putout/processor-markdown 5.5.0 → 7.0.0

package/README.md

@@ -3,7 +3,11 @@
 [NPMIMGURL]: https://img.shields.io/npm/v/@putout/processor-markdown.svg?style=flat&longCache=true
 [NPMURL]: https://npmjs.org/package/@putout/processor-markdown "npm"
 
-`putout` processor adds ability to get `js`, `json` and `ts` code from markdown files.
+> **Markdown**, the simple and easy-to-use markup language you can use to format virtually any document.
+>
+> (c) [markdownguide.org](https://www.markdownguide.org/)
+
+🐊[**Putout**](https://github.com/coderaiser/putout) processor adds ability to get **JavaScript**, **JSON** and **TypeScript** code from markdown files.
 
 ## Install
 

package/lib/markdown.js

@@ -1,12 +1,13 @@
-'use strict';
+import jsonProcessor from '@putout/processor-json';
+import stringify from 'remark-stringify';
+import preset from 'remark-preset-lint-consistent';
 
-const {createSimport} = require('simport');
-const once = require('once');
+import {run} from './rules/index.mjs';
+import {visit} from 'unist-util-visit';
+import {unified} from 'unified';
 
-const {toPlace} = require('./parse-place');
-const {initParseStore} = require('./parse-store');
-
-const simport = createSimport(__filename);
+import {toPlace} from './parse-place.js';
+import {initParseStore} from './parse-store.js';
 
 const parseStore = initParseStore();
 
@@ -21,44 +22,11 @@ const stringifyOptions = {
     },
 };
 
-module.exports.files = [
+export const files = [
     '*.md',
 ];
 
-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');
-    const {run} = await simport('./rules/index.mjs');
-    
-    // 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 {visit} = await import('unist-util-visit');
-    // sometimes cannot load unified with simport on node v14
-    const {unified} = await import('unified');
-    
-    return {
-        unified,
-        stringify,
-        visit,
-        preset,
-        jsonProcessor,
-        run,
-    };
-});
-
-module.exports.find = async (rawSource) => {
-    const {
-        unified,
-        stringify,
-        preset,
-        run,
-    } = await loadDependencies();
-    
+export const find = async (rawSource) => {
     await parseStore.init();
     
     const {messages} = await unified()
@@ -72,14 +40,7 @@ module.exports.find = async (rawSource) => {
         .map(toPlace);
 };
 
-module.exports.fix = async (rawSource) => {
-    const {
-        unified,
-        stringify,
-        preset,
-        run,
-    } = await loadDependencies();
-    
+export const fix = async (rawSource) => {
     await parseStore.init();
     
     const {value} = await unified()
@@ -92,14 +53,7 @@ module.exports.fix = async (rawSource) => {
     return value;
 };
 
-module.exports.branch = async (rawSource) => {
-    const {
-        unified,
-        stringify,
-        visit,
-        jsonProcessor,
-    } = await loadDependencies();
-    
+export const branch = async (rawSource) => {
     const list = [];
     
     await unified()
@@ -107,7 +61,6 @@ module.exports.branch = async (rawSource) => {
         .use(collect, {
             list,
             visit,
-            jsonProcessor,
         })
         .use(stringify)
         .process(rawSource);
@@ -115,14 +68,7 @@ module.exports.branch = async (rawSource) => {
     return list;
 };
 
-module.exports.merge = async (rawSource, list) => {
-    const {
-        unified,
-        stringify,
-        visit,
-        jsonProcessor,
-    } = await loadDependencies();
-    
+export const merge = async (rawSource, list) => {
     const newList = list.slice();
     
     const {value} = await unified()
@@ -131,7 +77,6 @@ module.exports.merge = async (rawSource, list) => {
             list: newList,
             rawSource,
             visit,
-            jsonProcessor,
         })
         .use(stringify, stringifyOptions)
         .process(rawSource);
@@ -141,70 +86,61 @@ module.exports.merge = async (rawSource, list) => {
     return value;
 };
 
-const collect = ({list, visit}) => {
-    const jsonProcessor = require('@putout/processor-json');
-    
-    return (node) => {
-        visit(node, 'code', (node) => {
-            const {lang, value} = node;
-            const startLine = node.position.start.line;
+const collect = ({list, visit}) => (node) => {
+    visit(node, 'code', (node) => {
+        const {lang, value} = node;
+        const startLine = node.position.start.line;
+        
+        if (/^(js|javascript)$/.test(lang)) {
+            list.push({
+                startLine,
+                source: value,
+                extension: 'js',
+            });
             
-            if (/^(js|javascript)$/.test(lang)) {
-                list.push({
-                    startLine,
-                    source: value,
-                    extension: 'js',
-                });
-                
-                return;
-            }
+            return;
+        }
+        
+        if (/^(ts|typescript)$/.test(lang)) {
+            list.push({
+                startLine,
+                source: value,
+                extension: 'ts',
+            });
             
-            if (/^(ts|typescript)$/.test(lang)) {
-                list.push({
-                    startLine,
-                    source: value,
-                    extension: 'ts',
-                });
-                
-                return;
-            }
+            return;
+        }
+        
+        if (lang === 'json') {
+            const source = jsonProcessor.toJS(value);
             
-            if (lang === 'json') {
-                const source = jsonProcessor.toJS(value);
-                
-                list.push({
-                    startLine,
-                    source,
-                    extension: 'json',
-                });
-            }
-        });
-    };
+            list.push({
+                startLine,
+                source,
+                extension: 'json',
+            });
+        }
+    });
 };
 
-const apply = ({list, visit, jsonProcessor}) => (node) => {
+const apply = ({list, visit}) => (node) => {
     visit(node, 'code', (node) => {
         const {lang} = node;
         
         if (/^(js|javascript)$/.test(lang)) {
-            const source = list.shift();
-            
-            node.value = source;
+            node.value = list.shift();
             return;
         }
         
         if (/^(ts|typescript)$/.test(lang)) {
-            const source = list.shift();
-            
-            node.value = source;
+            node.value = list.shift();
             return;
         }
         
         if (lang === 'json') {
             const code = list.shift();
-            const source = jsonProcessor.fromJS(code);
             
-            node.value = source;
+            node.value = jsonProcessor.fromJS(code);
         }
     });
 };

package/lib/parse-place.js

@@ -1,6 +1,4 @@
-'use strict';
-
-module.exports.toPlace = function toPlace({reason, line, column, source, ruleId}) {
+export function toPlace({reason, line, column, source, ruleId}) {
     const {message, rule} = parseWatermark({
         reason,
         ruleId,
@@ -15,7 +13,7 @@ module.exports.toPlace = function toPlace({reason, line, column, source, ruleId}
             column,
         },
     };
-};
+}
 
 function parseWatermark({reason, ruleId, source}) {
     const [watermark, remarkRule, message] = reason.split(': ');

package/lib/parse-store.js

@@ -1,9 +1,4 @@
-'use strict';
-
-const {createSimport} = require('simport');
-const simport = createSimport(__filename);
-
-module.exports.initParseStore = () => {
+export const initParseStore = () => {
     let cache = null;
     let parse = null;
     
@@ -24,7 +19,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/merge-heading-spaces.mjs

@@ -2,10 +2,8 @@ const report = () => 'Merge heading spaces';
 
 const fix = (heading) => {
     const newChildren = [];
-    const n = heading.children.length;
     
-    for (let i = 0; i < n; i++) {
-        const node = heading.children[i];
+    for (const [i, node] of heading.children.entries()) {
         const nextNode = heading.children[i + 1];
         
         if (bothSpaces(node, nextNode))
@@ -23,10 +21,7 @@ const traverse = (tree, {push}) => {
     if (heading.type !== 'heading')
         return;
     
-    const n = heading.children.length;
-    
-    for (let i = 0; i < n; i++) {
-        const node = heading.children[i];
+    for (const [i, node] of heading.children.entries()) {
         const nextNode = heading.children[i + 1];
         
         if (bothSpaces(node, nextNode)) {

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

@@ -1,12 +1,12 @@
 const report = () => 'Avoid trailing whitespaces';
 
 const fix = (heading, tree) => {
-    const latest = heading.children[heading.children.length - 1];
+    const latest = heading.children.at(-1);
     
     if (latest.type === 'text' && latest.value === ' ')
         heading.children = heading.children.slice(0, -1);
     
-    if (latest.type === 'text' && / $/.test(latest.value))
+    if (latest.type === 'text' && latest.value.endsWith(' '))
         latest.value = latest.value.slice(0, -1);
     
     tree.children[0].children = heading.children;
@@ -18,9 +18,9 @@ const traverse = (tree, {push}) => {
     if (heading.type !== 'heading')
         return;
     
-    const latest = heading.children[heading.children.length - 1];
+    const latest = heading.children.at(-1);
     
-    if (latest.type === 'text' && / $/.test(latest.value))
+    if (latest.type === 'text' && latest.value.endsWith(' '))
         push(heading);
 };
 

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "@putout/processor-markdown",
-  "version": "5.5.0",
+  "version": "7.0.0",
+  "type": "module",
   "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",
+  "description": "🐊Putout processor adds ability to parse markdown files and lint js snippets",
+  "homepage": "https://github.com/coderaiser/putout/tree/master/packages/processor-markdown#readme",
   "main": "lib/markdown.js",
   "release": false,
   "tag": false,
@@ -28,7 +29,6 @@
     "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"
@@ -39,25 +39,25 @@
     "markdown"
   ],
   "devDependencies": {
-    "@putout/test": "^3.5.0",
+    "@putout/test": "^5.0.0",
     "c8": "^7.5.0",
     "eslint": "^8.0.1",
     "eslint-plugin-node": "^11.0.0",
-    "eslint-plugin-putout": "^11.0.0",
+    "eslint-plugin-putout": "^15.0.0",
     "lerna": "^4.0.0",
-    "madrun": "^8.0.1",
+    "madrun": "^9.0.0",
     "nodemon": "^2.0.1",
     "putout": "*",
-    "supertape": "^6.10.0"
+    "supertape": "^7.0.0"
   },
   "peerDependencies": {
-    "putout": ">=18"
+    "putout": ">=25"
   },
-  "license": "MIT",
   "engines": {
-    "node": ">=14"
+    "node": ">=16"
   },
   "publishConfig": {
     "access": "public"
-  }
+  },
+  "license": "MIT"
 }