dependency-cruiser 10.0.2 → 10.0.6

package/src/schema/cruise-result.schema.js

@@ -0,0 +1,595 @@
+/* generated - don't edit */
+
+module.exports = {
+  title: "dependency-cruiser output format",
+  $schema: "http://json-schema.org/draft-07/schema#",
+  $id: "https://dependency-cruiser.js.org/schema/cruise-result.schema.json",
+  type: "object",
+  required: ["summary", "modules"],
+  additionalProperties: false,
+  properties: {
+    modules: { $ref: "#/definitions/ModulesType" },
+    summary: { $ref: "#/definitions/SummaryType" },
+  },
+  definitions: {
+    ModulesType: { type: "array", items: { $ref: "#/definitions/ModuleType" } },
+    ModuleType: {
+      type: "object",
+      required: ["source", "dependencies", "valid"],
+      additionalProperties: false,
+      properties: {
+        source: { type: "string" },
+        valid: { type: "boolean" },
+        dependencies: { $ref: "#/definitions/DependenciesType" },
+        dependents: { type: "array", items: { type: "string" } },
+        followable: { type: "boolean" },
+        matchesDoNotFollow: { type: "boolean" },
+        matchesFocus: { type: "boolean" },
+        coreModule: { type: "boolean" },
+        couldNotResolve: { type: "boolean" },
+        dependencyTypes: {
+          type: "array",
+          items: { $ref: "#/definitions/DependencyTypeType" },
+        },
+        license: { type: "string" },
+        orphan: { type: "boolean" },
+        reachable: {
+          type: "array",
+          items: { $ref: "#/definitions/ReachableType" },
+        },
+        reaches: {
+          type: "array",
+          items: { $ref: "#/definitions/ReachesType" },
+        },
+        rules: {
+          type: "array",
+          items: { $ref: "#/definitions/RuleSummaryType" },
+        },
+        consolidated: { type: "boolean" },
+      },
+    },
+    ReachableType: {
+      type: "object",
+      required: ["value", "asDefinedInRule", "matchedFrom"],
+      additionalProperties: false,
+      properties: {
+        value: { type: "boolean" },
+        asDefinedInRule: { type: "string" },
+        matchedFrom: { type: "string" },
+      },
+    },
+    ReachesType: {
+      type: "object",
+      required: ["modules", "asDefinedInRule"],
+      additionalProperties: false,
+      properties: {
+        modules: {
+          type: "array",
+          items: {
+            type: "object",
+            required: ["source", "via"],
+            additionalProperties: false,
+            properties: {
+              source: { type: "string" },
+              via: { type: "array", items: { type: "string" } },
+            },
+          },
+        },
+        asDefinedInRule: { type: "string" },
+      },
+    },
+    DependenciesType: {
+      type: "array",
+      items: { $ref: "#/definitions/DependencyType" },
+    },
+    DependencyType: {
+      type: "object",
+      required: [
+        "circular",
+        "coreModule",
+        "couldNotResolve",
+        "dependencyTypes",
+        "exoticallyRequired",
+        "dynamic",
+        "followable",
+        "module",
+        "moduleSystem",
+        "resolved",
+        "valid",
+      ],
+      additionalProperties: false,
+      properties: {
+        module: { type: "string" },
+        protocol: { type: "string", enum: ["data:", "file:", "node:"] },
+        mimeType: { type: "string" },
+        resolved: { type: "string" },
+        coreModule: { type: "boolean" },
+        dependencyTypes: {
+          type: "array",
+          items: { $ref: "#/definitions/DependencyTypeType" },
+        },
+        license: { type: "string" },
+        followable: { type: "boolean" },
+        dynamic: { type: "boolean" },
+        exoticallyRequired: { type: "boolean" },
+        exoticRequire: { type: "string" },
+        matchesDoNotFollow: { type: "boolean" },
+        couldNotResolve: { type: "boolean" },
+        preCompilationOnly: { type: "boolean" },
+        circular: { type: "boolean" },
+        cycle: { type: "array", items: { type: "string" } },
+        moduleSystem: { $ref: "#/definitions/ModuleSystemType" },
+        valid: { type: "boolean" },
+        rules: {
+          type: "array",
+          items: { $ref: "#/definitions/RuleSummaryType" },
+        },
+      },
+    },
+    DependencyTypeType: {
+      type: "string",
+      enum: [
+        "aliased",
+        "core",
+        "deprecated",
+        "local",
+        "localmodule",
+        "npm",
+        "npm-bundled",
+        "npm-dev",
+        "npm-no-pkg",
+        "npm-optional",
+        "npm-peer",
+        "npm-unknown",
+        "undetermined",
+        "unknown",
+      ],
+    },
+    ModuleSystemType: { type: "string", enum: ["cjs", "es6", "amd", "tsd"] },
+    RuleSummaryType: {
+      type: "object",
+      required: ["name", "severity"],
+      additionalProperties: false,
+      properties: {
+        name: { type: "string" },
+        severity: { $ref: "#/definitions/SeverityType" },
+      },
+    },
+    SeverityType: { type: "string", enum: ["error", "warn", "info", "ignore"] },
+    SummaryType: {
+      type: "object",
+      required: [
+        "violations",
+        "error",
+        "warn",
+        "info",
+        "totalCruised",
+        "optionsUsed",
+      ],
+      additionalProperties: false,
+      properties: {
+        violations: { $ref: "#/definitions/ViolationsType" },
+        error: { type: "number" },
+        warn: { type: "number" },
+        info: { type: "number" },
+        totalCruised: { type: "number" },
+        totalDependenciesCruised: { type: "number" },
+        ruleSetUsed: { $ref: "#/definitions/RuleSetType" },
+        optionsUsed: { $ref: "#/definitions/OptionsUsedType" },
+      },
+    },
+    ViolationsType: {
+      type: "array",
+      items: { $ref: "#/definitions/ViolationType" },
+    },
+    ViolationType: {
+      type: "object",
+      required: ["from", "to", "rule"],
+      additionalProperties: false,
+      properties: {
+        from: { type: "string" },
+        to: { type: "string" },
+        rule: { $ref: "#/definitions/RuleSummaryType" },
+        cycle: { type: "array", items: { type: "string" } },
+        via: { type: "array", items: { type: "string" } },
+      },
+    },
+    RuleSetType: {
+      type: "object",
+      additionalProperties: false,
+      properties: {
+        forbidden: {
+          type: "array",
+          items: { $ref: "#/definitions/ForbiddenRuleType" },
+        },
+        allowed: {
+          type: "array",
+          items: { $ref: "#/definitions/AllowedRuleType" },
+        },
+        allowedSeverity: { $ref: "#/definitions/SeverityType" },
+        required: {
+          type: "array",
+          items: { $ref: "#/definitions/RequiredRuleType" },
+        },
+      },
+    },
+    AllowedRuleType: {
+      oneOf: [
+        { $ref: "#/definitions/RegularAllowedRuleType" },
+        { $ref: "#/definitions/ReachabilityAllowedRuleType" },
+      ],
+    },
+    RegularAllowedRuleType: {
+      type: "object",
+      required: ["from", "to"],
+      additionalProperties: false,
+      properties: {
+        comment: { type: "string" },
+        from: { $ref: "#/definitions/FromRestrictionType" },
+        to: { $ref: "#/definitions/ToRestrictionType" },
+      },
+    },
+    ReachabilityAllowedRuleType: {
+      type: "object",
+      required: ["from", "to"],
+      additionalProperties: false,
+      properties: {
+        comment: { type: "string" },
+        from: { $ref: "#/definitions/ReachabilityFromRestrictionType" },
+        to: { $ref: "#/definitions/ReachabilityToRestrictionType" },
+      },
+    },
+    ForbiddenRuleType: {
+      oneOf: [
+        { $ref: "#/definitions/RegularForbiddenRuleType" },
+        { $ref: "#/definitions/ReachabilityForbiddenRuleType" },
+        { $ref: "#/definitions/DependentsForbiddenRuleType" },
+      ],
+    },
+    RegularForbiddenRuleType: {
+      type: "object",
+      required: ["from", "to"],
+      additionalProperties: false,
+      properties: {
+        name: { type: "string" },
+        severity: { $ref: "#/definitions/SeverityType" },
+        comment: { type: "string" },
+        from: { $ref: "#/definitions/FromRestrictionType" },
+        to: { $ref: "#/definitions/ToRestrictionType" },
+      },
+    },
+    DependentsForbiddenRuleType: {
+      type: "object",
+      required: ["module", "from"],
+      additionalProperties: false,
+      properties: {
+        name: { type: "string" },
+        severity: { $ref: "#/definitions/SeverityType" },
+        comment: { type: "string" },
+        module: { $ref: "#/definitions/DependentsModuleRestrictionType" },
+        from: { $ref: "#/definitions/DependentsFromRestrictionType" },
+      },
+    },
+    ReachabilityForbiddenRuleType: {
+      type: "object",
+      required: ["from", "to"],
+      additionalProperties: false,
+      properties: {
+        name: { type: "string" },
+        severity: { $ref: "#/definitions/SeverityType" },
+        comment: { type: "string" },
+        from: { $ref: "#/definitions/ReachabilityFromRestrictionType" },
+        to: { $ref: "#/definitions/ReachabilityToRestrictionType" },
+      },
+    },
+    RequiredRuleType: {
+      type: "object",
+      required: ["module", "to"],
+      additionalProperties: false,
+      properties: {
+        name: { type: "string" },
+        severity: { $ref: "#/definitions/SeverityType" },
+        comment: { type: "string" },
+        module: { $ref: "#/definitions/RequiredModuleRestrictionType" },
+        to: { $ref: "#/definitions/RequiredToRestrictionType" },
+      },
+    },
+    FromRestrictionType: {
+      type: "object",
+      additionalProperties: false,
+      properties: {
+        path: { $ref: "#/definitions/REAsStringsType" },
+        pathNot: { $ref: "#/definitions/REAsStringsType" },
+        orphan: { type: "boolean" },
+      },
+    },
+    ReachabilityFromRestrictionType: {
+      type: "object",
+      additionalProperties: false,
+      properties: {
+        path: { $ref: "#/definitions/REAsStringsType" },
+        pathNot: { $ref: "#/definitions/REAsStringsType" },
+      },
+    },
+    ToRestrictionType: {
+      type: "object",
+      additionalProperties: false,
+      properties: {
+        path: { $ref: "#/definitions/REAsStringsType" },
+        pathNot: { $ref: "#/definitions/REAsStringsType" },
+        couldNotResolve: { type: "boolean" },
+        circular: { type: "boolean" },
+        dynamic: { type: "boolean" },
+        exoticallyRequired: { type: "boolean" },
+        exoticRequire: { $ref: "#/definitions/REAsStringsType" },
+        exoticRequireNot: { $ref: "#/definitions/REAsStringsType" },
+        preCompilationOnly: { type: "boolean" },
+        dependencyTypes: {
+          type: "array",
+          items: { $ref: "#/definitions/DependencyTypeType" },
+        },
+        moreThanOneDependencyType: { type: "boolean" },
+        license: { $ref: "#/definitions/REAsStringsType" },
+        licenseNot: { $ref: "#/definitions/REAsStringsType" },
+      },
+    },
+    DependentsModuleRestrictionType: {
+      required: [],
+      type: "object",
+      additionalProperties: false,
+      properties: {
+        path: { $ref: "#/definitions/REAsStringsType" },
+        pathNot: { $ref: "#/definitions/REAsStringsType" },
+        numberOfDependentsLessThan: {
+          type: "integer",
+          minimum: 0,
+          maximum: 100,
+        },
+        numberOfDependentsMoreThan: {
+          type: "integer",
+          minimum: 0,
+          maximum: 100,
+        },
+      },
+    },
+    DependentsFromRestrictionType: {
+      required: [],
+      type: "object",
+      additionalProperties: false,
+      properties: {
+        path: { $ref: "#/definitions/REAsStringsType" },
+        pathNot: { $ref: "#/definitions/REAsStringsType" },
+      },
+    },
+    ReachabilityToRestrictionType: {
+      required: ["reachable"],
+      type: "object",
+      additionalProperties: false,
+      properties: {
+        path: { $ref: "#/definitions/REAsStringsType" },
+        pathNot: { $ref: "#/definitions/REAsStringsType" },
+        reachable: { type: "boolean" },
+      },
+    },
+    RequiredModuleRestrictionType: {
+      required: [],
+      type: "object",
+      additionalProperties: false,
+      properties: {
+        path: { $ref: "#/definitions/REAsStringsType" },
+        pathNot: { $ref: "#/definitions/REAsStringsType" },
+      },
+    },
+    RequiredToRestrictionType: {
+      required: [],
+      type: "object",
+      additionalProperties: false,
+      properties: { path: { $ref: "#/definitions/REAsStringsType" } },
+    },
+    REAsStringsType: {
+      oneOf: [{ type: "string" }, { type: "array", items: { type: "string" } }],
+    },
+    OptionsUsedType: {
+      type: "object",
+      additionalProperties: false,
+      properties: {
+        doNotFollow: { $ref: "#/definitions/CompoundDoNotFollowType" },
+        exclude: { $ref: "#/definitions/CompoundExcludeType" },
+        includeOnly: {
+          oneOf: [
+            { $ref: "#/definitions/REAsStringsType" },
+            { $ref: "#/definitions/CompoundIncludeOnlyType" },
+          ],
+        },
+        focus: { $ref: "#/definitions/CompoundFocusType" },
+        collapse: { type: "string" },
+        maxDepth: { type: "integer", minimum: 0, maximum: 99 },
+        moduleSystems: { $ref: "#/definitions/ModuleSystemsType" },
+        prefix: { type: "string" },
+        preserveSymlinks: { type: "boolean" },
+        combinedDependencies: { type: "boolean" },
+        tsConfig: {
+          type: "object",
+          additionalProperties: false,
+          properties: { fileName: { type: "string" } },
+        },
+        tsPreCompilationDeps: {
+          oneOf: [{ type: "boolean" }, { type: "string", enum: ["specify"] }],
+        },
+        externalModuleResolutionStrategy: {
+          type: "string",
+          enum: ["node_modules", "yarn-pnp"],
+        },
+        forceDeriveDependents: { type: "boolean" },
+        webpackConfig: {
+          type: "object",
+          additionalProperties: false,
+          properties: {
+            fileName: { type: "string" },
+            env: { oneOf: [{ type: "object" }, { type: "string" }] },
+            arguments: { type: "object" },
+          },
+        },
+        enhancedResolveOptions: {
+          type: "object",
+          additionalProperties: false,
+          properties: {
+            exportsFields: { type: "array", items: { type: "string" } },
+            conditionNames: { type: "array", items: { type: "string" } },
+            extensions: { type: "array", items: { type: "string" } },
+            cachedInputFileSystem: {
+              type: "object",
+              additionalProperties: false,
+              properties: {
+                cacheDuration: {
+                  type: "integer",
+                  minimum: 0,
+                  maximum: 1800000,
+                },
+              },
+            },
+          },
+        },
+        babelConfig: {
+          type: "object",
+          additionalProperties: false,
+          properties: { fileName: { type: "string" } },
+        },
+        parser: { type: "string", enum: ["acorn", "swc", "tsc"] },
+        exoticRequireStrings: { type: "array", items: { type: "string" } },
+        reporterOptions: { $ref: "#/definitions/ReporterOptionsType" },
+        progress: {
+          type: "object",
+          additionalProperties: false,
+          properties: {
+            type: {
+              type: "string",
+              enum: ["cli-feedback", "performance-log", "none"],
+            },
+          },
+        },
+        baseDir: { type: "string" },
+        args: { type: "string" },
+        rulesFile: { type: "string" },
+        outputTo: { type: "string" },
+        outputType: { $ref: "#/definitions/OutputType" },
+      },
+    },
+    ModuleSystemsType: {
+      type: "array",
+      items: { $ref: "#/definitions/ModuleSystemType" },
+    },
+    OutputType: {
+      oneOf: [
+        {
+          type: "string",
+          enum: [
+            "json",
+            "html",
+            "dot",
+            "ddot",
+            "cdot",
+            "archi",
+            "fdot",
+            "flat",
+            "csv",
+            "err",
+            "err-long",
+            "err-html",
+            "teamcity",
+            "anon",
+            "text",
+          ],
+        },
+        { type: "string", pattern: "^plugin:[^:]+$" },
+      ],
+    },
+    CompoundExcludeType: {
+      type: "object",
+      additionalProperties: false,
+      properties: {
+        path: { $ref: "#/definitions/REAsStringsType" },
+        dynamic: { type: "boolean" },
+      },
+    },
+    CompoundDoNotFollowType: {
+      type: "object",
+      additionalProperties: false,
+      properties: {
+        path: { $ref: "#/definitions/REAsStringsType" },
+        dependencyTypes: {
+          type: "array",
+          items: { $ref: "#/definitions/DependencyTypeType" },
+        },
+      },
+    },
+    CompoundIncludeOnlyType: {
+      type: "object",
+      additionalProperties: false,
+      properties: { path: { $ref: "#/definitions/REAsStringsType" } },
+    },
+    CompoundFocusType: {
+      type: "object",
+      additionalProperties: false,
+      properties: { path: { $ref: "#/definitions/REAsStringsType" } },
+    },
+    ReporterOptionsType: {
+      type: "object",
+      additionalProperties: false,
+      properties: {
+        anon: { $ref: "#/definitions/AnonReporterOptionsType" },
+        archi: { $ref: "#/definitions/DotReporterOptionsType" },
+        dot: { $ref: "#/definitions/DotReporterOptionsType" },
+        ddot: { $ref: "#/definitions/DotReporterOptionsType" },
+        flat: { $ref: "#/definitions/DotReporterOptionsType" },
+      },
+    },
+    AnonReporterOptionsType: {
+      type: "object",
+      additionalProperties: false,
+      properties: { wordlist: { type: "array", items: { type: "string" } } },
+    },
+    DotReporterOptionsType: {
+      type: "object",
+      additionalProperties: false,
+      properties: {
+        collapsePattern: { $ref: "#/definitions/REAsStringsType" },
+        filters: { $ref: "#/definitions/ReporterFiltersType" },
+        theme: { $ref: "#/definitions/DotThemeType" },
+      },
+    },
+    DotThemeType: {
+      type: "object",
+      additionalProperties: false,
+      properties: {
+        replace: { type: "boolean" },
+        graph: { type: "object" },
+        node: { type: "object" },
+        edge: { type: "object" },
+        modules: { $ref: "#/definitions/DotThemeArrayType" },
+        dependencies: { $ref: "#/definitions/DotThemeArrayType" },
+      },
+    },
+    DotThemeArrayType: {
+      type: "array",
+      items: { $ref: "#/definitions/DotThemeEntryType" },
+    },
+    DotThemeEntryType: {
+      type: "object",
+      additionalProperties: false,
+      properties: {
+        criteria: { type: "object" },
+        attributes: { type: "object" },
+      },
+    },
+    ReporterFiltersType: {
+      type: "object",
+      additionalProperties: false,
+      properties: {
+        exclude: { $ref: "#/definitions/CompoundExcludeType" },
+        includeOnly: { $ref: "#/definitions/CompoundIncludeOnlyType" },
+        focus: { $ref: "#/definitions/CompoundFocusType" },
+      },
+    },
+  },
+};

package/src/cli/defaults.json

@@ -1,15 +0,0 @@
-{
-  "OLD_DEFAULT_RULES_FILE_NAME": ".dependency-cruiser.json",
-  "RULES_FILE_NAME_SEARCH_ARRAY": [
-    ".dependency-cruiser.json",
-    ".dependency-cruiser.js",
-    ".dependency-cruiser.cjs"
-  ],
-  "DEFAULT_CONFIG_FILE_NAME": ".dependency-cruiser.js",
-  "WEBPACK_CONFIG": "webpack.config.js",
-  "TYPESCRIPT_CONFIG": "tsconfig.json",
-  "BABEL_CONFIG": ".babelrc",
-  "PACKAGE_MANIFEST": "package.json",
-  "OUTPUT_TYPE": "err",
-  "OUTPUT_TO": "-"
-}

package/src/main/options/defaults.json

@@ -1,10 +0,0 @@
-{
-  "validate": false,
-  "maxDepth": 0,
-  "moduleSystems": ["amd", "cjs", "es6", "tsd"],
-  "tsPreCompilationDeps": false,
-  "preserveSymlinks": false,
-  "combinedDependencies": false,
-  "externalModuleResolutionStrategy": "node_modules",
-  "exoticRequireStrings": []
-}