Skip to content

Commit

Permalink
Merge pull request #11 from watilde/feature/update-meta
Browse files Browse the repository at this point in the history
Update docs, meta info and add lint
  • Loading branch information
patrickm68 committed Nov 30, 2018
2 parents bab76ed + b4ea07a commit 2ec6b9e
Show file tree
Hide file tree
Showing 4 changed files with 72 additions and 58 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,12 @@
# remark-preset-lint-node
remark preset to configure remark-lint with settings for nodejs/node

## Install
```console
$ npm install remark-preset-lint-node
```

## Test
```console
$ npm test
```
92 changes: 45 additions & 47 deletions index.js
Original file line number Diff line number Diff line change
@@ -1,60 +1,58 @@
// @see https://github.com/nodejs/node/blob/master/doc/STYLE_GUIDE.md

'use strict';
"use strict";

module.exports.plugins = [
require('remark-lint'),
require('remark-lint-checkbox-content-indent'),
require('remark-lint-definition-spacing'),
require('remark-lint-fenced-code-flag'),
require('remark-lint-final-definition'),
require('remark-lint-final-newline'),
require('remark-lint-hard-break-spaces'),
require('remark-lint-hard-break-spaces'),
require("remark-lint"),
require("remark-lint-checkbox-content-indent"),
require("remark-lint-definition-spacing"),
require("remark-lint-fenced-code-flag"),
require("remark-lint-final-definition"),
require("remark-lint-final-newline"),
require("remark-lint-hard-break-spaces"),
require("remark-lint-hard-break-spaces"),
[require("remark-lint-list-item-indent"), "space"],
require("remark-lint-maximum-line-length"),
require("remark-lint-no-auto-link-without-protocol"),
require("remark-lint-no-blockquote-without-marker"),
require("remark-lint-no-duplicate-definitions"),
require("remark-lint-no-file-name-articles"),
require("remark-lint-no-file-name-consecutive-dashes"),
require("remark-lint-no-file-name-outer-dashes"),
require("remark-lint-no-heading-content-indent"),
require("remark-lint-no-heading-indent"),
require("remark-lint-no-inline-padding"),
require("remark-lint-no-multiple-toplevel-headings"),
require("remark-lint-no-shell-dollars"),
require("remark-lint-no-shortcut-reference-image"),
require("remark-lint-no-table-indentation"),
require("remark-lint-no-tabs"),
require("remark-lint-no-trailing-spaces"),
require("remark-lint-no-unused-definitions"),
require("remark-lint-rule-style"),
require("remark-lint-table-pipes"),
[require("remark-lint-blockquote-indentation"), 2],
[
require('remark-lint-list-item-indent'),
'space'
],
require('remark-lint-maximum-line-length'),
require('remark-lint-no-auto-link-without-protocol'),
require('remark-lint-no-blockquote-without-marker'),
require('remark-lint-no-duplicate-definitions'),
require('remark-lint-no-file-name-articles'),
require('remark-lint-no-file-name-consecutive-dashes'),
require('remark-lint-no-file-name-outer-dashes'),
require('remark-lint-no-heading-content-indent'),
require('remark-lint-no-heading-indent'),
require('remark-lint-no-inline-padding'),
require('remark-lint-no-multiple-toplevel-headings'),
require('remark-lint-no-shell-dollars'),
require('remark-lint-no-shortcut-reference-image'),
require('remark-lint-no-table-indentation'),
require('remark-lint-no-tabs'),
require('remark-lint-no-trailing-spaces'),
require('remark-lint-no-unused-definitions'),
require('remark-lint-rule-style'),
require('remark-lint-table-pipes'),
[require('remark-lint-blockquote-indentation'), 2],
[
require('remark-lint-checkbox-character-style'),
require("remark-lint-checkbox-character-style"),
{
'checked': 'x', 'unchecked': ' '
checked: "x",
unchecked: " "
}
],
[require('remark-lint-code-block-style'), 'fenced'],
[require('remark-lint-fenced-code-marker'), '`'],
[require('remark-lint-file-extension'), 'md'],
[require('remark-lint-first-heading-level'), 1],
[require('remark-lint-heading-style'), 'atx'],
[require("remark-lint-code-block-style"), "fenced"],
[require("remark-lint-fenced-code-marker"), "`"],
[require("remark-lint-file-extension"), "md"],
[require("remark-lint-first-heading-level"), 1],
[require("remark-lint-heading-style"), "atx"],
[
require('remark-lint-prohibited-strings'),
require("remark-lint-prohibited-strings"),
[
{ no: 'Github', yes: 'GitHub' },
{ no: 'Javascript', yes: 'JavaScript' },
{ no: 'Node.JS', yes: 'Node.js' },
{ no: 'v8', yes: 'V8' }
{ no: "Github", yes: "GitHub" },
{ no: "Javascript", yes: "JavaScript" },
{ no: "Node.JS", yes: "Node.js" },
{ no: "v8", yes: "V8" }
]
],
[require('remark-lint-strong-marker'), '*'],
[require('remark-lint-table-cell-padding'), 'padded']
[require("remark-lint-strong-marker"), "*"],
[require("remark-lint-table-cell-padding"), "padded"]
];
11 changes: 6 additions & 5 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

17 changes: 11 additions & 6 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,21 @@
"description": "remark preset to configure remark-lint with settings for nodejs/node",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
"test": "prettier index.js --write"
},
"repository": {
"type": "git",
"url": "git+https://github.com/watilde/remark-preset-lint-node.git"
"url": "git+https://github.com/nodejs/remark-preset-lint-node.git"
},
"keywords": [],
"author": "",
"keywords": [
"remark"
],
"author": "Daijiro Wachi",
"license": "MIT",
"bugs": {
"url": "https://github.com/watilde/remark-preset-lint-node/issues"
"url": "https://github.com/nodejs/remark-preset-lint-node/issues"
},
"homepage": "https://github.com/watilde/remark-preset-lint-node#readme",
"homepage": "https://github.com/nodejs/remark-preset-lint-node#readme",
"dependencies": {
"remark-lint": "^6.0.0",
"remark-lint-blockquote-indentation": "^1.0.0",
Expand Down Expand Up @@ -55,5 +57,8 @@
"remark-lint-strong-marker": "^1.0.0",
"remark-lint-table-cell-padding": "^1.0.0",
"remark-lint-table-pipes": "^1.0.0"
},
"devDependencies": {
"prettier": "^1.15.2"
}
}

0 comments on commit 2ec6b9e

Please sign in to comment.