12
12
[ ![ Build Status] ( https://github.com/ota-meshi/eslint-plugin-regexp/workflows/CI/badge.svg?branch=master )] ( https://github.com/ota-meshi/eslint-plugin-regexp/actions?query=workflow%3ACI )
13
13
[ ![ Coverage Status] ( https://coveralls.io/repos/github/ota-meshi/eslint-plugin-regexp/badge.svg?branch=master )] ( https://coveralls.io/github/ota-meshi/eslint-plugin-regexp?branch=master )
14
14
15
- ## Features
15
+ ## : name_badge : Features
16
16
17
17
This ESLint plugin provides linting rules relate to better ways to help you avoid problems when using RegExp.
18
18
19
+ - Find the wrong usage of regular expressions, and their hints.
20
+ - Enforces a consistent style of regular expressions.
21
+ - Find hints for writing optimized regular expressions.
22
+
19
23
You can check on the [ Online DEMO] ( https://ota-meshi.github.io/eslint-plugin-regexp/playground/ ) .
20
24
21
25
<!-- DOCS_IGNORE_START-->
22
26
23
- ## Documentation
27
+ ## : book : Documentation
24
28
25
29
See [ documents] ( https://ota-meshi.github.io/eslint-plugin-regexp/ ) .
26
30
27
- ## Installation
31
+ ## : cd : Installation
28
32
29
33
``` bash
30
34
npm install --save-dev eslint eslint-plugin-regexp
@@ -37,7 +41,7 @@ npm install --save-dev eslint eslint-plugin-regexp
37
41
38
42
<!-- DOCS_IGNORE_END-->
39
43
40
- ## Usage
44
+ ## : book : Usage
41
45
42
46
<!-- USAGE_SECTION_START-->
43
47
@@ -59,7 +63,7 @@ module.exports = {
59
63
}
60
64
```
61
65
62
- ## Configs
66
+ ### Configuration
63
67
64
68
This plugin provides one config:
65
69
@@ -68,7 +72,7 @@ This plugin provides one config:
68
72
69
73
<!-- USAGE_SECTION_END-->
70
74
71
- ## Rules
75
+ ## : white_check_mark : Rules
72
76
73
77
<!-- RULES_SECTION_START-->
74
78
@@ -117,7 +121,11 @@ The rules with the following star :star: are included in the `plugin:regexp/reco
117
121
118
122
<!-- DOCS_IGNORE_START-->
119
123
120
- ## Contributing
124
+ <!-- ## :traffic_light: Semantic Versioning Policy
125
+
126
+ **eslint-plugin-jsonc** follows [Semantic Versioning](http://semver.org/) and [ESLint's Semantic Versioning Policy](https://github.com/eslint/eslint#semantic-versioning-policy). -->
127
+
128
+ ## :beers : Contributing
121
129
122
130
Welcome contributing!
123
131
@@ -130,6 +138,6 @@ Please use GitHub's Issues/PRs.
130
138
131
139
<!-- DOCS_IGNORE_END-->
132
140
133
- ## License
141
+ ## : lock : License
134
142
135
143
See the [ LICENSE] ( LICENSE ) file for license rights and limitations (MIT).
0 commit comments