pankod/next-boilerplate

Fork 0

[SUGGESTION] Adding eslint-plugin-project-structure to the project for validating folder structure and more, to automatically ensure scalability and consistency. #199

New issue

Open

opened 2024-10-10 05:18:13 -04:00 by Igorkowalski94 · 0 comments

Igorkowalski94 commented

2024-10-10 05:18:13 -04:00

(Migrated from github.com)

Hey, I think my library might interest you. Thanks to it, you can automatically validate your folder structure rules and much more.

If you are interested, I’d be happy to assist with the implementation and answer any questions you may have.

Below is the full description of the features:

eslint‑plugin-project‑structure

Powerful ESLint plugin with rules to help you achieve a scalable, consistent, and well-structured project.

Create your own framework! Define your folder structure, file composition, advanced naming conventions, and create independent modules.

Take your project to the next level and save time by automating the review of key principles of a healthy project!

project‑structure/folder‑structure

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

Features:

Validation of folder structure. Any files/folders outside the structure will be considered an error.
File/Folder name regex validation with features like wildcard * and treating . as a character, along with other conveniences.
Build in case validation.
Inheriting the folder's name. The file/folder inherits the name of the folder in which it is located. Option of adding your own prefixes/suffixes or changing the case.
Enforcing the existence of a files/folders 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.
Reusable rules for folder structures.
An option to create a separate configuration file with TypeScript support.
Forcing a nested/flat structure for a given folder.
Support for all file extensions.
Folder recursion. You can repeatedly nest a folder structure and set a limit on the nesting depth. There is also an option to change the rule at the final level, such as flattening the folder structure.
Fewer repetitions and precise error messages, even for deeply nested folders (recursion), by representing the folder structure as a tree.
Checking the length of paths and notifying when the limit is exceeded.

project‑structure/independent‑modules

A key principle of a healthy project is to prevent the creation of a massive dependency tree, where removing or editing one feature triggers a chain reaction that impacts the entire project.

Create independent modules to keep your project scalable and easy to maintain. Get rid of dependencies between modules and create truly independent functionalities.

Features:

Creating independent modules in which you control what can be imported (e.g. types, functions, components of one functionality cannot be imported into another functionality).
The ability to create very detailed rules, even for nested folder structures. Whether it's a large module, a sub-module, or a single file, there are no limitations.
Support for all types of imports, including require(), import(), jest.mock(), and jest.requireActual(), as well as ExportAllDeclaration and ExportNamedDeclaration.
Disabling external imports (node_modules) for a given module (Option to add exceptions).
Non-relative/relative imports support.
Support for imports without extension.
Reusable import patterns.
Support for path aliases. The plugin will automatically detect your tsconfig.json and use your settings. There is also an option to enter them manually.
An option to create a separate configuration file with TypeScript support.

project‑structure/file‑composition

Compose your ideal files!

Have full control over the order and quantity of selectors.

Define advanced naming conventions and prohibit the use of specific selectors in given files.

Features:

File composition validation.
Supported selectors: class, function, arrowFunction, type, interface, enum, variable, variableExpression.
Inheriting the filename as the selector name. Option to add your own prefixes/suffixes, change the case, or remove parts of the filename.
Prohibit the use of given selectors in a given file. For example, **/*.consts.ts files can only contain variables, **/*.types.ts files can only contain interfaces and types.
Define the order in which your selectors should appear in a given file. Support for --fix to automatically correct the order.
Rules for exported selectors, selectors in the root of the file and nested/all selectors in the file. They can be used together in combination.
Enforcing a maximum of one main function/class per file.
The ability to set a specific limit on the occurrence of certain selectors in the root of a given file.
Selector name regex validation.
Build in case validation.
Different rules for different files.
An option to create a separate configuration file with TypeScript support.

