Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Igor Kowalski committed Jul 29, 2024
1 parent 8d1a31f commit 48f755e
Show file tree
Hide file tree
Showing 5 changed files with 43 additions and 31 deletions.
16 changes: 7 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,14 @@

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

If you want to help:<br>
Leave a ⭐ and share the link with your friends. Become part of the community!<br>
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)**.

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

#### [**Playground**](https://github.com/Igorkowalski94/eslint-plugin-project-structure-playground) for eslint-plugin-project-structure rules.
Become part of the community! Leave a ⭐ and share the link with your friends.<br>
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)**.

### Documentation:

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

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

#### Features
#### Features:

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

#### Features
#### Features:

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

Enforce naming rules.

#### Features
#### Features:

✅ Naming validation. <br>
✅ Support for classes, types, interfaces, enums, variables, functions, arrow function.<br>
Expand Down
9 changes: 6 additions & 3 deletions documentation/migration-to-2.0.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ A minor configuration fix will be required for version <= 1.4.7.

### Changes for the file .eslintrc

> [!CAUTION]
> Remember to remove comments from the JSON file. Otherwise the configuration will be incorrect.
From:

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

### New rules:

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

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

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

### Features
#### Features:

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

Enforce naming rules.

### Features
#### Features:

✅ Naming validation. <br>
✅ Support for classes, types, interfaces, enums, variables, functions, arrow function.<br>
Expand Down
17 changes: 10 additions & 7 deletions documentation/project-structure-folder-structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

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

### Features
#### Features:

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

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

#### [**Playground**](https://github.com/Igorkowalski94/eslint-plugin-project-structure-playground) for eslint-plugin-project-structure rules.
Become part of the community! Leave a ⭐ and share the link with your friends.<br>
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)**.

### Documentation:

- **[Migration guide to 2.0.0.](https://github.com/Igorkowalski94/eslint-plugin-project-structure/blob/main/documentation/migration-to-2.0.0.md)**
- **[project-structure-independent-modules](https://github.com/Igorkowalski94/eslint-plugin-project-structure/blob/main/documentation/project-structure-independent-modules.md)**
- **[project-structure-naming-rules](https://github.com/Igorkowalski94/eslint-plugin-project-structure/blob/main/documentation/project-structure-naming-rules.md)**

### Go to:

Expand Down Expand Up @@ -132,10 +139,6 @@ Create a **`folderStructure.json`** or **`folderStructure.yaml`** in the root of
> [!CAUTION]
> Remember to remove comments from the JSON file. Otherwise the configuration will be incorrect.
If you want to help:<br>
Leave a ⭐ and share the link with your friends. Become part of the community!<br>
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)**.

#### Simple example for the structure below:

```
Expand Down
16 changes: 10 additions & 6 deletions documentation/project-structure-independent-modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Create independent modules to keep your repository scalable and easy to maintain.<br>
Get rid of dependencies between modules and create truly independent functionalities.

### Features
#### Features:

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

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

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

### Documentation:

- **[project-structure-folder-structure](https://github.com/Igorkowalski94/eslint-plugin-project-structure/blob/main/documentation/project-structure-folder-structure.md)**
- **[project-structure-naming-rules](https://github.com/Igorkowalski94/eslint-plugin-project-structure/blob/main/documentation/project-structure-naming-rules.md)**

### Go to:

Expand Down Expand Up @@ -74,10 +82,6 @@ Create a **`independentModules.json`** or **`independentModules.yaml`** in the r
> [!CAUTION]
> Remember to remove comments from the JSON file. Otherwise the configuration will be incorrect.
If you want to help:<br>
Leave a ⭐ and share the link with your friends. Become part of the community!<br>
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)**.

#### Simple example for the folder structure below:

```
Expand Down
16 changes: 10 additions & 6 deletions documentation/project-structure-naming-rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Enforce naming rules.

### Features
#### Features:

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

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

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

### Documentation:

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

### Go to:

Expand Down Expand Up @@ -46,10 +54,6 @@ Add the following lines to **`.eslintrc`**.
> [!CAUTION]
> Remember to remove comments from the JSON file. Otherwise the configuration will be incorrect.
If you want to help:<br>
Leave a ⭐ and share the link with your friends. Become part of the community!<br>
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)**.

```jsonc
{
"plugins": ["project-structure"],
Expand Down

0 comments on commit 48f755e

Please sign in to comment.