From 4d80072394b4abe6fb267a14b4f60e7d8652a708 Mon Sep 17 00:00:00 2001 From: Brant Burnett Date: Fri, 16 Mar 2018 20:07:21 -0400 Subject: [PATCH] Add markdownlint to check README.md formatting (#11) --- .markdownlint.json | 3 ++ .npmignore | 1 + package-lock.json | 128 +++++++++++++++++++++++++++++++++++++++++++++ package.json | 5 +- 4 files changed, 135 insertions(+), 2 deletions(-) create mode 100644 .markdownlint.json diff --git a/.markdownlint.json b/.markdownlint.json new file mode 100644 index 0000000..feec355 --- /dev/null +++ b/.markdownlint.json @@ -0,0 +1,3 @@ +{ + "line-length": false +} diff --git a/.npmignore b/.npmignore index 5ce02e6..f495b24 100644 --- a/.npmignore +++ b/.npmignore @@ -2,6 +2,7 @@ app/ .git* .eslint* +.markdownlint* .babelrc gulpfile.js example/ diff --git a/package-lock.json b/package-lock.json index 274eedc..25bb03b 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1928,6 +1928,12 @@ "once": "1.3.3" } }, + "entities": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/entities/-/entities-1.1.1.tgz", + "integrity": "sha1-blwtClYhtdra7O+AuQ7ftc13cvA=", + "dev": true + }, "es-abstract": { "version": "1.10.0", "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.10.0.tgz", @@ -2949,6 +2955,12 @@ "natives": "1.1.1" } }, + "graceful-readlink": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/graceful-readlink/-/graceful-readlink-1.0.1.tgz", + "integrity": "sha1-TK+tdrxi8C+gObL5Tpo906ORpyU=", + "dev": true + }, "gulp": { "version": "3.9.1", "resolved": "https://registry.npmjs.org/gulp/-/gulp-3.9.1.tgz", @@ -3756,6 +3768,15 @@ "resolve": "1.5.0" } }, + "linkify-it": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/linkify-it/-/linkify-it-2.0.3.tgz", + "integrity": "sha1-2UpGSPmxwXnWT6lykSaL22zpQ08=", + "dev": true, + "requires": { + "uc.micro": "1.0.5" + } + }, "lodash": { "version": "4.17.5", "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.5.tgz", @@ -3815,6 +3836,12 @@ "integrity": "sha1-+6HEUkwZ7ppfgTa0YJ8BfPTe1pI=", "dev": true }, + "lodash.differencewith": { + "version": "4.5.0", + "resolved": "https://registry.npmjs.org/lodash.differencewith/-/lodash.differencewith-4.5.0.tgz", + "integrity": "sha1-uvr7yRi1UVTheRdqALsK76rIVLc=", + "dev": true + }, "lodash.escape": { "version": "3.2.0", "resolved": "https://registry.npmjs.org/lodash.escape/-/lodash.escape-3.2.0.tgz", @@ -3824,6 +3851,12 @@ "lodash._root": "3.0.1" } }, + "lodash.flatten": { + "version": "4.4.0", + "resolved": "https://registry.npmjs.org/lodash.flatten/-/lodash.flatten-4.4.0.tgz", + "integrity": "sha1-8xwiIlqWMtK7+OSt2+8kCqdlph8=", + "dev": true + }, "lodash.isarguments": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/lodash.isarguments/-/lodash.isarguments-3.1.0.tgz", @@ -3939,6 +3972,95 @@ "object-visit": "1.0.1" } }, + "markdown-it": { + "version": "8.4.0", + "resolved": "https://registry.npmjs.org/markdown-it/-/markdown-it-8.4.0.tgz", + "integrity": "sha512-tNuOCCfunY5v5uhcO2AUMArvKAyKMygX8tfup/JrgnsDqcCATQsAExBq7o5Ml9iMmO82bk6jYNLj6khcrl0JGA==", + "dev": true, + "requires": { + "argparse": "1.0.10", + "entities": "1.1.1", + "linkify-it": "2.0.3", + "mdurl": "1.0.1", + "uc.micro": "1.0.5" + } + }, + "markdownlint": { + "version": "0.7.0", + "resolved": "https://registry.npmjs.org/markdownlint/-/markdownlint-0.7.0.tgz", + "integrity": "sha512-qTn1Ffe/dCsCQDUrgYpMz1lsgwKTnpbIGE72N24CbXiugsQqjI/VZp813y7LMhBQaK0OGr0f9TnQtUw37hfwRg==", + "dev": true, + "requires": { + "markdown-it": "8.4.0" + } + }, + "markdownlint-cli": { + "version": "0.7.1", + "resolved": "https://registry.npmjs.org/markdownlint-cli/-/markdownlint-cli-0.7.1.tgz", + "integrity": "sha512-ar80GQjLCe3Q7MvQwOuQbdB0XVhXEOSLGv5Ppen8RYJmFjzfzNKD2CBeoDlU+nn/Tzdg4ltYonIwHFJ70uumiw==", + "dev": true, + "requires": { + "commander": "2.9.0", + "deep-extend": "0.4.2", + "glob": "7.0.6", + "lodash.differencewith": "4.5.0", + "lodash.flatten": "4.4.0", + "markdownlint": "0.7.0", + "rc": "1.1.7" + }, + "dependencies": { + "commander": { + "version": "2.9.0", + "resolved": "https://registry.npmjs.org/commander/-/commander-2.9.0.tgz", + "integrity": "sha1-nJkJQXbhIkDLItbFFGCYQA/g99Q=", + "dev": true, + "requires": { + "graceful-readlink": "1.0.1" + } + }, + "glob": { + "version": "7.0.6", + "resolved": "https://registry.npmjs.org/glob/-/glob-7.0.6.tgz", + "integrity": "sha1-IRuvr0nlJbjNkyYNFKsTYVKz9Xo=", + "dev": true, + "requires": { + "fs.realpath": "1.0.0", + "inflight": "1.0.6", + "inherits": "2.0.3", + "minimatch": "3.0.4", + "once": "1.3.3", + "path-is-absolute": "1.0.1" + } + }, + "minimatch": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.0.4.tgz", + "integrity": "sha512-yJHVQEhyqPLUTgt9B83PXu6W3rx4MvvHvSUvToogpwoGDOUQ+yDrR0HRot+yOCdCO7u4hX3pWft6kWBBcqh0UA==", + "dev": true, + "requires": { + "brace-expansion": "1.1.11" + } + }, + "rc": { + "version": "1.1.7", + "resolved": "https://registry.npmjs.org/rc/-/rc-1.1.7.tgz", + "integrity": "sha1-xepWS7B6/5/TpbMukGwdOmWUD+o=", + "dev": true, + "requires": { + "deep-extend": "0.4.2", + "ini": "1.3.5", + "minimist": "1.2.0", + "strip-json-comments": "2.0.1" + } + } + } + }, + "mdurl": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/mdurl/-/mdurl-1.0.1.tgz", + "integrity": "sha1-/oWy7HWlkDfyrf7BAP1sYBdhFS4=", + "dev": true + }, "memoizee": { "version": "0.4.11", "resolved": "https://registry.npmjs.org/memoizee/-/memoizee-0.4.11.tgz", @@ -5725,6 +5847,12 @@ "integrity": "sha1-hnrHTjhkGHsdPUfZlqeOxciDB3c=", "dev": true }, + "uc.micro": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/uc.micro/-/uc.micro-1.0.5.tgz", + "integrity": "sha512-JoLI4g5zv5qNyT09f4YAvEZIIV1oOjqnewYg5D38dkQljIzpPT296dbIGvKro3digYI1bkb7W6EP1y4uDlmzLg==", + "dev": true + }, "unc-path-regex": { "version": "0.1.2", "resolved": "https://registry.npmjs.org/unc-path-regex/-/unc-path-regex-0.1.2.tgz", diff --git a/package.json b/package.json index 3cf45aa..1d26533 100644 --- a/package.json +++ b/package.json @@ -6,7 +6,7 @@ "scripts": { "build": "gulp build", "clean": "gulp clean", - "lint": "eslint ./" + "lint": "eslint ./ && markdownlint -i node_modules ./**/*.md" }, "bin": { "couchbase-index-manager": "bin/couchbase-index-manager" @@ -44,7 +44,8 @@ "gulp": "^3.9.1", "gulp-babel": "^7.0.1", "gulp-plumber": "^1.2.0", - "gulp-sourcemaps": "^2.6.4" + "gulp-sourcemaps": "^2.6.4", + "markdownlint-cli": "^0.7.1" }, "dependencies": { "babel-runtime": "^6.26.0",