@putout/plugin-markdown 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) coderaiser
+
+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.

package/README.md

@@ -0,0 +1,50 @@
+# @putout/plugin-markdown [![NPM version][NPMIMGURL]][NPMURL]
+
+[NPMIMGURL]: https://img.shields.io/npm/v/@putout/plugin-markdown.svg?style=flat&longCache=true
+[NPMURL]: https://npmjs.org/package/@putout/plugin-markdown "npm"
+
+> Markdown is a lightweight markup language that you can use to add formatting elements to plaintext text documents.
+>
+> (c) [markdownguide.org](https://www.markdownguide.org/getting-started/)
+
+🐊[**Putout**](https://github.com/coderaiser/putout) plugin adds ability to improve markdown.
+
+## Install
+
+```
+npm i @putout/plugin-markdown -D
+```
+
+## Rules
+
+- ✅ [merge-heading-spaces](#merge-heading-spaces);
+
+## Config
+
+```json
+{
+    "rules": {
+        "markdown/merge-heading-spaces": "on"
+    }
+}
+```
+
+### merge-heading-spaces
+
+Checkout in 🐊[**Putout Editor**](https://putout.cloudcmd.io/#/gist/f06796710b86267ac94715381e5d2217/8e05a45fe260926959ba4289c7d692b0597c94e1).
+
+## ❌ Example of incorrect code
+
+```markdown
+# hello  world
+```
+
+## ✅ Example of correct code
+
+```markdown
+# hello world
+```
+
+## License
+
+MIT

package/lib/index.js

@@ -0,0 +1,5 @@
+import * as mergeHeadingSpaces from './merge-heading-spaces/index.js';
+
+export const rules = {
+    'merge-heading-spaces': mergeHeadingSpaces,
+};

package/lib/merge-heading-spaces/fixture/merge-heading-spaces-fix.js

@@ -0,0 +1,8 @@
+__putout_processor_markdown([
+    h1('Hello world'),
+    h2('Hello world'),
+    h3('Hello world'),
+    h4('Hello world'),
+    h5('Hello world'),
+    h6('Hello world'),
+]);

package/lib/merge-heading-spaces/fixture/merge-heading-spaces.js

@@ -0,0 +1,8 @@
+__putout_processor_markdown([
+    h1('Hello  world'),
+    h2('Hello  world'),
+    h3('Hello  world'),
+    h4('Hello  world'),
+    h5('Hello  world'),
+    h6('Hello  world'),
+]);

package/lib/merge-heading-spaces/index.js

@@ -0,0 +1,38 @@
+import {operator} from 'putout';
+
+const {
+    setLiteralValue,
+    __markdown,
+    traverse: superTraverse,
+} = operator;
+
+export const report = () => `Merge heading spaces`;
+
+export const fix = (path) => {
+    const value = path.node.value.replace('  ', ' ');
+    setLiteralValue(path, value);
+};
+export const traverse = ({push}) => {
+    const merge = mergeHeadingSpace(push);
+    
+    return {
+        [__markdown]: (path) => {
+            superTraverse(path, {
+                'h1(__a)': merge,
+                'h2(__a)': merge,
+                'h3(__a)': merge,
+                'h4(__a)': merge,
+                'h5(__a)': merge,
+                'h6(__a)': merge,
+            });
+        },
+    };
+};
+
+const mergeHeadingSpace = (push) => (path) => {
+    const arg = path.get('arguments.0');
+    const {value} = arg.node;
+    
+    if (value.includes('  '))
+        push(arg);
+};

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@putout/plugin-markdown",
+  "version": "1.0.0",
+  "type": "module",
+  "author": "coderaiser <mnemonic.enemy@gmail.com> (https://github.com/coderaiser)",
+  "description": "🐊Putout plugin adds ability to improve markdown",
+  "homepage": "https://github.com/coderaiser/putout/tree/master/packages/plugin-markdown#readme",
+  "main": "lib/markdown.js",
+  "release": false,
+  "tag": false,
+  "changelog": false,
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/coderaiser/putout.git"
+  },
+  "scripts": {
+    "test": "madrun test",
+    "watch:test": "madrun watch:test",
+    "lint": "madrun lint",
+    "fresh:lint": "madrun fresh:lint",
+    "lint:fresh": "madrun lint:fresh",
+    "fix:lint": "madrun fix:lint",
+    "coverage": "madrun coverage",
+    "report": "madrun report"
+  },
+  "dependencies": {},
+  "keywords": [
+    "putout",
+    "putout-plugin",
+    "putout-plugin-remove",
+    "plugin",
+    "debugger"
+  ],
+  "devDependencies": {
+    "@putout/test": "^15.0.0",
+    "eslint": "^10.0.0",
+    "eslint-plugin-putout": "^31.0.0",
+    "madrun": "^13.0.0",
+    "nodemon": "^3.0.1",
+    "redlint": "^6.0.0",
+    "superc8": "^12.0.0"
+  },
+  "peerDependencies": {
+    "putout": ">=42"
+  },
+  "license": "MIT",
+  "engines": {
+    "node": ">=22"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}