.dependency-cruiser.js

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

  forbidden: [
    // Note: this rule is intended to override the rule by the same name in the
    // `dependency-cruiser/configs/recommended` set. It removes `punycode` from
    // the path given this repo uses the third party `punycode` package, not
    // Node.js' deprecated built-in with the same name.
    {
      name: 'no-deprecated-core',
      comment:
        'This module depends on a node core module that has been deprecated. Find an ' +
        "alternative - these are bound to exist - node doesn't deprecate lightly.",
      severity: 'error',
      from: {},
      to: {
        dependencyTypes: ['core'],
        path: '^(domain|constants|sys|_linklist|_stream_wrap)$',
      },
    },
    // Overriding from recommended set
    {
      name: 'not-to-unresolvable',
      comment:
        "This module depends on a module that cannot be found ('resolved to disk'). " +
        "If it's an npm module: add it to your package.json. In all other cases you " +
        'likely already know what to do.',
      severity: 'error',
      from: {},
      to: {
        // Depcruiser fails on some legitimate type imports, so allowing them there
        dependencyTypesNot: ['type-only'],
        couldNotResolve: true,
      },
    },
    {
      name: 'no-orphans',
      severity: 'error',
      from: { orphan: true, pathNot: ['^src/shared/models/global-types.ts'] },
      to: {},
    },
    {
      name: 'script-context-not-to-another',
      comment: 'One script context must not depend on another',
      severity: 'error',
      from: { path: '(^src/)([^/]+)/' },
      to: {
        path: '^$1',
        pathNot: ['$1$2', '^src/shared'],
        dependencyTypesNot: ['type-only'],
      },
    },
    {
      name: 'ban-jotai-outside-store',
      severity: 'error',
      from: { path: '^src', pathNot: ['^src/app/store/*'] },
      to: { path: 'jotai*' },
    },
    {
      name: 'ban-non-type-imports-from-webextension-polyfill',
      severity: 'error',
      from: { path: '^src' },
      to: { path: 'webextension-polyfill', dependencyTypesNot: ['type-only'] },
    },
    {
      name: 'component-cannot-import-pages-or-features',
      severity: 'error',
      from: { path: 'src/app/components*' },
      to: { path: ['^src/app/pages*', '^src/app/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',
      comment: 'Pages are higher level abstractions than features and are typically non-reusable',
      severity: 'error',
      from: { path: '^src/app/features/.*' },
      to: { path: '^src/app/pages/.*' },
    },
    // TODO: Replace in future with new icon library
    // {
    //   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/shared/logger*'] },
      to: { path: 'pino' },
    },
    {
      name: 'no-inter-pages-deps',
      comment: 'Prohibit dependencies between pages',
      severity: 'error',
      from: { path: '^src/app/pages/([^/]+)/.+' },
      to: {
        path: '^src/app/pages/([^/]+)/.+',
        pathNot: '^src/app/pages/$1/.+',
      },
    },
    {
      name: 'no-feature-component-external-use',
      comment: `Only a given feature may import its child 'src/feature/xxx/components'`,
      severity: 'error',
      from: { path: '(^src/app/features/)([^/]+)' },
      to: {
        path: '^src/app/features/[^/]+/components',
        pathNot: '$1$2/',
      },
    },
    {
      name: 'no-feature-component-sibling-use',
      comment: `Features cannot depend on a sibling feature's components`,
      severity: 'error',
      from: { pathNot: ['^src/app/features'] },
      to: { path: '^src/app/features/([^/]+)/components' },
    },
    {
      name: 'no-logger-inpage-use',
      comment: `Inpage cannot use logger, which uses unavailable APIs`,
      severity: 'error',
      from: { path: '^src/inpage' },
      to: { path: '^src/shared/logger' },
    },
  ],
  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?))/[^/]+',
      },
    },
  },
};