From 7c3c1b95ccee2db45b397b79b44786137ff84d73 Mon Sep 17 00:00:00 2001 From: Roy Ivy III Date: Sat, 30 Jan 2021 01:03:53 -0600 Subject: [PATCH] maint/dev ~ update Remark markdown-linting configuration and plugins --- .remarkrc.js | 28 ++++++++++++++++++++++++++++ package.json | 11 ++++++++++- 2 files changed, 38 insertions(+), 1 deletion(-) create mode 100644 .remarkrc.js diff --git a/.remarkrc.js b/.remarkrc.js new file mode 100644 index 0000000..2e78851 --- /dev/null +++ b/.remarkrc.js @@ -0,0 +1,28 @@ +// spell-checker:ignore frontmatter retext +exports.plugins = [ + require('remark-footnotes'), + // require('remark-frontmatter'), + [ + require('remark-retext'), + require('unified')().use({ + plugins: [ + require('retext-english'), + require('retext-syntax-urls'), + // [require('retext-spell'), require('dictionary-en')], + [require('retext-sentence-spacing'), { preferred: 1 }], + require('retext-repeated-words'), + require('retext-passive'), + ], + }), + ], + 'remark-preset-lint-consistent', + 'remark-preset-lint-recommended', + 'remark-preset-lint-markdown-style-guide', + ['remark-lint-emphasis-marker', 'consistent'], + ['remark-lint-file-extension', false], + ['remark-lint-heading-increment', false], + ['remark-lint-list-item-indent', 'mixed'], + ['remark-lint-maximum-line-length', false], + ['remark-lint-no-duplicate-headings', false], + ['remark-lint-unordered-list-marker-style', 'consistent'], +]; diff --git a/package.json b/package.json index 7991e95..fca48b6 100644 --- a/package.json +++ b/package.json @@ -177,14 +177,23 @@ "prettier": "^2.1.1", "remark-cli": "^9.0.0", "remark-footnotes": "^3.0.0", + "remark-preset-lint-consistent": "^4.0.0", + "remark-preset-lint-markdown-style-guide": "^4.0.0", "remark-preset-lint-recommended": "^5.0.0", + "remark-retext": "^4.0.0", + "retext-english": "^3.0.4", + "retext-passive": "^3.0.0", + "retext-repeated-words": "^3.0.0", + "retext-sentence-spacing": "^4.0.0", + "retext-syntax-urls": "^2.0.0", "rimraf": "^3.0.2", "rollup": "^2.36.1", "rollup-plugin-typescript2": "^0.29.0", "shx": "^0.3.3", "ts-node": "^9.0.0", "tsd": "^0.14.0", - "typescript": "^4.1.3" + "typescript": "^4.1.3", + "unified": "^9.2.0" }, "optionalDependencies": {}, "ava": {