From 2441d51093565b83a9a03d3e3c4f71ca86db7a32 Mon Sep 17 00:00:00 2001 From: Vanessa Yuen Date: Mon, 20 Nov 2017 14:05:47 +0800 Subject: [PATCH] add remark lint to ensure fenced codeblocks are formatted properly. --- .remarkrc | 6 ++++++ package.json | 4 +++- 2 files changed, 9 insertions(+), 1 deletion(-) create mode 100644 .remarkrc diff --git a/.remarkrc b/.remarkrc new file mode 100644 index 0000000000..a64b15136a --- /dev/null +++ b/.remarkrc @@ -0,0 +1,6 @@ +{ + "plugins": [ + ["remark-lint-code-block-style", "fenced"], + ["remark-lint-fenced-code-flag"] + ] +} \ No newline at end of file diff --git a/package.json b/package.json index d42bf431af..f65d1fd734 100644 --- a/package.json +++ b/package.json @@ -17,6 +17,8 @@ "husky": "^0.14.3", "minimist": "^1.2.0", "nugget": "^2.0.1", + "remark-cli": "^4.0.0", + "remark-preset-lint-markdown-style-guide": "^2.1.1", "request": "^2.68.0", "standard": "^8.4.0", "standard-markdown": "^4.0.0", @@ -48,7 +50,7 @@ "lint-js": "standard && cd spec && standard", "lint-cpp": "python ./script/cpplint.py", "lint-py": "python ./script/pylint.py", - "lint-docs": "npm run lint-js-in-markdown && npm run create-typescript-definitions", + "lint-docs": "remark docs -qf && npm run lint-js-in-markdown && npm run create-typescript-definitions", "lint-js-in-markdown": "standard-markdown docs", "create-api-json": "electron-docs-linter docs --outfile=out/electron-api.json --version=$npm_package_version", "create-typescript-definitions": "npm run create-api-json && electron-typescript-definitions --in=out/electron-api.json --out=out/electron.d.ts",