Eslint Plugin Project Structure

Theme by Igorkowalski94

|

Updated: 11 Apr 2025

|

424 Stars

ESLint plugin with rules to help you achieve a scalable, consistent, and well-structured project. Define your folder structure, file composition, advanced naming conventions, and create independent modules. react folder structure react project structure react file structure react folder structure...

Categories

Overview:

The eslint-plugin-project-structure is a powerful tool that offers validation of folder structures and file compositions in projects. It provides a range of features to ensure consistency and organization in the project setup. From enforcing folder naming rules to controlling imports, this plugin aims to streamline project structures and enhance development workflows.

Features:

• Folder Structure Validation: Validate folder structure and contents.
• File/Folder Name Regex Validation: Use wildcard and special characters in naming conventions.
• Enforcement of File/Folder Existence: Ensure certain files/folders exist based on the presence of others.
• Support for Nested Structures: Control nesting depth and alter rules at different levels.
• Detailed Rules Customization: Tailor rules for modules, sub-modules, and individual files.
• Comprehensive Import Support: Cover various import methods and enforce import patterns.
• Path Aliases and Resolver: Automatically detect tsconfig.json settings for path aliases.

Installation:

To install the eslint-plugin-project-structure, you can use npm. Run the following command in your project directory:

npm install eslint-plugin-project-structure --save-dev

After installation, configure the plugin in your ESLint configuration file to start utilizing its features.

Summary:

The eslint-plugin-project-structure offers a robust solution for maintaining organized and consistent project structures. With features like folder validation, file composition checks, and import management, developers can ensure adherence to best practices and streamline their development processes. By providing detailed customization options and seamless integration with project configurations, this plugin enhances the overall project setup and maintenance experience.