dependency-cruiser 13.1.1 → 13.1.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dependency-cruiser",
-  "version": "13.1.1",
+  "version": "13.1.3",
   "description": "Validate and visualize dependencies. With your rules. JavaScript, TypeScript, CoffeeScript. ES6, CommonJS, AMD.",
   "keywords": [
     "static analysis",
@@ -159,7 +159,7 @@
     "enhanced-resolve": "5.15.0",
     "figures": "5.0.0",
     "glob": "10.3.3",
-    "handlebars": "4.7.7",
+    "handlebars": "4.7.8",
     "ignore": "5.2.4",
     "indent-string": "5.0.0",
     "interpret": "^3.1.1",
@@ -173,41 +173,39 @@
     "semver-try-require": "6.2.3",
     "teamcity-service-messages": "0.1.14",
     "tsconfig-paths-webpack-plugin": "4.1.0",
-    "watskeburt": "0.11.6",
+    "watskeburt": "0.12.1",
     "wrap-ansi": "8.1.0"
   },
   "devDependencies": {
-    "@babel/core": "7.22.9",
+    "@babel/core": "7.22.10",
     "@babel/plugin-transform-modules-commonjs": "7.22.5",
     "@babel/preset-typescript": "7.22.5",
-    "@swc/core": "1.3.69",
-    "@types/lodash": "4.14.195",
-    "@types/node": "20.4.2",
+    "@swc/core": "1.3.76",
+    "@types/lodash": "4.14.197",
+    "@types/node": "20.4.10",
     "@types/prompts": "2.4.4",
-    "@typescript-eslint/eslint-plugin": "6.0.0",
-    "@typescript-eslint/parser": "6.0.0",
+    "@typescript-eslint/eslint-plugin": "6.3.0",
+    "@typescript-eslint/parser": "6.3.0",
     "@vue/compiler-sfc": "3.3.4",
-    "c8": "8.0.0",
-    "chai": "4.3.7",
-    "chai-json-schema": "1.5.1",
+    "c8": "8.0.1",
     "coffeescript": "2.7.0",
-    "eslint": "8.45.0",
+    "eslint": "8.47.0",
     "eslint-config-moving-meadow": "4.0.2",
-    "eslint-config-prettier": "8.8.0",
+    "eslint-config-prettier": "9.0.0",
     "eslint-plugin-budapestian": "5.0.1",
     "eslint-plugin-eslint-comments": "3.2.0",
-    "eslint-plugin-import": "2.27.5",
+    "eslint-plugin-import": "2.28.0",
     "eslint-plugin-mocha": "10.1.0",
     "eslint-plugin-node": "11.1.0",
     "eslint-plugin-security": "1.7.1",
-    "eslint-plugin-unicorn": "^47.0.0",
+    "eslint-plugin-unicorn": "^48.0.1",
     "husky": "8.0.3",
     "intercept-stdout": "0.1.2",
-    "lint-staged": "13.2.3",
+    "lint-staged": "13.3.0",
     "mocha": "10.2.0",
     "normalize-newline": "4.1.0",
     "npm-run-all": "4.1.5",
-    "prettier": "3.0.0",
+    "prettier": "3.0.1",
     "proxyquire": "2.1.3",
     "shx": "0.3.4",
     "svelte": "3.59.1",

package/src/cli/init-config/build-config.mjs

@@ -1,9 +1,6 @@
 // @ts-check
-import Handlebars from "handlebars/runtime.js";
 import { folderNameArrayToRE } from "./utl.mjs";
-
-/* eslint import/no-unassigned-import: 0 */
-await import("./config.js.template.js");
+import configTemplate from "./config-template.mjs";
 
 /**
  * @param {string} pString
@@ -24,25 +21,166 @@ function extensionsToString(pExtensions) {
   return "";
 }
 
+/**
+ * @param {import("./types.js").IInitConfig} pInitOptions
+ * @returns {string}
+ */
+function buildNotToTestRule(pInitOptions) {
+  const lNotToTestRule = `{
+      name: 'not-to-test',
+      comment:
+        "This module depends on code within a folder that should only contain tests. As tests don't " +
+        "implement functionality this is odd. Either you're writing a test outside the test folder " +
+        "or there's something in the test folder that isn't a test.",
+      severity: 'error',
+      from: {
+        pathNot: '{{testLocationRE}}'
+      },
+      to: {
+        path: '{{testLocationRE}}'
+      }
+    },`;
+  return pInitOptions.hasTestsOutsideSource
+    ? lNotToTestRule.replace(
+        /{{testLocationRE}}/g,
+        folderNameArrayToRE(pInitOptions?.testLocation ?? []),
+      )
+    : "";
+}
+
+/**
+ * @param {import("./types.js").IInitConfig} pInitOptions
+ * @returns {string}
+ */
+function buildTsPreCompilationDepsAttribute(pInitOptions) {
+  return pInitOptions.tsPreCompilationDeps
+    ? "tsPreCompilationDeps: true,"
+    : "// tsPreCompilationDeps: false,";
+}
+
+/**
+ * @param {import("./types.js").IInitConfig} pInitOptions
+ * @returns {string}
+ */
+function buildCombinedDependenciesAttribute(pInitOptions) {
+  return pInitOptions.combinedDependencies
+    ? "combinedDependencies: true,"
+    : "// combinedDependencies: false,";
+}
+
+/**
+ * @param {import("./types.js").IInitConfig} pInitOptions
+ * @returns {string}
+ */
+function buildTsOrJsConfigAttribute(pInitOptions) {
+  if (pInitOptions.useTsConfig) {
+    return `tsConfig: {
+      fileName: '${pInitOptions.tsConfig}'
+    },`;
+  }
+  if (pInitOptions.useJsConfig) {
+    return `tsConfig: {
+      fileName: '${pInitOptions.jsConfig}'
+    },`;
+  }
+  return `// tsConfig: {
+    //   fileName: 'tsconfig.json'
+    // },`;
+}
+
+/**
+ * @param {import("./types.js").IInitConfig} pInitOptions
+ * @returns {string}
+ */
+function buildWebpackConfigAttribute(pInitOptions) {
+  return pInitOptions.webpackConfig
+    ? `webpackConfig: {
+      fileName: '${pInitOptions.webpackConfig}',
+      // env: {},
+      // arguments: {}
+    },`
+    : `// webpackConfig: { 
+    //  fileName: 'webpack.config.js',
+    //  env: {},
+    //  arguments: {}
+    // },`;
+}
+
+/**
+ * @param {import("./types.js").IInitConfig} pInitOptions
+ * @returns {string}
+ */
+function buildBabelConfigAttribute(pInitOptions) {
+  return pInitOptions.babelConfig
+    ? `babelConfig: {
+      fileName: '${pInitOptions.babelConfig}'
+    },`
+    : `// babelConfig: {
+    //   fileName: '.babelrc',
+    // },`;
+}
+
+/**
+ * @param {import("./types.js").IInitConfig} pInitOptions
+ * @returns {string}
+ */
+function buildExtensionsAttribute(pInitOptions) {
+  return pInitOptions.specifyResolutionExtensions
+    ? `extensions: ${extensionsToString(pInitOptions.resolutionExtensions)},`
+    : `// extensions: [".js", ".jsx", ".ts", ".tsx", ".d.ts"],`;
+}
+
+/**
+ * @param {import("./types.js").IInitConfig} pInitOptions
+ * @returns {string}
+ */
+function buildMainFieldsAttribute(pInitOptions) {
+  return pInitOptions.usesTypeScript
+    ? `mainFields: ["main", "types"],`
+    : `// mainFields: ["main", "types"],`;
+}
+
 /**
  * Creates a .dependency-cruiser config with a set of basic validations
  * to the current directory.
  *
- * @param {import("./types.js").IInitConfig} pNormalizedInitOptions Options that influence the shape of
+ * @param {import("./types.js").IInitConfig} pInitOptions ('Normalized') options that influence the shape of
  *                  the configuration
  * @returns {string} the configuration as a string
  */
-
-export default function buildConfig(pNormalizedInitOptions) {
-  return Handlebars.templates["config.js.template.hbs"]({
-    ...pNormalizedInitOptions,
-
-    sourceLocationRE: folderNameArrayToRE(
-      pNormalizedInitOptions.sourceLocation
-    ),
-    testLocationRE: folderNameArrayToRE(pNormalizedInitOptions.testLocation),
-    resolutionExtensionsAsString: extensionsToString(
-      pNormalizedInitOptions.resolutionExtensions
-    ),
-  });
+export default function buildConfig(pInitOptions) {
+  return configTemplate
+    .replace(
+      /{{sourceLocationRE}}/g,
+      folderNameArrayToRE(pInitOptions.sourceLocation),
+    )
+    .replace(
+      /{{resolutionExtensionsAsString}}/g,
+      extensionsToString(pInitOptions.resolutionExtensions),
+    )
+    .replace("{{notToTestRule}}", buildNotToTestRule(pInitOptions))
+    .replace(
+      "{{tsPreCompilationDepsAttribute}}",
+      buildTsPreCompilationDepsAttribute(pInitOptions),
+    )
+    .replace(
+      "{{combinedDependenciesAttribute}}",
+      buildCombinedDependenciesAttribute(pInitOptions),
+    )
+    .replace(
+      "{{tsOrJsConfigAttribute}}",
+      buildTsOrJsConfigAttribute(pInitOptions),
+    )
+    .replace(
+      "{{webpackConfigAttribute}}",
+      buildWebpackConfigAttribute(pInitOptions),
+    )
+    .replace(
+      "{{babelConfigAttribute}}",
+      buildBabelConfigAttribute(pInitOptions),
+    )
+    .replace("{{extensionsAttribute}}", buildExtensionsAttribute(pInitOptions))
+    .replace("{{mainFieldsAttribute}}", buildMainFieldsAttribute(pInitOptions))
+    .replace("{{version}}", pInitOptions.version)
+    .replace("{{date}}", pInitOptions.date);
 }