Skip to content

Commit 83563ef

Browse files
committed
refactor: rename as check-folder
1 parent 939ee67 commit 83563ef

File tree

4 files changed

+13
-12
lines changed

4 files changed

+13
-12
lines changed

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# eslint-plugin-checkfolder
1+
# eslint-plugin-check-folder
22

33
Allows you to enforce a consistent naming pattern for the folder of the specified file.
44

@@ -10,20 +10,21 @@ You'll first need to install [ESLint](https://eslint.org/):
1010
npm i eslint --save-dev
1111
```
1212

13-
Next, install `eslint-plugin-checkfolder`:
13+
Next, install
14+
`eslint-plugin-check-folder`:
1415

1516
```sh
16-
npm install eslint-plugin-checkfolder --save-dev
17+
npm install eslint-plugin-check-folder --save-dev
1718
```
1819

1920
## Usage
2021

21-
Add `checkfolder` to the plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:
22+
Add `check-folder` to the plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:
2223

2324
```json
2425
{
2526
"plugins": [
26-
"checkfolder"
27+
"check-folder"
2728
]
2829
}
2930
```
@@ -34,7 +35,7 @@ Then configure the rules you want to use under the rules section.
3435
```json
3536
{
3637
"rules":{
37-
"checkfolder/match-with-fex":[
38+
"check-folder/match-with-fex":[
3839
"error",
3940
{
4041
"*.test.{js,jsx,ts,tsx}":"**/__tests__/",
@@ -47,6 +48,6 @@ Then configure the rules you want to use under the rules section.
4748

4849
## Supported Rules
4950

50-
- [checkfolder/match-with-fex](docs/rules/match-with-fex.md): Enforce a consistent naming pattern for the folder of the specified file
51+
- [check-folder/match-with-fex](docs/rules/match-with-fex.md): Enforce a consistent naming pattern for the folder of the specified file
5152

5253

docs/rules/match-with-fex.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ This rule aims to format the folder of the specified file. This rule uses the gl
99
If the rule had been set as follows:
1010
```js
1111
...
12-
'checkfolder/match-with-fex': ['error', {'*.test.js': '**/__tests__/'}],
12+
'check-folder/match-with-fex': ['error', {'*.test.js': '**/__tests__/'}],
1313
...
1414
```
1515

@@ -29,10 +29,10 @@ You need to specify a different naming pattern for different file extensions. Th
2929
```js
3030
module.exports = {
3131
plugins: [
32-
'checkfolder',
32+
'check-folder',
3333
],
3434
rules: {
35-
'checkfolder/match-with-fex': ['error', {
35+
'check-folder/match-with-fex': ['error', {
3636
'*.test.{js,jsx,ts,tsx}': '**/__tests__/',
3737
'*.styled.{jsx,tsx}': '**/pages/',
3838
}],

package-lock.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "eslint-plugin-checkfolder",
2+
"name": "eslint-plugin-check-folder",
33
"version": "0.0.0",
44
"description": "Check the file folder",
55
"keywords": [

0 commit comments

Comments
 (0)