275 lines
11 KiB
JavaScript
275 lines
11 KiB
JavaScript
/** @type {import('dependency-cruiser').IConfiguration} */
|
|
export default {
|
|
forbidden: [
|
|
/* rules from the 'recommended' preset: */
|
|
{
|
|
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,
|
|
},
|
|
},
|
|
{
|
|
name: "no-orphans",
|
|
comment:
|
|
"This is an orphan module - it's likely not used (anymore?). Either use it or " +
|
|
"remove it. If it's logical this module is an orphan (i.e. it's a config file), " +
|
|
"add an exception for it in your dependency-cruiser configuration. By default " +
|
|
"this rule does not scrutinize dot-files (e.g. .eslintrc.js), TypeScript declaration " +
|
|
"files (.d.ts), tsconfig.json and some of the babel and webpack configs.",
|
|
severity: "warn",
|
|
from: {
|
|
orphan: true,
|
|
pathNot: [
|
|
"(^|/)\\.[^/]+\\.(js|jsx|cjs|mjs|ts|tsx|cts|ctsx|mts|mtsx|json)$", // dot files
|
|
"\\.d\\.ts$", // TypeScript declaration files
|
|
"(^|/)tsconfig\\.json$", // TypeScript config
|
|
"(^|/)(babel|webpack)\\.config\\.(js|jsx|cjs|mjs|ts|tsx|cts|ctsx|mts|mtsx|json)$", // other configs
|
|
],
|
|
},
|
|
to: {},
|
|
},
|
|
{
|
|
name: "no-deprecated-core",
|
|
comment:
|
|
"A 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: "warn",
|
|
from: {},
|
|
to: {
|
|
dependencyTypes: ["core"],
|
|
path: [
|
|
"^(v8/tools/codemap)$",
|
|
"^(v8/tools/consarray)$",
|
|
"^(v8/tools/csvparser)$",
|
|
"^(v8/tools/logreader)$",
|
|
"^(v8/tools/profile_view)$",
|
|
"^(v8/tools/profile)$",
|
|
"^(v8/tools/SourceMap)$",
|
|
"^(v8/tools/splaytree)$",
|
|
"^(v8/tools/tickprocessor-driver)$",
|
|
"^(v8/tools/tickprocessor)$",
|
|
"^(node-inspect/lib/_inspect)$",
|
|
"^(node-inspect/lib/internal/inspect_client)$",
|
|
"^(node-inspect/lib/internal/inspect_repl)$",
|
|
"^(async_hooks)$",
|
|
"^(punycode)$",
|
|
"^(domain)$",
|
|
"^(constants)$",
|
|
"^(sys)$",
|
|
"^(_linklist)$",
|
|
"^(_stream_wrap)$",
|
|
],
|
|
},
|
|
},
|
|
{
|
|
name: "not-to-deprecated",
|
|
comment:
|
|
"This module uses a (version of an) npm module that has been deprecated. Either upgrade to a later " +
|
|
"version of that module, or find an alternative. Deprecated modules are a security risk.",
|
|
severity: "warn",
|
|
from: {},
|
|
to: {
|
|
dependencyTypes: ["deprecated"],
|
|
},
|
|
},
|
|
{
|
|
name: "no-non-package-json",
|
|
severity: "error",
|
|
comment:
|
|
"This module depends on an npm package that isn't in the 'dependencies' section of your package.json. " +
|
|
"That's problematic as the package either (1) won't be available on live (2 - worse) will be " +
|
|
"available on live with an non-guaranteed version. Fix it by adding the package to the dependencies " +
|
|
"in your package.json.",
|
|
from: {},
|
|
to: {
|
|
dependencyTypes: ["npm-no-pkg", "npm-unknown"],
|
|
},
|
|
},
|
|
{
|
|
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: {
|
|
pathNot: "generated/graphql.ts",
|
|
},
|
|
to: {
|
|
pathNot: "@saleor/app-sdk/types",
|
|
couldNotResolve: true,
|
|
dependencyTypesNot: ["type-only"],
|
|
},
|
|
},
|
|
{
|
|
name: "no-duplicate-dep-types",
|
|
comment:
|
|
"Likely this module depends on an external ('npm') package that occurs more than once " +
|
|
"in your package.json i.e. bot as a devDependencies and in dependencies. This will cause " +
|
|
"maintenance problems later on.",
|
|
severity: "warn",
|
|
from: {},
|
|
to: {
|
|
moreThanOneDependencyType: true,
|
|
// as it's pretty common to have a type import be a type only import
|
|
// _and_ (e.g.) a devDependency - don't consider type-only dependency
|
|
// types for this rule
|
|
dependencyTypesNot: ["type-only"],
|
|
},
|
|
},
|
|
|
|
/* rules you might want to tweak for your specific situation: */
|
|
{
|
|
name: "not-to-spec",
|
|
comment:
|
|
"This module depends on a spec (test) file. The sole responsibility of a spec file is to test code. " +
|
|
"If there's something in a spec that's of use to other modules, it doesn't have that single " +
|
|
"responsibility anymore. Factor it out into (e.g.) a separate utility/ helper or a mock.",
|
|
severity: "error",
|
|
from: {
|
|
pathNot:
|
|
"(saleor-app\\.ts$)|(__tests__/\\.*)|(\\.(spec|test)\\.(js|jsx|mjs|cjs|ts|tsx|cts|ctsx|mts|mtsx\\.md)$)",
|
|
},
|
|
to: {
|
|
path: "(__tests__/\\.*)|(\\.(spec|test)\\.(js|jsx|mjs|cjs|ts|tsx|cts|ctsx|mts|mtsx\\.md)$)",
|
|
},
|
|
},
|
|
{
|
|
name: "not-to-dev-dep",
|
|
severity: "error",
|
|
comment:
|
|
"This module depends on an npm package from the 'devDependencies' section of your " +
|
|
"package.json. It looks like something that ships to production, though. To prevent problems " +
|
|
"with npm packages that aren't there on production declare it (only!) in the 'dependencies'" +
|
|
"section of your package.json. If this module is development only - add it to the " +
|
|
"from.pathNot re of the not-to-dev-dep rule in the dependency-cruiser configuration",
|
|
from: {
|
|
path: "^(src)",
|
|
pathNot:
|
|
"(src/schemas/compiler.mts)|(.*/__tests__/.*)|(setup-tests\\.ts$)|(\\.(spec|test)\\.(js|jsx|mjs|cjs|ts|tsx|cts|ctsx|mts|mtsx\\.md))$",
|
|
},
|
|
to: {
|
|
dependencyTypes: ["npm-dev"],
|
|
},
|
|
},
|
|
{
|
|
name: "optional-deps-used",
|
|
severity: "info",
|
|
comment:
|
|
"This module depends on an npm package that is declared as an optional dependency " +
|
|
"in your package.json. As this makes sense in limited situations only, it's flagged here. " +
|
|
"If you're using an optional dependency here by design - add an exception to your" +
|
|
"dependency-cruiser configuration.",
|
|
from: {},
|
|
to: {
|
|
dependencyTypes: ["npm-optional"],
|
|
},
|
|
},
|
|
{
|
|
name: "peer-deps-used",
|
|
comment:
|
|
"This module depends on an npm package that is declared as a peer dependency " +
|
|
"in your package.json. This makes sense if your package is e.g. a plugin, but in " +
|
|
"other cases - maybe not so much. If the use of a peer dependency is intentional " +
|
|
"add an exception to your dependency-cruiser configuration.",
|
|
severity: "warn",
|
|
from: {},
|
|
to: {
|
|
dependencyTypes: ["npm-peer"],
|
|
},
|
|
},
|
|
],
|
|
options: {
|
|
/* conditions specifying which files not to follow further when encountered:
|
|
- path: a regular expression to match
|
|
- dependencyTypes: see https://github.com/sverweij/dependency-cruiser/blob/master/doc/rules-reference.md#dependencytypes-and-dependencytypesnot
|
|
for a complete list
|
|
*/
|
|
doNotFollow: {
|
|
path: "node_modules",
|
|
},
|
|
|
|
/* false (the default): ignore dependencies that only exist before typescript-to-javascript compilation
|
|
true: also detect dependencies that only exist before typescript-to-javascript compilation
|
|
"specify": for each dependency identify whether it only exists before compilation or also after
|
|
*/
|
|
tsPreCompilationDeps: true,
|
|
|
|
/* TypeScript project file ('tsconfig.json') to use for
|
|
(1) compilation and
|
|
(2) resolution (e.g. with the paths property)
|
|
|
|
The (optional) fileName attribute specifies which file to take (relative to
|
|
dependency-cruiser's current working directory). When not provided
|
|
defaults to './tsconfig.json'.
|
|
*/
|
|
tsConfig: {
|
|
fileName: "tsconfig.json",
|
|
},
|
|
|
|
/* options to pass on to enhanced-resolve, the package dependency-cruiser
|
|
uses to resolve module references to disk. You can set most of these
|
|
options in a webpack.conf.js - this section is here for those
|
|
projects that don't have a separate webpack config file.
|
|
|
|
Note: settings in webpack.conf.js override the ones specified here.
|
|
*/
|
|
enhancedResolveOptions: {
|
|
/* List of strings to consider as 'exports' fields in package.json. Use
|
|
['exports'] when you use packages that use such a field and your environment
|
|
supports it (e.g. node ^12.19 || >=14.7 or recent versions of webpack).
|
|
|
|
If you have an `exportsFields` attribute in your webpack config, that one
|
|
will have precedence over the one specified here.
|
|
*/
|
|
exportsFields: ["exports"],
|
|
/* List of conditions to check for in the exports field. e.g. use ['imports']
|
|
if you're only interested in exposed es6 modules, ['require'] for commonjs,
|
|
or all conditions at once `(['import', 'require', 'node', 'default']`)
|
|
if anything goes for you. Only works when the 'exportsFields' array is
|
|
non-empty.
|
|
|
|
If you have a 'conditionNames' attribute in your webpack config, that one will
|
|
have precedence over the one specified here.
|
|
*/
|
|
conditionNames: ["import", "require", "node", "default"],
|
|
/*
|
|
If your TypeScript project makes use of types specified in 'types'
|
|
fields in package.jsons of external dependencies, specify "types"
|
|
in addition to "main" in here, so enhanced-resolve (the resolver
|
|
dependency-cruiser uses) knows to also look there. You can also do
|
|
this if you're not sure, but still use TypeScript. In a future version
|
|
of dependency-cruiser this will likely become the default.
|
|
*/
|
|
mainFields: ["module", "main", "types"],
|
|
},
|
|
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:
|
|
"^(packages|src|lib|app|bin|test(s?)|spec(s?))/[^/]+|node_modules/(@[^/]+/[^/]+|[^/]+)",
|
|
},
|
|
text: {
|
|
highlightFocused: true,
|
|
},
|
|
},
|
|
},
|
|
};
|
|
// generated: dependency-cruiser@12.11.0 on 2023-03-25T15:14:42.761Z
|