@voiceflow/dependency-cruiser-config 1.0.0 → 1.1.0

package/build/config.d.ts

@@ -1,3 +1,4 @@
 import { IConfiguration } from 'dependency-cruiser';
-declare const createConfig: () => IConfiguration;
+import { Options } from './types';
+declare const createConfig: ({ tsconfig, sourceDir, allowTypeCycles }?: Options) => IConfiguration;
 export default createConfig;

package/build/config.js

@@ -1,22 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const rules_1 = require("./rules");
-const createConfig = () => ({
+const createConfig = ({ tsconfig = 'tsconfig.json', sourceDir = 'src', allowTypeCycles = false } = {}) => ({
     forbidden: [
         /* rules from the 'recommended' preset: */
-        rules_1.noCircularRule(),
-        rules_1.noOrphansRule(),
-        rules_1.noDeprecatedCoreRule(),
-        rules_1.notToDeprecatedRule(),
-        rules_1.noNonPackageRule(),
-        rules_1.notToUnresolvableRule(),
-        rules_1.noDuplicateDepTypesRule(),
+        (0, rules_1.noCircularRule)(),
+        (0, rules_1.noOrphansRule)({ ignoreTypes: allowTypeCycles }),
+        (0, rules_1.noDeprecatedCoreRule)(),
+        (0, rules_1.notToDeprecatedRule)(),
+        (0, rules_1.noNonPackageRule)(),
+        (0, rules_1.notToUnresolvableRule)(),
+        (0, rules_1.noDuplicateDepTypesRule)(),
         /* rules you might want to tweak for your specific situation: */
-        rules_1.notToTestRule(),
-        rules_1.notToSpecRule(),
-        rules_1.notToDevDepRule(),
-        rules_1.warnOptionalDepsRule(),
-        rules_1.warnPeerDepsRule(),
+        (0, rules_1.notToTestRule)(),
+        (0, rules_1.notToSpecRule)(),
+        (0, rules_1.notToDevDepRule)(),
+        (0, rules_1.warnOptionalDepsRule)(),
+        (0, rules_1.warnPeerDepsRule)(),
     ],
     options: {
         /* conditions specifying which files not to follow further when encountered:
@@ -40,7 +40,7 @@ const createConfig = () => ({
         /* pattern specifying which files to include (regular expression)
            dependency-cruiser will skip everything not matching this pattern
         */
-        // includeOnly : '',
+        includeOnly: `^${sourceDir}/`,
         /* dependency-cruiser will include modules matching against the focus
            regular expression in its output, as well as their neighbours (direct
            dependencies and dependents)
@@ -57,7 +57,7 @@ const createConfig = () => ({
            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,
+        tsPreCompilationDeps: !allowTypeCycles,
         /* list of extensions (typically non-parseable) to scan. Empty by default. */
         // extraExtensionsToScan: [".json", ".jpg", ".png", ".svg", ".webp"],
         /* if true combines the package.jsons found from the module up to the base
@@ -76,7 +76,7 @@ const createConfig = () => ({
            defaults to './tsconfig.json'.
          */
         tsConfig: {
-            fileName: 'tsconfig.json',
+            fileName: tsconfig,
         },
         /* Webpack configuration to use to get resolve options from.
     

package/build/config.js.map

@@ -1 +1 @@
-{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":";;AAEA,mCAaiB;AAEjB,MAAM,YAAY,GAAG,GAAmB,EAAE,CAAC,CAAC;IAC1C,SAAS,EAAE;QACT,0CAA0C;QAC1C,sBAAc,EAAE;QAChB,qBAAa,EAAE;QACf,4BAAoB,EAAE;QACtB,2BAAmB,EAAE;QACrB,wBAAgB,EAAE;QAClB,6BAAqB,EAAE;QACvB,+BAAuB,EAAE;QAEzB,gEAAgE;QAChE,qBAAa,EAAE;QACf,qBAAa,EAAE;QACf,uBAAe,EAAE;QACjB,4BAAoB,EAAE;QACtB,wBAAgB,EAAE;KACnB;IACD,OAAO,EAAE;QACP;;;;UAIE;QACF,WAAW,EAAE;YACX,IAAI,EAAE,cAAc;YACpB,eAAe,EAAE,CAAC,KAAK,EAAE,SAAS,EAAE,cAAc,EAAE,UAAU,EAAE,aAAa,EAAE,YAAY,CAAC;SAC7F;QAED;;;;UAIE;QACF,cAAc;QACd,cAAc;QACd,kBAAkB;QAClB,KAAK;QAEL;;UAEE;QACF,oBAAoB;QAEpB;;;UAGE;QACF,cAAc;QAEd,sCAAsC;QACtC,+CAA+C;QAE/C;;;WAGG;QACH,cAAc;QAEd;;;WAGG;QACH,oBAAoB,EAAE,IAAI;QAE1B,6EAA6E;QAC7E,qEAAqE;QAErE;;;WAGG;QACH,+BAA+B;QAE/B,kEAAkE;QAClE,2BAA2B;QAE3B;;;;;;;WAOG;QACH,QAAQ,EAAE;YACR,QAAQ,EAAE,eAAe;SAC1B;QAED;;;;;;;;;WASG;QACH,mBAAmB;QACnB,oCAAoC;QACpC,YAAY;QACZ,aAAa;QACb,KAAK;QAEL;;;;;WAKG;QACH,iBAAiB;QACjB,2BAA2B;QAC3B,KAAK;QAEL;;;;UAIE;QACF,4BAA4B;QAC5B;;;;;;WAMG;QACH,sBAAsB,EAAE;YACtB;;;;;;cAME;YACF,aAAa,EAAE,CAAC,SAAS,CAAC;YAC1B;;;;;;;;cAQE;YACF,cAAc,EAAE,CAAC,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,CAAC;SACzD;QACD,eAAe,EAAE;YACf,GAAG,EAAE;gBACH;;;;mBAIG;gBACH,eAAe,EAAE,oBAAoB;gBAErC;;;;kBAIE;gBACF,WAAW;gBACX,aAAa;gBACb,kEAAkE;gBAClE,iEAAiE;gBACjE,kBAAkB;gBAClB,QAAQ;gBACR,sBAAsB;gBACtB,OAAO;gBACP,eAAe;gBACf,QAAQ;gBACR,4CAA4C;gBAC5C,6CAA6C;gBAC7C,SAAS;gBACT,QAAQ;gBACR,2CAA2C;gBAC3C,6CAA6C;gBAC7C,QAAQ;gBACR,OAAO;gBACP,oBAAoB;gBACpB,QAAQ;gBACR,oDAAoD;gBACpD,uDAAuD;gBACvD,SAAS;gBACT,QAAQ;gBACR,mDAAmD;gBACnD,6DAA6D;gBAC7D,SAAS;gBACT,QAAQ;gBACR,mDAAmD;gBACnD,yDAAyD;gBACzD,SAAS;gBACT,QAAQ;gBACR,8CAA8C;gBAC9C,2CAA2C;gBAC3C,SAAS;gBACT,QAAQ;gBACR,6CAA6C;gBAC7C,2CAA2C;gBAC3C,QAAQ;gBACR,MAAM;gBACN,IAAI;aACL;YACD,KAAK,EAAE;gBACL;;;;kBAIE;gBACF,eAAe,EAAE,wEAAwE;gBAEzF;;;;;mBAKG;gBACH,WAAW;gBACX,KAAK;aACN;SACF;KACF;CACF,CAAC,CAAC;AAEH,kBAAe,YAAY,CAAC"}
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":";;AAEA,mCAaiB;AAGjB,MAAM,YAAY,GAAG,CAAC,EAAE,QAAQ,GAAG,eAAe,EAAE,SAAS,GAAG,KAAK,EAAE,eAAe,GAAG,KAAK,KAAc,EAAE,EAAkB,EAAE,CAAC,CAAC;IAClI,SAAS,EAAE;QACT,0CAA0C;QAC1C,IAAA,sBAAc,GAAE;QAChB,IAAA,qBAAa,EAAC,EAAE,WAAW,EAAE,eAAe,EAAE,CAAC;QAC/C,IAAA,4BAAoB,GAAE;QACtB,IAAA,2BAAmB,GAAE;QACrB,IAAA,wBAAgB,GAAE;QAClB,IAAA,6BAAqB,GAAE;QACvB,IAAA,+BAAuB,GAAE;QAEzB,gEAAgE;QAChE,IAAA,qBAAa,GAAE;QACf,IAAA,qBAAa,GAAE;QACf,IAAA,uBAAe,GAAE;QACjB,IAAA,4BAAoB,GAAE;QACtB,IAAA,wBAAgB,GAAE;KACnB;IACD,OAAO,EAAE;QACP;;;;UAIE;QACF,WAAW,EAAE;YACX,IAAI,EAAE,cAAc;YACpB,eAAe,EAAE,CAAC,KAAK,EAAE,SAAS,EAAE,cAAc,EAAE,UAAU,EAAE,aAAa,EAAE,YAAY,CAAC;SAC7F;QAED;;;;UAIE;QACF,cAAc;QACd,cAAc;QACd,kBAAkB;QAClB,KAAK;QAEL;;UAEE;QACF,WAAW,EAAE,IAAI,SAAS,GAAG;QAE7B;;;UAGE;QACF,cAAc;QAEd,sCAAsC;QACtC,+CAA+C;QAE/C;;;WAGG;QACH,cAAc;QAEd;;;WAGG;QACH,oBAAoB,EAAE,CAAC,eAAe;QAEtC,6EAA6E;QAC7E,qEAAqE;QAErE;;;WAGG;QACH,+BAA+B;QAE/B,kEAAkE;QAClE,2BAA2B;QAE3B;;;;;;;WAOG;QACH,QAAQ,EAAE;YACR,QAAQ,EAAE,QAAQ;SACnB;QAED;;;;;;;;;WASG;QACH,mBAAmB;QACnB,oCAAoC;QACpC,YAAY;QACZ,aAAa;QACb,KAAK;QAEL;;;;;WAKG;QACH,iBAAiB;QACjB,2BAA2B;QAC3B,KAAK;QAEL;;;;UAIE;QACF,4BAA4B;QAC5B;;;;;;WAMG;QACH,sBAAsB,EAAE;YACtB;;;;;;cAME;YACF,aAAa,EAAE,CAAC,SAAS,CAAC;YAC1B;;;;;;;;cAQE;YACF,cAAc,EAAE,CAAC,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,CAAC;SACzD;QACD,eAAe,EAAE;YACf,GAAG,EAAE;gBACH;;;;mBAIG;gBACH,eAAe,EAAE,oBAAoB;gBAErC;;;;kBAIE;gBACF,WAAW;gBACX,aAAa;gBACb,kEAAkE;gBAClE,iEAAiE;gBACjE,kBAAkB;gBAClB,QAAQ;gBACR,sBAAsB;gBACtB,OAAO;gBACP,eAAe;gBACf,QAAQ;gBACR,4CAA4C;gBAC5C,6CAA6C;gBAC7C,SAAS;gBACT,QAAQ;gBACR,2CAA2C;gBAC3C,6CAA6C;gBAC7C,QAAQ;gBACR,OAAO;gBACP,oBAAoB;gBACpB,QAAQ;gBACR,oDAAoD;gBACpD,uDAAuD;gBACvD,SAAS;gBACT,QAAQ;gBACR,mDAAmD;gBACnD,6DAA6D;gBAC7D,SAAS;gBACT,QAAQ;gBACR,mDAAmD;gBACnD,yDAAyD;gBACzD,SAAS;gBACT,QAAQ;gBACR,8CAA8C;gBAC9C,2CAA2C;gBAC3C,SAAS;gBACT,QAAQ;gBACR,6CAA6C;gBAC7C,2CAA2C;gBAC3C,QAAQ;gBACR,MAAM;gBACN,IAAI;aACL;YACD,KAAK,EAAE;gBACL;;;;kBAIE;gBACF,eAAe,EAAE,wEAAwE;gBAEzF;;;;;mBAKG;gBACH,WAAW;gBACX,KAAK;aACN;SACF;KACF;CACF,CAAC,CAAC;AAEH,kBAAe,YAAY,CAAC"}

package/build/index.d.ts

@@ -1,5 +1,5 @@
 import createConfig from './config';
 export { createConfig };
 export * from './rules';
-declare const _default: import("dependency-cruiser").IConfiguration;
-export default _default;
+declare const defaultConfig: import("dependency-cruiser").IConfiguration;
+export default defaultConfig;

package/build/index.js

@@ -17,5 +17,6 @@ exports.createConfig = void 0;
 const config_1 = __importDefault(require("./config"));
 exports.createConfig = config_1.default;
 __exportStar(require("./rules"), exports);
-exports.default = config_1.default();
+const defaultConfig = (0, config_1.default)();
+exports.default = defaultConfig;
 //# sourceMappingURL=index.js.map

package/build/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,sDAAoC;AAE3B,uBAFF,gBAAY,CAEE;AACrB,0CAAwB;AACxB,kBAAe,gBAAY,EAAE,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,sDAAoC;AAE3B,uBAFF,gBAAY,CAEE;AACrB,0CAAwB;AAExB,MAAM,aAAa,GAAG,IAAA,gBAAY,GAAE,CAAC;AAErC,kBAAe,aAAa,CAAC"}

package/build/rules/noOrphans.d.ts

@@ -1,3 +1,6 @@
 import { IRegularForbiddenRuleType } from 'dependency-cruiser';
-declare const noOrphansRule: () => IRegularForbiddenRuleType;
+export interface NoOrphansOptions {
+    ignoreTypes?: boolean;
+}
+declare const noOrphansRule: ({ ignoreTypes }?: NoOrphansOptions) => IRegularForbiddenRuleType;
 export default noOrphansRule;

package/build/rules/noOrphans.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const noOrphansRule = () => ({
+const noOrphansRule = ({ ignoreTypes = false } = {}) => ({
     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), " +
@@ -14,7 +14,8 @@ const noOrphansRule = () => ({
             '(^|/)\\.[^/]+\\.(js|cjs|mjs|ts|json)$',
             '\\.d\\.ts$',
             '(^|/)tsconfig\\.json$',
-            '(^|/)(babel|webpack)\\.config\\.(js|cjs|mjs|ts|json)$', // other configs
+            '(^|/)(babel|webpack)\\.config\\.(js|cjs|mjs|ts|json)$',
+            ...(ignoreTypes ? ['(^|/)types\\.ts$'] : []),
         ],
     },
     to: {},

package/build/rules/noOrphans.js.map

@@ -1 +1 @@
-{"version":3,"file":"noOrphans.js","sourceRoot":"","sources":["../../src/rules/noOrphans.ts"],"names":[],"mappings":";;AAEA,MAAM,aAAa,GAAG,GAA8B,EAAE,CAAC,CAAC;IACtD,IAAI,EAAE,YAAY;IAClB,OAAO,EACL,+EAA+E;QAC/E,iFAAiF;QACjF,+EAA+E;QAC/E,qFAAqF;QACrF,yEAAyE;IAC3E,QAAQ,EAAE,MAAM;IAChB,IAAI,EAAE;QACJ,MAAM,EAAE,IAAI;QACZ,OAAO,EAAE;YACP,uCAAuC;YACvC,YAAY;YACZ,uBAAuB;YACvB,uDAAuD,EAAE,gBAAgB;SAC1E;KACF;IACD,EAAE,EAAE,EAAE;CACP,CAAC,CAAC;AAEH,kBAAe,aAAa,CAAC"}
+{"version":3,"file":"noOrphans.js","sourceRoot":"","sources":["../../src/rules/noOrphans.ts"],"names":[],"mappings":";;AAMA,MAAM,aAAa,GAAG,CAAC,EAAE,WAAW,GAAG,KAAK,KAAuB,EAAE,EAA6B,EAAE,CAAC,CAAC;IACpG,IAAI,EAAE,YAAY;IAClB,OAAO,EACL,+EAA+E;QAC/E,iFAAiF;QACjF,+EAA+E;QAC/E,qFAAqF;QACrF,yEAAyE;IAC3E,QAAQ,EAAE,MAAM;IAChB,IAAI,EAAE;QACJ,MAAM,EAAE,IAAI;QACZ,OAAO,EAAE;YACP,uCAAuC;YACvC,YAAY;YACZ,uBAAuB;YACvB,uDAAuD;YACvD,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;SAC7C;KACF;IACD,EAAE,EAAE,EAAE;CACP,CAAC,CAAC;AAEH,kBAAe,aAAa,CAAC"}

package/build/types.d.ts

@@ -0,0 +1,5 @@
+export interface Options {
+    tsconfig?: string;
+    sourceDir?: string;
+    allowTypeCycles?: boolean;
+}

package/build/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/build/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@voiceflow/dependency-cruiser-config",
   "description": "dependency-cruiser config for voiceflow",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "author": "Ben Teichman",
   "bugs": {
     "url": "https://github.com/voiceflow/dependency-cruiser-config/issues"
@@ -13,35 +13,35 @@
   },
   "devDependencies": {
     "@istanbuljs/nyc-config-typescript": "^1.0.2",
-    "@types/chai": "^4.2.21",
+    "@types/chai": "4.3.0",
     "@types/chai-as-promised": "^7.1.4",
     "@types/git-branch": "2.0.2",
-    "@types/mocha": "^9.0.0",
-    "@types/node": "^17.0.8",
-    "@voiceflow/commitlint-config": "^1.1.0",
+    "@types/mocha": "9.1.0",
+    "@types/node": "17.0.10",
+    "@voiceflow/commitlint-config": "2.0.0",
     "@voiceflow/eslint-config": "^3.2.1",
-    "@voiceflow/git-branch-check": "^1.2.0",
-    "@voiceflow/prettier-config": "^1.0.5",
-    "@voiceflow/tsconfig": "^1.0.0",
+    "@voiceflow/git-branch-check": "1.2.3",
+    "@voiceflow/prettier-config": "1.0.6",
+    "@voiceflow/tsconfig": "1.2.5",
     "@zerollup/ts-transform-paths": "^1.7.18",
     "chai": "^4.3.4",
     "chai-as-promised": "^7.1.1",
     "commitizen": "^4.2.4",
-    "commitlint": "^12.1.4",
+    "commitlint": "16.1.0",
     "cz-conventional-changelog": "^3.3.0",
-    "depcheck": "^1.4.2",
+    "depcheck": "1.4.3",
     "dependency-cruiser": "11.2.1",
     "eslint": "^7.26.0",
     "fixpack": "^4.0.0",
-    "husky": "^6.0.0",
-    "lint-staged": "^11.0.0",
-    "mocha": "^9.1.3",
+    "husky": "7.0.4",
+    "lint-staged": "12.2.2",
+    "mocha": "9.1.4",
     "nyc": "^15.1.0",
     "prettier": "^2.3.0",
     "rimraf": "^3.0.2",
-    "ts-mocha": "^8.0.0",
-    "ttypescript": "^1.5.12",
-    "typescript": "^4.3.2"
+    "ts-mocha": "9.0.2",
+    "ttypescript": "1.5.13",
+    "typescript": "4.5.5"
   },
   "files": [
     "build"