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 24, 2024
1 parent 10f3a7d commit 734b31b
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 10 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,16 +42,16 @@ Get rid of dependencies between modules and create truly independent functionali
✅ Support for imports without extension. <br>
✅ Reusable import patterns. <br>

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

Enforce rules on export.
Enforce naming rules.

#### Features
### Features

✅ Export name validation. <br>
✅ Inheriting the file name as the export name (Option of adding your own prefixes/suffixes or changing the case).<br>
✅ Naming validation. <br>
✅ Support for all name types. Classes, types, interfaces, enums, variables, functions etc.<br>
✅ Inheriting the file name as the name (Option of adding your own prefixes/suffixes or changing the case).<br>
✅ Deleting parts of a file name. <br>
✅ Regex validation<br>
✅ Build in case validation.<br>
✅ Different export name rules for different files.<br>
✅ Support for all export types. Name export or default export for Classes, types, interfaces, variables, functions etc.<br>
✅ Different name rules for different files.<br>
5 changes: 2 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"author": "Igor Kowalski (Igorkowalski94)",
"name": "eslint-plugin-project-structure",
"version": "2.0.6",
"version": "2.0.7",
"license": "MIT",
"description": "Eslint plugin with rules that will help you achieve a project structure that is scalable, consistent, and well thought out.",
"keywords": [
Expand All @@ -17,8 +17,7 @@
"file name validation",
"folder name validation",
"extension validation",
"export validation",
"match export to filename",
"naming rules",
"independent modules",
"modules",
"import validation"
Expand Down

0 comments on commit 734b31b

Please sign in to comment.