Hey, I think my library might interest you. Thanks to it, you can automatically validate your folder structure rules and much more. If you are interested, I’d be happy to assist with the implementation and answer any questions you may have. Below is the full description of the features: <p align="right"> <picture><img src="https://raw.githubusercontent.com/Igorkowalski94/eslint-plugin-project-structure/main/images/Cloud.png" alt="Cloud" width="35" height="35" /></picture> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/Igorkowalski94/eslint-plugin-project-structure/main/images/Crescent%20Moon.png"> <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/Igorkowalski94/eslint-plugin-project-structure/main/images/Sun.png"> <img alt="Shows an illustrated sun in light mode and a moon with stars in dark mode." src="https://raw.githubusercontent.com/Igorkowalski94/eslint-plugin-project-structure/main/images/Sun.png" width="30" height="30" /> </picture> <picture><img src="https://raw.githubusercontent.com/Igorkowalski94/eslint-plugin-project-structure/main/images/Cloud.png" alt="Cloud" width="19" height="19" /></picture> </p> <h1 align="center"><picture><img src="https://raw.githubusercontent.com/Igorkowalski94/eslint-plugin-project-structure/main/images/File%20Folder.png" alt="Folder" width="60" height="60" /></picture><picture><img src="https://raw.githubusercontent.com/Igorkowalski94/eslint-plugin-project-structure/main/images/Owl.png" alt="Owl" width="60" height="60" /></picture><br>eslint‑plugin-project‑structure</h1> <p align="center">Powerful ESLint plugin with rules to help you achieve a scalable, consistent, and well-structured project.</p> <p align="center">Create your own framework! Define your folder structure, file composition, advanced naming conventions, and create independent modules.</p> <p align="center">Take your project to the next level and save time by automating the review of key principles of a healthy project!</p> <div align="center"> [![npm](https://img.shields.io/npm/v/eslint-plugin-project-structure.svg?&logo=nodedotjs&color=%231f6feb&labelColor=%23212830)](https://www.npmjs.com/package/eslint-plugin-project-structure#root)[![npm downloads](https://img.shields.io/npm/dy/eslint-plugin-project-structure.svg?&logo=nodedotjs&label=Downloads&color=%238957e5&labelColor=%23212830)](https://www.npmjs.com/package/eslint-plugin-project-structure#root)[![Check, test, build](https://img.shields.io/github/actions/workflow/status/Igorkowalski94/eslint-plugin-project-structure/check.yml?&logo=github&color=%23238636&label=Check%2C%20test%2C%20build&labelColor=%23212830)](https://github.com/Igorkowalski94/eslint-plugin-project-structure/actions/workflows/check.yml)[![Sponsor](https://img.shields.io/badge/Sponsor-grey?logo=githubsponsors&style=flat&color=%23212830)](https://github.com/sponsors/Igorkowalski94)[![GitHub Repo stars](https://img.shields.io/github/stars/igorkowalski94/eslint-plugin-project-structure?label=Star)](https://github.com/Igorkowalski94/eslint-plugin-project-structure) </div> <h2 align="center"><a href="https://github.com/Igorkowalski94/eslint-plugin-project-structure/wiki/project%E2%80%91structure-%E2%80%8Bfolder%E2%80%91structure#root">project‑structure/folder‑structure</a></h2> <p align="center">Enforce rules on folder structure to keep your project consistent, orderly and well thought out.</p> <h4><picture><img src="https://raw.githubusercontent.com/Igorkowalski94/eslint-plugin-project-structure/main/images/Rocket.png" alt="Rocket" width="35" height="35" /></picture> Features:</h4> - Validation of folder structure. Any files/folders outside the structure will be considered an error. - File/Folder name regex validation with features like wildcard `*` and treating `.` as a character, along with other conveniences. - Build in case validation. - Inheriting the folder's name. The file/folder inherits the name of the folder in which it is located. Option of adding your own prefixes/suffixes or changing the case. - Enforcing the existence of a files/folders 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. - Reusable rules for folder structures. - An option to create a separate configuration file with TypeScript support. - Forcing a nested/flat structure for a given folder. - Support for all file extensions. - Folder recursion. You can repeatedly nest a folder structure and set a limit on the nesting depth. There is also an option to change the rule at the final level, such as flattening the folder structure. - Fewer repetitions and precise error messages, even for deeply nested folders (recursion), by representing the folder structure as a tree. - Checking the length of paths and notifying when the limit is exceeded. <h2 align="center"><a href="https://github.com/Igorkowalski94/eslint-plugin-project-structure/wiki/project%E2%80%91structure-%E2%80%8Bindependent%E2%80%91modules#root">project‑structure/independent‑modules</a></h2> <p align="center">A key principle of a healthy project is to prevent the creation of a massive dependency tree, where removing or editing one feature triggers a chain reaction that impacts the entire project.</p> <p align="center">Create independent modules to keep your project scalable and easy to maintain. Get rid of dependencies between modules and create truly independent functionalities.</p> <h4><picture><img src="https://raw.githubusercontent.com/Igorkowalski94/eslint-plugin-project-structure/main/images/Rocket.png" alt="Rocket" width="35" height="35" /></picture> Features:</h4> - Creating independent modules in which you control what can be imported (e.g. types, functions, components of one functionality cannot be imported into another functionality). - The ability to create very detailed rules, even for nested folder structures. Whether it's a large module, a sub-module, or a single file, there are no limitations. - Support for all types of imports, including `require()`, `import()`, `jest.mock()`, and `jest.requireActual()`, as well as `ExportAllDeclaration` and `ExportNamedDeclaration`. - Disabling external imports (node_modules) for a given module (Option to add exceptions). - Non-relative/relative imports support. - Support for imports without extension. - Reusable import patterns. - Support for path aliases. The plugin will automatically detect your tsconfig.json and use your settings. There is also an option to enter them manually. - An option to create a separate configuration file with TypeScript support. <h2 align="center"><a href="https://github.com/Igorkowalski94/eslint-plugin-project-structure/wiki/project%E2%80%91structure-%E2%80%8Bfile%E2%80%91composition#root">project‑structure/file‑composition</a></h2> <p align="center">Compose your ideal files!</p> <p align="center">Have full control over the order and quantity of selectors.</p> <p align="center">Define advanced naming conventions and prohibit the use of specific selectors in given files.</p> <h4><picture><img src="https://raw.githubusercontent.com/Igorkowalski94/eslint-plugin-project-structure/main/images/Rocket.png" alt="Rocket" width="35" height="35" /></picture> Features:</h4> - File composition validation. - Supported selectors: `class`, `function`, `arrowFunction`, `type`, `interface`, `enum`, `variable`, `variableExpression`. - Inheriting the filename as the selector name. Option to add your own prefixes/suffixes, change the case, or remove parts of the filename. - Prohibit the use of given selectors in a given file. For example, `**/*.consts.ts` files can only contain variables, `**/*.types.ts` files can only contain interfaces and types. - Define the order in which your selectors should appear in a given file. Support for `--fix` to automatically correct the order. - Rules for exported selectors, selectors in the root of the file and nested/all selectors in the file. They can be used together in combination. - Enforcing a maximum of one main function/class per file. - The ability to set a specific limit on the occurrence of certain selectors in the root of a given file. - Selector name regex validation. - Build in case validation. - Different rules for different files. - An option to create a separate configuration file with TypeScript support.

No labels

No milestone

No project

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

pankod/next-boilerplate#199

No description provided.

Rows
Columns

[SUGGESTION] Adding eslint-plugin-project-structure to the project for validating folder structure and more, to automatically ensure scalability and consistency. #199

eslint‑plugin-project‑structure

project‑structure/​folder‑structure

Features:

project‑structure/​independent‑modules

Features:

project‑structure/​file‑composition

Features:

project‑structure/folder‑structure

project‑structure/independent‑modules

project‑structure/file‑composition