Skip to content
This repository was archived by the owner on Mar 7, 2019. It is now read-only.

Commit 3414630

Browse files
chore: add remark for markdown validation 🎨
1 parent f9fe29f commit 3414630

File tree

7 files changed

+2556
-150
lines changed

7 files changed

+2556
-150
lines changed

‎.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ thumbs.db
55
# Node.js-specific excludes
66
node_modules
77

8+
# Generated files
9+
.eslintcache
10+
811
# Logs'n stuff
912
*.seed
1013
*.log

‎.remarkrc.js

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
'use strict'
2+
3+
module.exports = {
4+
settings: {
5+
emphasis: '_',
6+
},
7+
plugins: [
8+
'preset-lint-recommended',
9+
'preset-lint-consistent',
10+
'preset-lint-markdown-style-guide',
11+
12+
['lint-list-item-indent', 'space'],
13+
['lint-maximum-line-length', Infinity],
14+
['lint-emphasis-marker', '_'],
15+
['lint-list-item-spacing', false],
16+
['lint-table-pipe-alignment', false],
17+
['lint-table-cell-padding', 'consistent'],
18+
],
19+
}

‎README.md

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,10 @@
1-
[eslint-url]: http://eslint.org
2-
[travis-badge]: https://travis-ci.org/strvcom/eslint-config-javascript.svg
3-
[travis-url]: https://travis-ci.org/strvcom/eslint-config-javascript
4-
[eslint-version]: https://img.shields.io/badge/ESLint-^5.3.0-brightgreen.svg
5-
[eslint-fixing]: http://eslint.org/docs/user-guide/command-line-interface#fix
6-
[flow-home]: https://flow.org
7-
[react-home]: http://reactjs.com
8-
[nodejs-home]: https://nodejs.org
9-
[mocha-home]: https://mochajs.org
10-
11-
121
# JavaScript Coding Standards
132

143
> Write bulletproof JavaScript like a pro! 😎
154
165
[![Build Status][travis-badge]][travis-url]
176
![ESLint version][eslint-version]
187

19-
208
## About
219

2210
This repository contains various configuration files for the awesome JavaScript linter, [ESLint][eslint-url]. The configuration files are purposefully separated into various categories to allow their composition according to developers' preferences or requirements. It should also make adoption of ESLint across existing codebases easier.
@@ -31,7 +19,7 @@ This package can be installed via npm (make sure you also install the latest ver
3119

3220
### Configuration
3321

34-
Once the ruleset is installed, you must create your own *.eslintrc.{js,json,yml}* configuration file in your project's root (or in some of the subfolders, if you want to apply different rules to different parts of your code) and include those rulesets that you want to use. See the [tutorial](tutorial) directory for, well... tutorial.
22+
Once the ruleset is installed, you must create your own _.eslintrc.{js,json,yml}_ configuration file in your project's root (or in some of the subfolders, if you want to apply different rules to different parts of your code) and include those rulesets that you want to use. See the [tutorial](tutorial) directory for, well... tutorial.
3523

3624
### Integrating ESLint with your IDE/editor
3725

@@ -81,3 +69,13 @@ These rulesets include rules which deal with how the code looks like and not how
8169
## License
8270

8371
This software is licensed under the **BSD-3-Clause License**. See the [LICENSE](LICENSE) file for more information.
72+
73+
[eslint-url]: http://eslint.org
74+
[travis-badge]: https://travis-ci.org/strvcom/eslint-config-javascript.svg
75+
[travis-url]: https://travis-ci.org/strvcom/eslint-config-javascript
76+
[eslint-version]: https://img.shields.io/badge/ESLint-^5.3.0-brightgreen.svg
77+
[eslint-fixing]: http://eslint.org/docs/user-guide/command-line-interface#fix
78+
[flow-home]: https://flow.org
79+
[react-home]: http://reactjs.com
80+
[nodejs-home]: https://nodejs.org
81+
[mocha-home]: https://mochajs.org

‎environments/react/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
[a11y-repo]: https://github.com/evcohen/eslint-plugin-jsx-a11y
2-
31
# React
42

53
These configuration files are suitable to lint React components.
@@ -23,3 +21,5 @@ Use this ruleset in conjunction with any of the above version-specific rulesets.
2321
### @strv/javascript/environment/react/accessibility
2422

2523
Use this ruleset to enable the [`a11y`][a11y-repo] rules which provide checks for writing accessible JSX components.
24+
25+
[a11y-repo]: https://github.com/evcohen/eslint-plugin-jsx-a11y

0 commit comments

Comments
 (0)