README.md

 

eslint‑plugin‑project-structure‑playground

Playground for eslint-plugin-project-structure.

📚 Documentation

• project-structure/folder-structure
• project-structure/independent-modules
• project-structure/file-composition

🏁 Getting started

Step 1 (optional)

The project uses ESLint's new config system as default. If you want to test on the old eslint config, follow these steps:

• Remove package.json
• Remove eslint.config.mjs
• Remove independentModules.mjs
• Remove fileComposition.mjs
• Remove folderStructure.mjs
• Rename packageLegacyConfig.json to package.json

Step 2

npm install

npm run lint:watch

or

npm run lint

📋 General Information

Warning

Folder needs to contain at least one file/subfolder with file to be validated. ESLint and Git ignore empty folders, so they won’t be pushed to the repository and will only remain visible locally.

• All files in the features folder have all possible correct imports. You can try importing other files to see the errors.
• Examples of individual functionalities can be found in the examples folder.
• If you have any questions or need help creating a configuration that meets your requirements, click here.

📋 General project rules

• Variables in .const.ts files must follow {SNAKE_CASE}.
• .consts.ts files may only contain variables.
• Interfaces and types in .types.ts files must follow {PascalCase}.
• Enums in .types.ts files must follow {SNAKE_CASE}.
• .types.ts files may only contain interfaces, types and enums.
• All .ts files must contain only one main function. The main function should be named {fileName}. The main function can have an interface or type which must be named {FileName}Props or {FileName}Return.
• All .tsx files must contain only one main function. The main function should be named {FileName}. The main function can have an interface or type which must be named {FileName}Props or {FileName}Return.
• All nested functions and variables in .ts and .tsx files must follow {camelCase}.
• .types.ts files can only import from node_modules and nothing else.
• .consts.ts files can only import from .types.ts files located in the same directory.
• .api.ts files can only import from .consts.ts and .types.ts files located in the same directory.

📁 Folder structure and independent module rules

.
├── ...
├── 📄 fileComposition.mjs
├── 📄 folderStructure.mjs
├── 📄 independentModules.mjs
├── 📄 eslint.config.mjs
└── 📂 src
    ├── 📂 examples // Private
    ├── 📂 hooks
    │   ├── ...
    │   ├── 📄 useSimpleGlobalHook.test.ts       // Private.
    │   ├── 📄 useSimpleGlobalHook.ts            // Public.
    │   └── 📂 useComplexGlobalHook              // useComplexGlobalHook family.
    │       ├── 📁 hooks (recursion)             // Private / Public for useComplexGlobalHook family.
    │       ├── 📄 useComplexGlobalHook.api.ts    // Private / Public for useComplexGlobalHook family.
    │       ├── 📄 useComplexGlobalHook.types.ts  // Private / Public for useComplexGlobalHook family.
    │       ├── 📄 useComplexGlobalHook.consts.ts // Private / Public for useComplexGlobalHook family.
    │       ├── 📄 useComplexGlobalHook.test.ts   // Private.
    │       └── 📄 useComplexGlobalHook.ts        // Public.
    └── 📂 features
        ├── ...
        ├── 📄 Feature3.test.tsx            // Private.
        ├── 📄 Feature3.tsx                 // Public.
        ├── 📂 Feature2                     // Feature2 family. Same structure as Feature1.
        └── 📂 Feature1                     // Feature1 family.
            ├── 📄 feature1.api.ts          // Private / Public for Feature1 family.
            ├── 📄 feature1.types.ts        // Private / Public for Feature1 family.
            ├── 📄 feature1.consts.ts       // Private / Public for Feature1 family.
            ├── 📄 Feature1.test.tsx        // Private.
            ├── 📄 Feature1.tsx             // Public.
            ├── 📂 components
            │   ├── ...
            │   ├── 📄 SimpleComponent.test.tsx       // Private.
            │   ├── 📄 SimpleComponent.tsx            // Private / Public for Feature1 family / Public for ComplexComponent family.
            │   └── 📂 ComplexComponent               // ComplexComponent family.
            │       ├── 📁 components (recursion)     // Private / Public for ComplexComponent family.
            │       ├── 📁 hooks (recursion)          // Private / Public for ComplexComponent family.
            │       ├── 📄 complexComponent.api.ts     // Private / Public for ComplexComponent family.
            │       ├── 📄 complexComponent.types.ts   // Private / Public for ComplexComponent family.
            │       ├── 📄 complexComponent.consts.ts  // Private / Public for ComplexComponent family.
            │       ├── 📄 ComplexComponent.test.tsx   // Private.
            │       └── 📄 ComplexComponent.tsx        // Private / Public for ComplexComponent family / Public for Feature1 family / Public for SimpleComponent.tsx.
            └── 📂 hooks
                ├── ...
                ├── 📄 useSimpleHook.test.ts           // Private.
                ├── 📄 useSimpleHook.ts                // Private / Public for Feature1 family / Public for useComplexHook family.
                └── 📂 useComplexHook                 // useComplexHook family.
                    ├── 📁 hooks (recursion)          // Private / Public for useComplexHook family.
                    ├── 📄 useComplexHook.api.ts      // Private / Public for useComplexHook family.
                    ├── 📄 useComplexHook.types.ts    // Private / Public for useComplexHook family.
                    ├── 📄 useComplexHook.consts.ts   // Private / Public for useComplexHook family.
                    ├── 📄 useComplexHook.test.ts     // Private.
                    └── 📄 useComplexHook.ts          // Private / Public for useComplexHook family / Public for Feature1 family / Public for useSimpleHook.tsx.

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!