Skip to content

Commit 23e588e

Browse files
committed
validate urls in Markdown files
1 parent f3f8de9 commit 23e588e

File tree

4 files changed

+108
-3
lines changed

4 files changed

+108
-3
lines changed

.circleci/config.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,9 @@ jobs:
1818
workflows:
1919
build:
2020
jobs:
21-
- cypress/install
21+
- cypress/install:
22+
post-steps:
23+
- run: npm run check:markdown
2224
- cypress/run:
2325
name: frontend coverage
2426
requires:

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -319,9 +319,17 @@ npx nyc report --check-coverage true --lines 100 --include cypress/about.js
319319
npx nyc report --check-coverage true --lines 100 --include cypress/unit.js
320320
```
321321

322+
### Markdown
323+
324+
You can validate links in Markdown files in this directory by executing (Linux + Mac only) script
325+
326+
```shell
327+
npm run check:markdown
328+
```
329+
322330
## License
323331

324-
This project is licensed under the terms of the [MIT license](/LICENSE.md).
332+
This project is licensed under the terms of the [MIT license](LICENSE.md).
325333

326334
[renovate-badge]: https://img.shields.io/badge/renovate-app-blue.svg
327335
[renovate-app]: https://renovateapp.com/

package-lock.json

Lines changed: 93 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@
1515
"format": "prettier --write '*.js'",
1616
"start:test:backend": "nyc --silent node test-backend",
1717
"cy:backend": "cypress open --config-file cypress-backend.json",
18-
"dev:backend": "start-test start:test:backend 3003 cy:backend"
18+
"dev:backend": "start-test start:test:backend 3003 cy:backend",
19+
"check:markdown": "find . -d 1 -name \\*.md -exec npx markdown-link-check {} \\;"
1920
},
2021
"peerDependencies": {
2122
"cypress": "*",
@@ -59,6 +60,7 @@
5960
"express": "4.17.1",
6061
"istanbul-lib-coverage": "3.0.0",
6162
"lodash": "4.17.15",
63+
"markdown-link-check": "3.8.0",
6264
"nyc": "15.0.0",
6365
"parcel-bundler": "1.12.4",
6466
"prettier": "1.19.1",

0 commit comments

Comments
 (0)