Skip to content

chore: Add Markdownlint #2354

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 5, 2019
Merged

chore: Add Markdownlint #2354

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions .markdownlint.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
{
"default": true,
"MD001": false,
Copy link
Member

@lpinca lpinca Jul 27, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if it makes sense to use yaml and add comments to explain what the rules do.

Copy link
Member Author

@nschonni nschonni Jul 29, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think YAML is supported in the Node version, but they do have "aliases" for the rules that are more readable. I just stuck with the rule names for the initial pass to disable the failing ones, but if you want to do a styleguide, the aliases are better

"MD004": false,
"MD005": false,
"MD006": false,
"MD007": false,
"MD009": false,
"MD010": false,
"MD012": false,
"MD013": false,
"MD014": false,
"MD018": false,
"MD019": false,
"MD022": false,
"MD024": false,
"MD025": false,
"MD026": false,
"MD027": false,
"MD028": false,
"MD029": false,
"MD030": false,
"MD031": false,
"MD032": false,
"MD033": false,
"MD034": false,
"MD035": false,
"MD036": false,
"MD038": false,
"MD039": false,
"MD040": false,
"MD041": false,
"MD042": false,
"MD046": false,
"MD047": false
}
116 changes: 116 additions & 0 deletions package-lock.json
View file
Open in desktop

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

3 changes: 2 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
"load-schedule": "curl -sS https://raw.githubusercontent.com/nodejs/Release/master/schedule.json -o source/schedule.json",
"start": "npm run serve",
"test": "npm run test:lint && npm run test:unit && npm run test:smoke",
"test:lint": "standard --fix && htmllint **/*.hbs && stylint layouts/css",
"test:lint": "standard --fix && htmllint **/*.hbs && stylint layouts/css && markdownlint \"**/*.md\" -i \"node_modules/\"",
"test:unit": "tape tests/**/*.test.js | faucet",
"test:smoke": "tape tests/*.smoketest.js | faucet"
},
Expand Down Expand Up @@ -64,6 +64,7 @@
"devDependencies": {
"faucet": "^0.0.1",
"htmllint-cli": "^0.0.6",
"markdownlint-cli": "^0.17.0",
"nock": "^10.0.6",
"pre-commit": "^1.2.2",
"proxyquire": "^2.0.1",
Expand Down