Skip to content

Commit ec8c22e

Browse files
frenckfrenck
committed
Added markdown linting via NPM
1 parent 93e1e3a commit ec8c22e

File tree

6 files changed

+172
-0
lines changed

6 files changed

+172
-0
lines changed

‎.alexignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
CONTRIBUTING.md
2+
vendor/*
3+
node_modules/*

‎.gitignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,4 @@
1+
node_modules/
12
vendor/
23
composer.lock
4+
npm-debug.log

‎.remarkrc‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
{
2+
"presets": [
3+
"remark-preset-lint-dealerdirect"
4+
],
5+
"plugins": {
6+
"validate-links": {
7+
}
8+
},
9+
"settings": {
10+
"commonmark": true,
11+
"gfm": true,
12+
"yaml": true,
13+
"rule": "-",
14+
"ruleSpaces": false,
15+
"ruleRepetition": 70,
16+
"emphasis": "*",
17+
"listItemIndent": "1",
18+
"incrementListMarker": false,
19+
"spacedTable": false
20+
}
21+
}

‎.spelling‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
B.V.
2+
Dealerdirect
3+
sublicense
4+
5+
- ./.github/ISSUE_TEMPLATE.md
6+
behaviour
7+
8+
- ./.github/PULL_REQUEST_TEMPLATE.md
9+
Github
10+
11+
- ./CONTRIBUTING.md
12+
dealerdirect.nl.
13+
opensource
14+
sexualized
15+
http
16+
17+
- ./README.md
18+
Linters
19+
_CodeSniffer
20+
GrumPHP
21+
Githooks
22+
_Depend
23+
PhpMetrics
24+
SensioLabs
25+
Behat
26+
Codeception
27+
ParaTest
28+
PHPUnit
29+
Goutte
30+
Selenium2
31+
WebDriver
32+
PHPCompatibility
33+
ApiGen
34+
_CodeBrowser
35+
phpcov
36+
frontend
37+
_CodeCoverage
38+
phpDocumentor
39+
phpDox
40+
Sami
41+
metapackage
42+
codebase
43+
versioning
44+
https
45+
_eyes
46+
Nijhof
47+
devops
48+
workingatdealerdirect.eu

‎.yamllint‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
rules:
3+
braces:
4+
level: error
5+
min-spaces-inside: 0
6+
max-spaces-inside: 1
7+
brackets:
8+
level: error
9+
min-spaces-inside: 0
10+
max-spaces-inside: 0
11+
colons:
12+
level: error
13+
max-spaces-before: 0
14+
max-spaces-after: 1
15+
commas:
16+
level: error
17+
max-spaces-before: 0
18+
min-spaces-after: 1
19+
max-spaces-after: 1
20+
comments:
21+
level: error
22+
require-starting-space: true
23+
min-spaces-from-content: 2
24+
comments-indentation:
25+
level: error
26+
document-end:
27+
level: error
28+
present: false
29+
document-start:
30+
level: error
31+
present: true
32+
empty-lines:
33+
level: error
34+
max: 1
35+
max-start: 0
36+
max-end: 1
37+
hyphens:
38+
level: error
39+
max-spaces-after: 1
40+
indentation:
41+
level: error
42+
spaces: 2
43+
indent-sequences: true
44+
check-multi-line-strings: false
45+
key-duplicates:
46+
level: error
47+
line-length:
48+
level: warning
49+
max: 120
50+
allow-non-breakable-words: true
51+
allow-non-breakable-inline-mappings: true
52+
new-line-at-end-of-file:
53+
level: error
54+
new-lines:
55+
level: error
56+
type: unix
57+
trailing-spaces:
58+
level: error
59+
truthy:
60+
level: error

‎package.json‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
{
2+
"name": "dealerdirect-php-qa-tools",
3+
"version": "0.1.0",
4+
"description": "PHP Composer meta package for installing all PHP QA tools you'll ever need.",
5+
"keywords": [
6+
"dealerdirect",
7+
"guides"
8+
],
9+
"author": "Franck Nijhof <f.nijhof@dealerdirect.nl>",
10+
"homepage": "https://github.com/dealerdirect/php-qa-tools",
11+
"license": "MIT",
12+
"dependencies": {
13+
"alex": "^4.0.1",
14+
"markdown-spellcheck": "^0.11.0",
15+
"remark-cli": "^2.1.0",
16+
"remark-lint": "^5.2.0",
17+
"remark-lint-books-links": "^1.0.0",
18+
"remark-lint-no-empty-sections": "^1.0.0",
19+
"remark-lint-no-url-trailing-slash": "^2.0.0",
20+
"remark-preset-lint-dealerdirect": "^0.1.0",
21+
"remark-validate-links": "^5.0.0"
22+
},
23+
"scripts": {
24+
"lint:alex": "alex .",
25+
"lint:remark": "remark -f . --ignore-path '.gitignore'",
26+
"lint:spellcheck": "find . -type f -name '*.md' -not -path './CHANGELOG.md' -not -path './node_modules/*' -not -path './vendor/*' -print0 | xargs -0 -n1 mdspell --report --en-us --ignore-numbers --ignore-acronyms",
27+
"lint:spellcheck-interactive": "find . -type f -name '*.md' -not -path './node_modules/*' --not-path '.v/endor/*' -print0 | xargs -0 -n1 mdspell --en-us --ignore-numbers --ignore-acronyms",
28+
"lint": "npm run lint:alex && npm run lint:remark && npm run lint:spellcheck-interactive",
29+
"test": "npm run lint:alex && npm run lint:remark && npm run lint:spellcheck"
30+
},
31+
"repository": {
32+
"type": "git",
33+
"url": "git+https://github.com/dealerdirect/php-qa-tools.git"
34+
},
35+
"bugs": {
36+
"url": "https://github.com/dealerdirect/php-qa-tools/issues"
37+
}
38+
}

0 commit comments

Comments
 (0)