.dependency-cruiser.js

/** @type {import('dependency-cruiser').IConfiguration} */
module.exports = {
  extends: 'dependency-cruiser/configs/recommended',

  forbidden: [
    {
      name: 'no-orphans',
      severity: 'warn',
      from: { orphan: true },
      to: {},
    },
    {
      name: 'only-import-state-via-hooks',
      severity: 'error',
      from: { path: '^src/*', pathNot: ['^src/store/*'] },
      to: {
        path: ['^src/store/*'],
        pathNot: [`src.*\.hooks\.ts`, `src.*\.models\.ts`, `src.*\.utils\.ts`],
      },
    },
    {
      name: 'ban-jotai-outside-store',
      severity: 'error',
      from: { path: '^src/*', pathNot: ['^src/store/*'] },
      to: { path: 'jotai*' },
    },
    {
      name: 'component-cannot-import-pages-or-features',
      severity: 'error',
      from: { path: 'src/components*' },
      to: { path: ['^src/pages*', '^src/features/*'] },
    },
    {
      name: 'no-circular',
      severity: 'warn',
      comment:
        'This dependency is part of a circular relationship. You might want to revise ' +
        'your solution (i.e. use dependency inversion, make sure the modules have a single responsibility) ',
      from: {},
      to: { circular: true },
    },
    // @kyranjamie: imo components in `components/` should be dumb
    // so would be nice to enable this rule, though following state
    // refactor, this has been disabled to be more permissive
    // {
    //   name: 'components-must-not-import-store',
    //   severity: 'error',
    //   from: { path: '^src/components/.*' },
    //   to: { path: '^src/store/.*' },
    // },
    {
      name: 'features-cannot-import-pages',
      severity: 'error',
      from: { path: '^src/features/.*' },
      to: { path: '^src/pages/.*' },
    },
    {
      name: 'background-cannot-import-content-scripts',
      severity: 'error',
      from: { path: '^src/background/.*' },
      to: { path: '^src/content-scripts/.*' },
    },
    {
      name: 'content-cannot-import-background-script',
      severity: 'error',
      from: { path: '^src/content-scripts/.*' },
      to: { path: '^src/background/.*' },
    },
    {
      name: 'only-allow-react-icons-fi',
      comment: 'Ensure only icons from `fi` group are allowed',
      severity: 'error',
      from: { path: '^src' },
      to: { path: 'react-icons.*', pathNot: 'react-icons/fi' },
    },
    {
      name: 'no-using-pino-directly',
      comment: 'Enforce use of Pino logging library via @logger wrapper',
      severity: 'error',
      from: { path: '^src', pathNot: ['^src/common/logger.ts$'] },
      to: { path: 'pino' },
    },
    {
      name: 'no-inter-pages-deps',
      comment: 'Prohibit dependencies between pages',
      severity: 'error',
      from: { path: '^src/pages/([^/]+)/.+' },
      to: {
        path: '^src/pages/([^/]+)/.+',
        pathNot: '^src/pages/$1/.+',
      },
    },
  ],
  options: {
    doNotFollow: {
      path: 'node_modules',
      dependencyTypes: ['npm', 'npm-dev', 'npm-optional', 'npm-peer', 'npm-bundled', 'npm-no-pkg'],
    },
    webpackConfig: {
      fileName: './webpack/webpack.config.prod.js',
    },
    tsConfig: {
      fileName: 'tsconfig.json',
    },
    tsPreCompilationDeps: true,
    enhancedResolveOptions: {
      exportsFields: ['exports'],
      conditionNames: ['import', 'require', 'node', 'default'],
    },
    reporterOptions: {
      dot: {
        /* pattern of modules that can be consolidated in the detailed
           graphical dependency graph. The default pattern in this configuration
           collapses everything in node_modules to one folder deep so you see
           the external modules, but not the innards your app depends upon.
         */
        collapsePattern: 'node_modules/[^/]+',
      },
      archi: {
        /* pattern of modules that can be consolidated in the high level
          graphical dependency graph. If you use the high level graphical
          dependency graph reporter (`archi`) you probably want to tweak
          this collapsePattern to your situation.
        */
        collapsePattern: '^(node_modules|packages|src|lib|app|bin|test(s?)|spec(s?))/[^/]+',
      },
    },
  },
};