Skip to content

Commit 9c974c7

Browse files
author
Igor Kowalski
committed
Update documentation
1 parent 48f755e commit 9c974c7

File tree

3 files changed

+12
-6
lines changed

3 files changed

+12
-6
lines changed

documentation/project-structure-folder-structure.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@ Enforce rules on folder structure to keep your repository consistent, orderly an
1515

1616
[**Playground**](https://github.com/Igorkowalski94/eslint-plugin-project-structure-playground) for eslint-plugin-project-structure rules.
1717

18-
Become part of the community! Leave a ⭐ and share the link with your friends.<br>
18+
Become part of the community!<br>
19+
Leave a ⭐ and share the link with your friends.<br>
1920
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)**.
2021

2122
### Documentation:
@@ -120,6 +121,9 @@ Add the following lines to **`.eslintrc`**.
120121

121122
Add the following lines to **`.eslintrc`**.
122123

124+
> [!CAUTION]
125+
> Remember to remove comments from the JSON file. Otherwise the configuration will be incorrect.
126+
123127
```jsonc
124128
{
125129
"plugins": ["project-structure"],
@@ -136,9 +140,6 @@ Add the following lines to **`.eslintrc`**.
136140

137141
Create a **`folderStructure.json`** or **`folderStructure.yaml`** in the root of your project.<br>
138142

139-
> [!CAUTION]
140-
> Remember to remove comments from the JSON file. Otherwise the configuration will be incorrect.
141-
142143
#### Simple example for the structure below:
143144

144145
```

documentation/project-structure-independent-modules.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@ Get rid of dependencies between modules and create truly independent functionali
1515

1616
[**Playground**](https://github.com/Igorkowalski94/eslint-plugin-project-structure-playground) for eslint-plugin-project-structure rules.
1717

18-
Become part of the community! Leave a ⭐ and share the link with your friends.<br>
18+
Become part of the community!<br>
19+
Leave a ⭐ and share the link with your friends.<br>
1920
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)**.
2021

2122
### Documentation:
@@ -60,6 +61,9 @@ npm i --dev eslint-plugin-independent-modules
6061

6162
Add the following lines to **`.eslintrc`**.
6263

64+
> [!CAUTION]
65+
> Remember to remove comments from the JSON file. Otherwise the configuration will be incorrect.
66+
6367
```jsonc
6468
{
6569
"plugins": ["project-structure"],

documentation/project-structure-naming-rules.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@ Enforce naming rules.
1515

1616
[**Playground**](https://github.com/Igorkowalski94/eslint-plugin-project-structure-playground) for eslint-plugin-project-structure rules.
1717

18-
Become part of the community! Leave a ⭐ and share the link with your friends.<br>
18+
Become part of the community!<br>
19+
Leave a ⭐ and share the link with your friends.<br>
1920
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)**.
2021

2122
### Documentation:

0 commit comments

Comments
 (0)