Folders public api in independent modules

[chertik77]

Would be nice to have a a rule that folder should have a public api to access its files, for example:

I want to import shared component, so i go @/shared/components/SomeComponent - it will throw an error

Otherwise, I should import it like so: @/shared/components

Maybe allowImportsFromPublicApi will work together with allowImportsFrom?

It would be easier to know what you should import and consider adding an index file as reexport

For instance, I want to throw an error here -
import { AddBoardModal } from '@/features/board/add-board/components/AddBoardModal',
and it should be fixed to import { AddBoardModal } from '@/features/board/add-board'

[Igorkowalski94]

You can achieve exactly the same effect by allowing the import of only the index.ts file, for example, like this:

And separately, you can add rules for index.ts files so that they can import more.

   {
      name: "Some module index file",
      pattern: "src/someModule/**/index.ts",
      allowImportsFrom: [
        "{family}/**", 
      ],
    },

   {
      name: "Some module",
      pattern: "src/someModule/**",
      allowImportsFrom: [
        "src/shared/*/index.ts", 
        "src/shared/**/index.ts",
        "{family}/*/someFolder/index.ts",
        "{family}/**/someFolder/index.ts",
        // ...  etc
      ],
    },

[Igorkowalski94]

Overall, you have quite a lot of possibilities if you write your configuration well, especially when combined with a folder structure rule.

[chertik77]

You can achieve exactly the same effect by allowing the import of only the index.ts file, for example, like this:

And separately, you can add rules for index.ts files so that they can import more.

   {
      name: "Some module index file",
      pattern: "src/someModule/**/index.ts",
      allowImportsFrom: [
        "{family}/**", 
      ],
    },

   {
      name: "Some module",
      pattern: "src/someModule/**",
      allowImportsFrom: [
        "src/shared/*/index.ts", 
        "src/shared/**/index.ts",
        "{family}/*/someFolder/index.ts",
        "{family}/**/someFolder/index.ts",
        // ...  etc
      ],
    },

That's good, but it doesn't require for folder to have a public api file. So it isn't strict enough

[Igorkowalski94]

I don't understand, it will require imports only from index.ts, so theoretically, you have to create index.ts to import anything at all. If you want to enforce the existence of a file when a folder exists, you can use enforceExistence.

[chertik77]

I don't understand, it will require imports only from index.ts, so theoretically, you have to create index.ts to import anything at all. If you want to enforce the existence of a file when a folder exists, you can use enforceExistence.

Thanks for your help. I really appreciate it. You helped me a lot to build a better rules how i should structure my folders