eslint‑plugin-project‑structure

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

Create your own framework! Define your folder structure, advanced naming conventions, file composition, 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!

📋 General information

🎮Playground for eslint-plugin-project-structure rules.

Become part of the community!
Leave a ⭐ and share the link with your friends.

• If you have any questions or need help creating a configuration that meets your requirements, click here.
• If you have found a bug or an error in the documentation, click here.
• If you have an idea for a new feature or an improvement to an existing one, click here.
• If you're interested in discussing project structures across different frameworks or want to vote on a proposed new feature, click here.

📚 Documentation

• Migration guide to 2.3.0
• project-structure/folder-structure
• project-structure/independent-modules
• project-structure/naming-rules

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 nest a given folder structure recursively.
• Fewer repetitions and precise error messages, even for deeply nested folders (recursion), by representing the folder structure as a tree.

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.
• 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/​naming‑rules

Enforce advanced naming rules and prohibit the use of given selectors in a given file.

Have full control over what your file can contain and the naming conventions it must follow.

Features:

• Naming validation.
• Supported selectors: class, variable, function, arrowFunction, type, interface, enum.
• Naming 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.
• 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 enums, interfaces and types.
• Inheriting the filename as the selector name. Option to add your own prefixes/suffixes, change the case, or remove parts of the filename.
• Enforcing a maximum of one main function/class per file.
• Different name rules for different files.
• Regex validation.
• Build in case validation.
• An option to create a separate configuration file with TypeScript support.

Sponsors

A big thank you to all the sponsors for your support! You give me the strength and motivation to keep going!

Thanks to you, I can help others create their ideal projects!