Skip to content

Commit 48f755e

Browse files
author
Igor Kowalski
committed
Update documentation
1 parent 8d1a31f commit 48f755e

File tree

5 files changed

+43
-31
lines changed

5 files changed

+43
-31
lines changed

README.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,14 @@
22

33
Eslint plugin with rules that will help you achieve a project structure that is scalable, consistent, and well thought out.
44

5-
If you want to help:<br>
6-
Leave a ⭐ and share the link with your friends. Become part of the community!<br>
7-
If you have any questions **[click here](https://github.com/Igorkowalski94/eslint-plugin-project-structure/discussions)**, issues / an idea for a new functionality **[click here](https://github.com/Igorkowalski94/eslint-plugin-project-structure/issues/new/choose)**.
8-
9-
#### [**Migration guide to 2.0.0.**](https://github.com/Igorkowalski94/eslint-plugin-project-structure/blob/main/documentation/migration-to-2.0.0.md)
5+
[**Playground**](https://github.com/Igorkowalski94/eslint-plugin-project-structure-playground) for eslint-plugin-project-structure rules.
106

11-
#### [**Playground**](https://github.com/Igorkowalski94/eslint-plugin-project-structure-playground) for eslint-plugin-project-structure rules.
7+
Become part of the community! Leave a ⭐ and share the link with your friends.<br>
8+
If you have any questions **[click here](https://github.com/Igorkowalski94/eslint-plugin-project-structure/discussions)**, issues / an idea for a new functionality **[click here](https://github.com/Igorkowalski94/eslint-plugin-project-structure/issues/new/choose)**.
129

1310
### Documentation:
1411

12+
- **[Migration guide to 2.0.0.](https://github.com/Igorkowalski94/eslint-plugin-project-structure/blob/main/documentation/migration-to-2.0.0.md)**
1513
- **[project-structure-folder-structure](https://github.com/Igorkowalski94/eslint-plugin-project-structure/blob/main/documentation/project-structure-folder-structure.md)**
1614
- **[project-structure-independent-modules](https://github.com/Igorkowalski94/eslint-plugin-project-structure/blob/main/documentation/project-structure-independent-modules.md)**
1715
- **[project-structure-naming-rules](https://github.com/Igorkowalski94/eslint-plugin-project-structure/blob/main/documentation/project-structure-naming-rules.md)**
@@ -22,7 +20,7 @@ If you have any questions **[click here](https://github.com/Igorkowalski94/eslin
2220

2321
Enforce rules on folder structure to keep your repository consistent, orderly and well thought out.
2422

25-
#### Features
23+
#### Features:
2624

2725
✅ Validation of folder structure (Any files/folders outside the structure will be considered an error).<br>
2826
✅ Validation of folder and file names.<br>
@@ -38,7 +36,7 @@ Enforce rules on folder structure to keep your repository consistent, orderly an
3836
Create independent modules to keep your repository scalable and easy to maintain.<br>
3937
Get rid of dependencies between modules and create truly independent functionalities.
4038

41-
#### Features
39+
#### Features:
4240

4341
✅ Creating independent modules in which you control what can be imported.<br>
4442
✅ Disabling external imports (node_modules) for a given module (Option to add exceptions). <br>
@@ -52,7 +50,7 @@ Get rid of dependencies between modules and create truly independent functionali
5250

5351
Enforce naming rules.
5452

55-
#### Features
53+
#### Features:
5654

5755
✅ Naming validation. <br>
5856
✅ Support for classes, types, interfaces, enums, variables, functions, arrow function.<br>

documentation/migration-to-2.0.0.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ A minor configuration fix will be required for version <= 1.4.7.
66

77
### Changes for the file .eslintrc
88

9+
> [!CAUTION]
10+
> Remember to remove comments from the JSON file. Otherwise the configuration will be incorrect.
11+
912
From:
1013

1114
```jsonc
@@ -109,14 +112,14 @@ The added regex is **`((([A-Z]|\d)+_)*([A-Z]|\d)+)`**.
109112

110113
### New rules:
111114

112-
#### [**Playground**](https://github.com/Igorkowalski94/eslint-plugin-project-structure-playground) for eslint-plugin-project-structure rules.
115+
[**Playground**](https://github.com/Igorkowalski94/eslint-plugin-project-structure-playground) for eslint-plugin-project-structure rules.
113116

114117
## **[project-structure-independent-modules](https://github.com/Igorkowalski94/eslint-plugin-project-structure/blob/main/documentation/project-structure-independent-modules.md)**
115118

116119
Create independent modules to keep your repository scalable and easy to maintain.<br>
117120
Get rid of dependencies between modules and create truly independent functionalities.
118121

119-
### Features
122+
#### Features:
120123

121124
✅ Creating independent modules in which you control what can be imported.<br>
122125
✅ Disabling external imports (node_modules) for a given module (Option to add exceptions). <br>
@@ -130,7 +133,7 @@ Get rid of dependencies between modules and create truly independent functionali
130133

131134
Enforce naming rules.
132135

133-
### Features
136+
#### Features:
134137

135138
✅ Naming validation. <br>
136139
✅ Support for classes, types, interfaces, enums, variables, functions, arrow function.<br>

documentation/project-structure-folder-structure.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Enforce rules on folder structure to keep your repository consistent, orderly and well thought out.
44

5-
### Features
5+
#### Features:
66

77
✅ Validation of folder structure (Any files/folders outside the structure will be considered an error).<br>
88
✅ Validation of folder and file names.<br>
@@ -13,9 +13,16 @@ Enforce rules on folder structure to keep your repository consistent, orderly an
1313
✅ Folder recursion (You can nest a given folder structure recursively).<br>
1414
✅ Forcing a nested/flat structure for a given folder.
1515

16-
#### [**Migration guide to 2.0.0.**](https://github.com/Igorkowalski94/eslint-plugin-project-structure/blob/main/documentation/migration-to-2.0.0.md)
16+
[**Playground**](https://github.com/Igorkowalski94/eslint-plugin-project-structure-playground) for eslint-plugin-project-structure rules.
1717

18-
#### [**Playground**](https://github.com/Igorkowalski94/eslint-plugin-project-structure-playground) for eslint-plugin-project-structure rules.
18+
Become part of the community! Leave a ⭐ and share the link with your friends.<br>
19+
If you have any questions **[click here](https://github.com/Igorkowalski94/eslint-plugin-project-structure/discussions)**, issues / an idea for a new functionality **[click here](https://github.com/Igorkowalski94/eslint-plugin-project-structure/issues/new/choose)**.
20+
21+
### Documentation:
22+
23+
- **[Migration guide to 2.0.0.](https://github.com/Igorkowalski94/eslint-plugin-project-structure/blob/main/documentation/migration-to-2.0.0.md)**
24+
- **[project-structure-independent-modules](https://github.com/Igorkowalski94/eslint-plugin-project-structure/blob/main/documentation/project-structure-independent-modules.md)**
25+
- **[project-structure-naming-rules](https://github.com/Igorkowalski94/eslint-plugin-project-structure/blob/main/documentation/project-structure-naming-rules.md)**
1926

2027
### Go to:
2128

@@ -132,10 +139,6 @@ Create a **`folderStructure.json`** or **`folderStructure.yaml`** in the root of
132139
> [!CAUTION]
133140
> Remember to remove comments from the JSON file. Otherwise the configuration will be incorrect.
134141
135-
If you want to help:<br>
136-
Leave a ⭐ and share the link with your friends. Become part of the community!<br>
137-
If you have any questions **[click here](https://github.com/Igorkowalski94/eslint-plugin-project-structure/discussions)**, issues / an idea for a new functionality **[click here](https://github.com/Igorkowalski94/eslint-plugin-project-structure/issues/new/choose)**.
138-
139142
#### Simple example for the structure below:
140143

141144
```

documentation/project-structure-independent-modules.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Create independent modules to keep your repository scalable and easy to maintain.<br>
44
Get rid of dependencies between modules and create truly independent functionalities.
55

6-
### Features
6+
#### Features:
77

88
✅ Creating independent modules in which you control what can be imported.<br>
99
✅ Disabling external imports (node_modules) for a given module (Option to add exceptions). <br>
@@ -13,7 +13,15 @@ Get rid of dependencies between modules and create truly independent functionali
1313
✅ Support for imports without extension. <br>
1414
✅ Reusable import patterns. <br>
1515

16-
#### [**Playground**](https://github.com/Igorkowalski94/eslint-plugin-project-structure-playground) for eslint-plugin-project-structure rules.
16+
[**Playground**](https://github.com/Igorkowalski94/eslint-plugin-project-structure-playground) for eslint-plugin-project-structure rules.
17+
18+
Become part of the community! Leave a ⭐ and share the link with your friends.<br>
19+
If you have any questions **[click here](https://github.com/Igorkowalski94/eslint-plugin-project-structure/discussions)**, issues / an idea for a new functionality **[click here](https://github.com/Igorkowalski94/eslint-plugin-project-structure/issues/new/choose)**.
20+
21+
### Documentation:
22+
23+
- **[project-structure-folder-structure](https://github.com/Igorkowalski94/eslint-plugin-project-structure/blob/main/documentation/project-structure-folder-structure.md)**
24+
- **[project-structure-naming-rules](https://github.com/Igorkowalski94/eslint-plugin-project-structure/blob/main/documentation/project-structure-naming-rules.md)**
1725

1826
### Go to:
1927

@@ -74,10 +82,6 @@ Create a **`independentModules.json`** or **`independentModules.yaml`** in the r
7482
> [!CAUTION]
7583
> Remember to remove comments from the JSON file. Otherwise the configuration will be incorrect.
7684
77-
If you want to help:<br>
78-
Leave a ⭐ and share the link with your friends. Become part of the community!<br>
79-
If you have any questions **[click here](https://github.com/Igorkowalski94/eslint-plugin-project-structure/discussions)**, issues / an idea for a new functionality **[click here](https://github.com/Igorkowalski94/eslint-plugin-project-structure/issues/new/choose)**.
80-
8185
#### Simple example for the folder structure below:
8286

8387
```

documentation/project-structure-naming-rules.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Enforce naming rules.
44

5-
### Features
5+
#### Features:
66

77
✅ Naming validation. <br>
88
✅ Support for classes, types, interfaces, enums, variables, functions, arrow function.<br>
@@ -13,7 +13,15 @@ Enforce naming rules.
1313
✅ Build in case validation.<br>
1414
✅ Different name rules for different files.<br>
1515

16-
#### [**Playground**](https://github.com/Igorkowalski94/eslint-plugin-project-structure-playground) for eslint-plugin-project-structure rules.
16+
[**Playground**](https://github.com/Igorkowalski94/eslint-plugin-project-structure-playground) for eslint-plugin-project-structure rules.
17+
18+
Become part of the community! Leave a ⭐ and share the link with your friends.<br>
19+
If you have any questions **[click here](https://github.com/Igorkowalski94/eslint-plugin-project-structure/discussions)**, issues / an idea for a new functionality **[click here](https://github.com/Igorkowalski94/eslint-plugin-project-structure/issues/new/choose)**.
20+
21+
### Documentation:
22+
23+
- **[project-structure-folder-structure](https://github.com/Igorkowalski94/eslint-plugin-project-structure/blob/main/documentation/project-structure-folder-structure.md)**
24+
- **[project-structure-independent-modules](https://github.com/Igorkowalski94/eslint-plugin-project-structure/blob/main/documentation/project-structure-independent-modules.md)**
1725

1826
### Go to:
1927

@@ -46,10 +54,6 @@ Add the following lines to **`.eslintrc`**.
4654
> [!CAUTION]
4755
> Remember to remove comments from the JSON file. Otherwise the configuration will be incorrect.
4856
49-
If you want to help:<br>
50-
Leave a ⭐ and share the link with your friends. Become part of the community!<br>
51-
If you have any questions **[click here](https://github.com/Igorkowalski94/eslint-plugin-project-structure/discussions)**, issues / an idea for a new functionality **[click here](https://github.com/Igorkowalski94/eslint-plugin-project-structure/issues/new/choose)**.
52-
5357
```jsonc
5458
{
5559
"plugins": ["project-structure"],

0 commit comments

Comments
 (0)