Add strict rules to allowImportsFrom

[chertik77]

I have an entities folder and I structure it like this:

entities/
├── auth/
│   ├── @x/
│   │   ├── user.ts
│   │   
│
├── user/
│   ├── index.ts
│   ├── api/
│   │   ├── service.ts
│   ├── model/
│   │   ├── types.ts

if i want to access auth entity from user service, i need to go @x folder only, and if there is a board.ts for example, i also want to throw an error, because it should access only user file there. if i import it from user/index.ts, i can still access everything in auth entity, i want to fix it, here is my current configuration:

 "allowImportsFrom": [
        "{family}/**/@x/**",
        "{dirname_2}/**",
        "src/shared/**"
      ],

dirname_2 indicates that i can import user types from user service, for example. I'm just wondering what rules should I apply to consider all possibilities

[Igorkowalski94]

Hi @chertik77,

There are two possible configurations, if I understood your requirements correctly:

Configuration1 dynamic rules:

// @ts-check

import { createIndependentModules } from "eslint-plugin-project-structure";

export const independentModulesConfig = createIndependentModules({
  modules: [
    {
      name: "Entity folder",
      pattern: "src/entities/**",
      allowImportsFrom: [
        // {family} === "src/entities"
        // {family_3} === "src/entities/user"
        "{family_3}/**", 

        "src/shared/**",

        // All files from the @x folder will be accessible, there’s no other way if you want the rule to be dynamic.
        "src/entities/auth/@x/*",
      ],
    },
  ],
});

Configuration2 fixed rules:

/**
 * @param {string} folderName
 */
const createEntityRule = (folderName) => ({
  name: `${folderName} folder`,
  pattern: `src/entities/${folderName}/**`,
  allowImportsFrom: [
    "{family_3}/**",
    "src/shared/**",
    `src/entities/auth/@x/${folderName}.ts`,
  ],
});

export const independentModulesConfig = createIndependentModules({
  modules: [
    createEntityRule("user"),
    createEntityRule("someOtherEntity"),
    {
      name: "Unknown entity",
      pattern: "src/entities/**",
      allowImportsFrom: [],
      allowExternalImports: false,
      errorMessage:
        "🔥 This entity is not specified as an independent module in `independentModules.mjs`. Use createEntityRule function. 🔥",
    },
  ],
});

[Igorkowalski94]

If you want fully dynamic rules I would consider keeping the auth files of a given entity in its folder rather than in the auth folder, e.g., src/entities/user/auth.ts. Thanks to this, if a given entity needs to be removed, you only delete one folder without having to dig through other folders to find its dependencies.

This way, you can also restrict src/entities/auth to only import src/entities/*/auth.ts from other entities.

// @ts-check

import { createIndependentModules } from "eslint-plugin-project-structure";

export const independentModulesConfig = createIndependentModules({
  modules: [
    {
      name: "Auth entity folder",
      pattern: "src/entities/auth/**",
      allowImportsFrom: [
        // {family} === "src/entities"
        // {family_3} === "src/entities/auth"
        "{family_3}/**",

        // Auth entity can import only auth.ts file from other entities.
        "src/entities/*/auth.ts",

        "src/shared/**",
      ],
    },

    {
      name: "Entity folder",
      pattern: "src/entities/**",
      allowImportsFrom: [
        // {family} === "src/entities"
        // {family_3} === "src/entities/user"
        "{family_3}/**",

        "src/shared/**",
      ],
    },
  ],
});

[Igorkowalski94]

Yes, you can write exactly the same configuration but without createIndependentModules in JSON file.

In JSON, you also won't use the additional function createEntityRule, so you need to copy and paste the given rules.

This way, you can ignore specific files, for example.

[["**", "!src/entiries/auth/@x/user.ts"]] All files without src/entitires/auth/@x/user.ts file

[Igorkowalski94]

@chertik77 This configuration for JSONC will allow you to import files from another entity into the given entity, but only from its @x folder.

{
  "$schema": "node_modules/eslint-plugin-project-structure/independentModules.schema.json",
  "modules": [
    {
      "name": "Entity folder",
      "pattern": "src/entities/**",
      "allowImportsFrom": [
        "{family_3}/**",
        "src/shared/**",
        "src/entities/**/@x/**" // The entity can only import files from the @x folder of another entity.
      ]
    }
  ]
}

[Igorkowalski94]

For fixed rules:

{
  "$schema": "node_modules/eslint-plugin-project-structure/independentModules.schema.json",
  "modules": [
    {
      "name": "User entity folder",
      "pattern": "src/entities/user/**",
      "allowImportsFrom": [
        "{entitySharedImports}",
        "src/entities/**/@x/user.ts"
      ]
    },

    {
      "name": "X entity folder",
      "pattern": "src/entities/x/**",
      "allowImportsFrom": ["{entitySharedImports}", "src/entities/**/@x/x.ts"]
    },

    {
      "name": "Y entity folder",
      "pattern": "src/entities/y/**",
      "allowImportsFrom": ["{entitySharedImports}", "src/entities/**/@x/y.ts"]
    },

    {
      "name": "Unknown entity",
      "pattern": "src/entities/**",
      "allowImportsFrom": [],
      "allowExternalImports": false,
      "errorMessage": "🔥 This entity is not specified as an independent module in `independentModules.mjs`. 🔥"
    }
  ],
  "reusableImportPatterns": {
    "entitySharedImports": ["{family_3}/**", "src/shared/**"]
  }
}

[chertik77]

I bumped to eslint 9 to be able to createEntities and dynamic rules, thank you so much for your help!

I've created something like this:

/**
 * @param {string} folderName
 */
const createEntityRule = folderName => ({
  name: `${folderName} folder`,
  pattern: `src/entities/${folderName}/**`,
  allowImportsFrom: [
    '{family_3}/**',
    'src/shared/**',
    `src/entities/**/@x/${folderName}.ts`
  ]
})

    createEntityRule('auth'),
    createEntityRule('user'),
    createEntityRule('board'),
    createEntityRule('column'),
    createEntityRule('card'),
    createEntityRule('dnd'),

it work great, but requires to add another entity everytime

[Igorkowalski94]

remember to include,

 {
      name: "Unknown entity",
      pattern: "src/entities/**",
      allowImportsFrom: [],
      allowExternalImports: false,
      errorMessage:
        "🔥 This entity is not specified as an independent module in `independentModules.mjs`. Use createEntityRule function. 🔥",
    },

Thanks to this, whenever you create a new entity, it will immediately remind you to add it to the configuration as well.