Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Igorkowalski94 committed Aug 11, 2024
1 parent b4ef3fe commit e10ce80
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Enforce rules on folder structure to keep your project consistent, orderly and w
✅ File/Folder name regex validation with features like wildcard `*` and treating `.` as a character, along with other conveniences.<br>
✅ Build in case validation.<br>
✅ Inheriting the parent's name. The child inherits the name of the folder in which it is located.<br>
✅ Enforcing the existence of a file/folder when a specific file/folder exists. For example, if src/Component.tsx exists, then src/Component.test.tsx and src/stories/Component.stories.tsx must also exist.<br>
✅ Enforcing the existence of a file/folder when a specific file/folder exists. For example, if ./src/Component.tsx exists, then ./src/Component.test.tsx and ./src/stories/Component.stories.tsx must also exist.<br>
✅ Reusable rules for folder structures.<br>
✅ An option to create a separate configuration file with TypeScript support.<br>
✅ Forcing a nested/flat structure for a given folder.<br>
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"name": "eslint-plugin-project-structure",
"version": "2.1.9",
"license": "MIT",
"description": "Eslint plugin with rules that will help you achieve a project structure that is scalable, consistent, and well thought out.",
"description": "Eslint plugin with rules that will help you achieve a project structure that is scalable, consistent, and well thought out. Whether you're working alone or with a small or large team, save time by automating the reviews of key principles for a healthy project!",
"keywords": [
"eslint",
"eslint-plugin",
Expand Down

0 comments on commit e10ce80

Please sign in to comment.