Skip to content

Commit 4a902ac

Browse files
committed
added remark (linter for .md files)
1 parent 4aa933f commit 4a902ac

7 files changed

+396
-15
lines changed

.remarkignore

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
tmp
2+
build
3+
dist
4+
coverage

.remarkrc

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"plugins": [
3+
"remark-preset-lint-recommended",
4+
["remark-lint-list-item-indent", false]
5+
]
6+
}

CHANGES.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,4 @@ adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
1414
- jest test suite setup
1515
- ESLint and prettier setup
1616
- babel setup
17-
- styled-components setup
17+
- styled-components setup

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Contributing
22

33
**Working on your first Pull Request?** You can learn how from this *free*
4-
series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)
4+
series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)

README.md

+19
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,25 @@ Please, be patient. I will soon add "How to" sections. They are going to tell yo
3333

3434
Stay tuned!
3535

36+
### How to add new dependencies
37+
38+
Adding `devDependencies` looks like this:
39+
40+
```sh
41+
yarn add <package-name> --dev -W
42+
```
43+
44+
This will add the dependency too the root `package.json` and make it available
45+
to all packages.
46+
47+
Adding a new `dependency` for all or one of the packages looks like this:
48+
49+
```sh
50+
npx lerna add <package-name>
51+
```
52+
53+
One can read more about the command (eg. how to scope it, etc.) [here](https://github.com/lerna/lerna/tree/master/commands/add).
54+
3655
### How to test publishing
3756

3857
This repository comes with a pre-configured [verdaccio](https://verdaccio.org/)

package.json

+5-1
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,10 @@
1414
"build-storybook": "build-storybook -c .storybook -o dist/storybook",
1515
"clean": "lerna clean",
1616
"clean-dist": "lerna run prebuild --stream --parallel",
17-
"lint": "yarn lint-css && yarn lint-js",
17+
"lint": "yarn lint-css && yarn lint-js && yarn lint-md",
1818
"lint-css": "stylelint 'packages/**/*.js'",
1919
"lint-js": "eslint ./packages",
20+
"lint-md": "remark .",
2021
"lint-lerna": "lerna run lint --stream --parallel",
2122
"prepublishOnly": "yarn clean && yarn && yarn build",
2223
"publish": "lerna publish",
@@ -95,6 +96,9 @@
9596
"lint-staged": "^8.1.3",
9697
"prettier": "^1.16.4",
9798
"react-scripts": "^2.1.3",
99+
"remark-cli": "6.0.1",
100+
"remark-lint": "6.0.4",
101+
"remark-preset-lint-recommended": "3.0.2",
98102
"rimraf": "^2.6.3",
99103
"storybook-addon-jsx": "^6.0.0",
100104
"storybook-readme": "^4.0.5",

0 commit comments

Comments
 (0)