dependency-cruiser 10.0.2 → 10.0.6

package/src/cli/tools/wrap-stream-in-html.js

@@ -1,6 +1,5 @@
 const fs = require("fs");
 const path = require("path");
-const getStream = require("get-stream");
 
 const HEADER_FILE = path.join(
   __dirname,
@@ -29,26 +28,32 @@ const FOOTER_FILE = path.join(
  *
  * ... but portable over node platforms
  *
- * @param {string} pHeaderFileName header
- * @param {string} pScriptFileName script
- * @param {string} pFooterFileName footer
- * @param {stream} pStream stream whose characters are to be slapped between header and footer
- * @returns {string} yadda
+ * @param {readStream} pStream stream whose characters are to be slapped between header and footer
+ * @param {writeStream} pOutStream stream to write to
  */
-async function wrap(
-  pHeaderFileName,
-  pScriptFileName,
-  pFooterFileName,
-  pStream
-) {
-  const lHeader = fs.readFileSync(pHeaderFileName, "utf8");
-  const lScript = fs.readFileSync(pScriptFileName, "utf8");
-  const lFooter = fs.readFileSync(pFooterFileName, "utf8");
+function wrap(pInStream, pOutStream) {
+  const lHeader = fs.readFileSync(HEADER_FILE, "utf8");
+  const lScript = fs.readFileSync(SCRIPT_FILE, "utf8");
+  const lEnd = fs.readFileSync(FOOTER_FILE, "utf8");
+  const lFooter = `<script>${lScript}</script>${lEnd}`;
 
-  return `${lHeader}${await getStream(
-    pStream
-  )}<script>${lScript}</script>${lFooter}`;
+  pOutStream.write(lHeader);
+  pInStream
+    .on("end", () => {
+      pOutStream.write(lFooter);
+      pOutStream.end();
+    })
+    .on(
+      "error",
+      /* c8 ignore start */
+      (pError) => {
+        process.stderr.write(`${pError}\n`);
+      }
+      /* c8 ignore stop */
+    )
+    .on("data", (pChunk) => {
+      pOutStream.write(pChunk);
+    });
 }
 
-module.exports = (pStream) =>
-  wrap(HEADER_FILE, SCRIPT_FILE, FOOTER_FILE, pStream);
+module.exports = (pInStream, pOutStream) => wrap(pInStream, pOutStream);

package/src/cli/validate-node-environment.js

@@ -1,5 +1,5 @@
 const semver = require("semver");
-const $package = require("../../package.json");
+const { engines } = require("../../src/meta.js");
 
 module.exports = function validateNodeEnvironment(pNodeVersion) {
   // not using default parameter here because the check should run
@@ -7,12 +7,12 @@ module.exports = function validateNodeEnvironment(pNodeVersion) {
   const lNodeVersion = pNodeVersion || process.versions.node;
   const VERSION_ERR = `\nERROR: Your node version (${lNodeVersion}) is not supported. dependency-cruiser
        follows the node.js release cycle and runs on these node versions:
-       ${$package.engines.node}
+       ${engines.node}
        See https://nodejs.org/en/about/releases/ for details.
 
 `;
 
-  if (!semver.satisfies(lNodeVersion, $package.engines.node)) {
+  if (!semver.satisfies(lNodeVersion, engines.node)) {
     throw new Error(VERSION_ERR);
   }
 };

package/src/config-utl/extract-babel-config.js

@@ -7,7 +7,7 @@ const json5 = require("json5");
 const _get = require("lodash/get");
 const _has = require("lodash/has");
 const tryRequire = require("semver-try-require");
-const $package = require("../../package.json");
+const { supportedTranspilers } = require("../../src/meta.js");
 const makeAbsolute = require("./make-absolute");
 
 function getCommonJSConfig(pBabelConfigFileName) {
@@ -87,9 +87,8 @@ function getConfig(pBabelConfigFileName) {
  */
 module.exports = function extractBabelConfig(pBabelConfigFileName) {
   let lReturnValue = {};
-  const babel = tryRequire("@babel/core", $package.supportedTranspilers.babel);
+  const babel = tryRequire("@babel/core", supportedTranspilers.babel);
 
-  /* istanbul ignore else */
   if (babel) {
     const lConfig = {
       ...getConfig(pBabelConfigFileName),

package/src/config-utl/extract-ts-config.js

@@ -1,21 +1,20 @@
 const path = require("path");
 const tryRequire = require("semver-try-require");
 const _get = require("lodash/get");
-const $package = require("../../package.json");
+const { supportedTranspilers } = require("../../src/meta.js");
 
-const typescript = tryRequire(
-  "typescript",
-  _get($package, "supportedTranspilers.typescript", null)
-);
+const typescript = tryRequire("typescript", supportedTranspilers.typescript);
 
 const FORMAT_DIAGNOSTICS_HOST = {
   getCanonicalFileName(pFileName) {
     let lReturnValue = pFileName.toLowerCase();
 
-    /* istanbul ignore next - depends on the platform which branch is taken */
+    // depends on the platform which branch is taken, hence the c8 ignore
+    /* c8 ignore start */
     if (_get(typescript, "sys.useCaseSensitiveFileNames", false)) {
       lReturnValue = pFileName;
     }
+    /* c8 ignore stop */
     return lReturnValue;
   },
   getCurrentDirectory() {
@@ -40,7 +39,6 @@ const FORMAT_DIAGNOSTICS_HOST = {
 module.exports = function extractTSConfig(pTSConfigFileName) {
   let lReturnValue = {};
 
-  /* istanbul ignore else */
   if (typescript) {
     const lConfig = typescript.readConfigFile(
       pTSConfigFileName,

package/src/enrich/derive/reachable/index.js

@@ -1,4 +1,4 @@
-/* eslint-disable security/detect-object-injection */
+/* eslint-disable security/detect-object-injection, no-inline-comments */
 
 const _clone = require("lodash/clone");
 const _get = require("lodash/get");
@@ -62,13 +62,7 @@ function mergeReachesProperties(pFromModule, pToModule, pRule, pPath) {
 
   if (lIndexExistingReachable > -1) {
     lReaches[lIndexExistingReachable].modules = (
-      lReaches[lIndexExistingReachable].modules ||
-      // eslint-disable-next-line no-inline-comments
-      /* istanbul ignore next: 'modules' is a mandatory attribute so shouldn't
-       * happen it doesn't exist, but defensive default here nonetheless
-       */
-
-      []
+      lReaches[lIndexExistingReachable].modules /* c8 ignore next */ || []
     ).concat({
       source: pToModule.source,
       via: pPath,

package/src/extract/ast-extractors/extract-typescript-deps.js

@@ -1,11 +1,8 @@
-/* eslint-disable valid-jsdoc */
+/* eslint-disable valid-jsdoc, no-inline-comments */
 const tryRequire = require("semver-try-require");
-const $package = require("../../../package.json");
+const { supportedTranspilers } = require("../../../src/meta.js");
 
-const typescript = tryRequire(
-  "typescript",
-  $package.supportedTranspilers.typescript
-);
+const typescript = tryRequire("typescript", supportedTranspilers.typescript);
 
 /*
  * Both extractImport* assume the imports/ exports can only occur at
@@ -249,5 +246,5 @@ module.exports = function extractTypeScriptDependencies(
           extractNestedDependencies(pTypeScriptAST, pExoticRequireStrings)
         )
         .map((pModule) => ({ dynamic: false, ...pModule }))
-    : [];
+    : /* c8 ignore next */ [];
 };

package/src/extract/ast-extractors/swc-dependency-visitor.js

@@ -1,9 +1,8 @@
 const tryRequire = require("semver-try-require");
+const { supportedTranspilers } = require("../../../src/meta.js");
+
 /** @type {import('@swc/core/Visitor')} */
-const VisitorModule = tryRequire(
-  "@swc/core/Visitor",
-  require("../../../package.json").supportedTranspilers.swc
-);
+const VisitorModule = tryRequire("@swc/core/Visitor", supportedTranspilers.swc);
 
 const Visitor = VisitorModule.default;
 
@@ -12,11 +11,11 @@ function pryStringsFromArguments(pArguments) {
 
   if (pArguments[0].expression.type === "StringLiteral") {
     lReturnValue = pArguments[0].expression.value;
-  }
-  // istanbul ignore else
-  else if (pArguments[0].expression.type === "TemplateLiteral") {
+  } else if (pArguments[0].expression.type === "TemplateLiteral") {
+    /* c8 ignore start */
     lReturnValue = pArguments[0].expression.quasis[0].cooked.value;
   }
+  /* c8 ignore stop */
 
   return lReturnValue;
 }
@@ -83,7 +82,6 @@ function isInterestingCallExpression(pExoticRequireStrings, pNode) {
     .concat(pExoticRequireStrings.filter((pString) => !pString.includes(".")))
     .includes(pNode.callee.value);
 }
-// istanbul ignore else
 if (VisitorModule) {
   module.exports = class SwcDependencyVisitor extends Visitor {
     constructor(pExoticRequireStrings) {
@@ -124,20 +122,22 @@ if (VisitorModule) {
       return super.visitExportAllDeclration(pNode);
     }
 
-    /* istanbul ignore next */
+    /* c8 ignore start */
     visitExportAllDeclaration(pNode) {
       return this.visitExportAllDeclration(pNode);
     }
+    /* c8 ignore stop */
 
     // same spelling error as the above - same solution
     visitExportNamedDeclration(pNode) {
       this.pushImportExportSource(pNode);
       return super.visitExportNamedDeclration(pNode);
     }
-    /* istanbul ignore next */
+    /* c8 ignore start */
     visitExportNamedDeclaration(pNode) {
       return this.visitExportNamedDeclration(pNode);
     }
+    /* c8 ignore stop */
 
     visitCallExpression(pNode) {
       if (
@@ -164,12 +164,13 @@ if (VisitorModule) {
 
       return super.visitCallExpression(pNode);
     }
-    // istanbul ignore next
+    /* c8 ignore start */
     visitTsType(pNode) {
       // override so the 'visitTsType not implemented' error message
       // as defined in the super class doesn't appear
       return pNode;
     }
+    /* c8 ignore stop */
 
     visitTsTypeAnnotation(pNode) {
       // as visitors for some shapes of type annotations aren't completely
@@ -197,6 +198,8 @@ if (VisitorModule) {
       return this.lResult;
     }
   };
+  /* c8 ignore start */
 } else {
   module.exports = {};
 }
+/* c8 ignore stop */

package/src/extract/parse/to-swc-ast.js

@@ -1,10 +1,9 @@
 const tryRequire = require("semver-try-require");
 const _memoize = require("lodash/memoize");
+const { supportedTranspilers } = require("../../../src/meta.js");
+
 /** @type {import('@swc/core')} */
-const swc = tryRequire(
-  "@swc/core",
-  require("../../../package.json").supportedTranspilers.swc
-);
+const swc = tryRequire("@swc/core", supportedTranspilers.swc);
 
 const SWC_PARSE_OPTIONS = {
   dynamicImport: true,

package/src/extract/parse/to-typescript-ast.js

@@ -1,10 +1,9 @@
 const fs = require("fs");
 const tryRequire = require("semver-try-require");
 const _memoize = require("lodash/memoize");
-const typescript = tryRequire(
-  "typescript",
-  require("../../../package.json").supportedTranspilers.typescript
-);
+const { supportedTranspilers } = require("../../../src/meta.js");
+
+const typescript = tryRequire("typescript", supportedTranspilers.typescript);
 
 /**
  * Compiles pTypescriptSource into a (typescript) AST

package/src/extract/transpile/babel-wrap.js

@@ -1,7 +1,7 @@
 const tryRequire = require("semver-try-require");
-const $package = require("../../../package.json");
+const { supportedTranspilers } = require("../../../src/meta.js");
 
-const babel = tryRequire("@babel/core", $package.supportedTranspilers.babel);
+const babel = tryRequire("@babel/core", supportedTranspilers.babel);
 
 module.exports = {
   isAvailable: () => babel !== false,

package/src/extract/transpile/coffeescript-wrap.js

@@ -1,5 +1,5 @@
 const tryRequire = require("semver-try-require");
-const $package = require("../../../package.json");
+const { supportedTranspilers } = require("../../../src/meta.js");
 
 /*
  * coffeescript's npm repo was renamed from coffee-script to coffeescript
@@ -9,16 +9,17 @@ const $package = require("../../../package.json");
 function getCoffeeScriptModule() {
   let lReturnValue = tryRequire(
     "coffeescript",
-    $package.supportedTranspilers.coffeescript
+    supportedTranspilers.coffeescript
   );
 
-  /* istanbul ignore if*/
+  /* c8 ignore start */
   if (lReturnValue === false) {
     lReturnValue = tryRequire(
       "coffee-script",
-      $package.supportedTranspilers["coffee-script"]
+      supportedTranspilers["coffee-script"]
     );
   }
+  /* c8 ignore stop */
   return lReturnValue;
 }
 

package/src/extract/transpile/livescript-wrap.js

@@ -1,12 +1,12 @@
 const tryRequire = require("semver-try-require");
-const livescript = tryRequire(
-  "livescript",
-  require("../../../package.json").supportedTranspilers.livescript
-);
+const { supportedTranspilers } = require("../../../src/meta.js");
 
-/* istanbul ignore next */
+const livescript = tryRequire("livescript", supportedTranspilers.livescript);
+
+/* c8 ignore start */
 module.exports = {
   isAvailable: () => livescript !== false,
 
   transpile: (pSource) => livescript.compile(pSource),
 };
+/* c8 ignore stop */

package/src/extract/transpile/meta.js

@@ -1,5 +1,5 @@
 const _get = require("lodash/get");
-const { supportedTranspilers } = require("../../../package.json");
+const { supportedTranspilers } = require("../../../src/meta.js");
 const swc = require("../parse/to-swc-ast");
 const javaScriptWrap = require("./javascript-wrap");
 const typeScriptWrap = require("./typescript-wrap")();

package/src/extract/transpile/svelte-wrap.js

@@ -1,7 +1,9 @@
 const tryRequire = require("semver-try-require");
+const { supportedTranspilers } = require("../../../src/meta.js");
+
 const svelteCompiler = tryRequire(
   "svelte/compiler",
-  require("../../../package.json").supportedTranspilers.svelte
+  supportedTranspilers.svelte
 );
 const preProcess = require("./svelte-preprocess");
 

package/src/extract/transpile/typescript-wrap.js

@@ -1,9 +1,8 @@
 const tryRequire = require("semver-try-require");
 const _get = require("lodash/get");
-const typescript = tryRequire(
-  "typescript",
-  require("../../../package.json").supportedTranspilers.typescript
-);
+const { supportedTranspilers } = require("../../../src/meta.js");
+
+const typescript = tryRequire("typescript", supportedTranspilers.typescript);
 
 function getCompilerOptions(pTsx, pTSConfig) {
   let lCompilerOptions = {};

package/src/extract/transpile/vue-template-wrap.js

@@ -1,8 +1,10 @@
 const _get = require("lodash/get");
 const tryRequire = require("semver-try-require");
+const { supportedTranspilers } = require("../../../src/meta.js");
+
 const vueTemplateCompiler = tryRequire(
   "vue-template-compiler",
-  require("../../../package.json").supportedTranspilers["vue-template-compiler"]
+  supportedTranspilers["vue-template-compiler"]
 );
 
 module.exports = {

package/src/main/index.js

@@ -3,7 +3,7 @@
 const Ajv = require("ajv").default;
 const extract = require("../extract");
 const enrich = require("../enrich");
-const cruiseResultSchema = require("../schema/cruise-result.schema.json");
+const cruiseResultSchema = require("../schema/cruise-result.schema.js");
 const meta = require("../extract/transpile/meta");
 const bus = require("../utl/bus");
 const normalizeFilesAndDirectories = require("./files-and-dirs/normalize");

package/src/main/options/defaults.js

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

package/src/main/options/normalize.js

@@ -2,7 +2,7 @@
 const _clone = require("lodash/clone");
 const _has = require("lodash/has");
 const normalizeREProperties = require("../utl/normalize-re-properties");
-const defaults = require("./defaults.json");
+const defaults = require("./defaults.js");
 
 function uniq(pArray) {
   return [...new Set(pArray)];

package/src/main/rule-set/validate.js

@@ -2,7 +2,7 @@ const Ajv = require("ajv").default;
 const safeRegex = require("safe-regex");
 const _has = require("lodash/has");
 const { validateCruiseOptions } = require("../options/validate");
-const configurationSchema = require("../../schema/configuration.schema.json");
+const configurationSchema = require("../../schema/configuration.schema.js");
 
 const ajv = new Ajv();
 

package/src/meta.js

@@ -0,0 +1,18 @@
+/* generated - don't edit */
+
+module.exports = {
+  version: "10.0.6",
+  engines: {
+    node: "^12.20||^14||>=16",
+  },
+  supportedTranspilers: {
+    babel: ">=7.0.0 <8.0.0",
+    "coffee-script": ">=1.0.0 <2.0.0",
+    coffeescript: ">=1.0.0 <3.0.0",
+    livescript: ">=1.0.0 <2.0.0",
+    svelte: ">=3.0.0 <4.0.0",
+    swc: ">=1.0.0 <2.0.0",
+    typescript: ">=2.0.0 <5.0.0",
+    "vue-template-compiler": ">=2.0.0 <3.0.0",
+  },
+};

package/src/report/dot/default-theme.js

@@ -0,0 +1,145 @@
+module.exports = {
+  graph: {
+    ordering: "out",
+    rankdir: "LR",
+    splines: "true",
+    overlap: "false",
+    nodesep: "0.16",
+    ranksep: "0.18",
+    fontname: "Helvetica-bold",
+    fontsize: "9",
+    style: "rounded,bold,filled",
+    fillcolor: "#ffffff",
+    compound: "true",
+  },
+  node: {
+    shape: "box",
+    style: "rounded, filled",
+    height: "0.2",
+    color: "black",
+    fillcolor: "#ffffcc",
+    fontcolor: "black",
+    fontname: "Helvetica",
+    fontsize: 9,
+  },
+  edge: {
+    arrowhead: "normal",
+    arrowsize: "0.6",
+    penwidth: "2.0",
+    color: "#00000033",
+    fontname: "Helvetica",
+    fontsize: "9",
+  },
+  modules: [
+    {
+      criteria: { consolidated: true },
+      attributes: { shape: "box3d" },
+    },
+    {
+      criteria: { "rules[0].severity": "error" },
+      attributes: { fontcolor: "red", color: "red" },
+    },
+    {
+      criteria: { "rules[0].severity": "warn" },
+      attributes: { fontcolor: "orange", color: "orange" },
+    },
+    {
+      criteria: { "rules[0].severity": "info" },
+      attributes: { fontcolor: "blue", color: "blue" },
+    },
+    {
+      criteria: { valid: false },
+      attributes: { fontcolor: "red", color: "red" },
+    },
+    {
+      criteria: { couldNotResolve: true },
+      attributes: { color: "red", fontcolor: "red" },
+    },
+    {
+      criteria: { coreModule: true },
+      attributes: { color: "grey", fontcolor: "grey" },
+    },
+    {
+      criteria: { source: "node_modules" },
+      attributes: { fillcolor: "#c40b0a1a", fontcolor: "#c40b0a" },
+    },
+    {
+      criteria: { matchesDoNotFollow: true },
+      attributes: { shape: "folder" },
+    },
+    {
+      criteria: { orphan: true },
+      attributes: { fillcolor: "#ccffcc" },
+    },
+    {
+      criteria: { source: "\\.json$" },
+      attributes: { fillcolor: "#ffee44" },
+    },
+    {
+      criteria: { source: "\\.jsx$" },
+      attributes: { fillcolor: "#ffff77" },
+    },
+    {
+      criteria: { source: "\\.vue$" },
+      attributes: { fillcolor: "#41f083" },
+    },
+    {
+      criteria: { source: "\\.ts$" },
+      attributes: { fillcolor: "#ddfeff" },
+    },
+    {
+      criteria: { source: "\\.tsx$" },
+      attributes: { fillcolor: "#bbfeff" },
+    },
+    {
+      criteria: { source: "\\.svelte$" },
+      attributes: { fillcolor: "#febbff" },
+    },
+    {
+      criteria: { source: "(\\.coffee|\\.litcoffee|\\.coffee\\.md)$" },
+      attributes: { fillcolor: "#eeccaa" },
+    },
+    {
+      criteria: { source: "(\\.csx|\\.cjsx)$" },
+      attributes: { fillcolor: "#eebb77" },
+    },
+    {
+      criteria: { source: "\\.ls$/g" },
+      attributes: { fillcolor: "pink" },
+    },
+  ],
+  dependencies: [
+    {
+      criteria: { "rules[0].severity": "error" },
+      attributes: { fontcolor: "red", color: "red" },
+    },
+    {
+      criteria: { "rules[0].severity": "warn" },
+      attributes: { fontcolor: "orange", color: "orange" },
+    },
+    {
+      criteria: { "rules[0].severity": "info" },
+      attributes: { fontcolor: "blue", color: "blue" },
+    },
+    {
+      criteria: { valid: false },
+      attributes: { fontcolor: "red", color: "red" },
+    },
+    {
+      criteria: { circular: true },
+      attributes: { arrowhead: "normalnoneodot" },
+    },
+    {
+      criteria: { preCompilationOnly: true },
+      attributes: { arrowhead: "onormal", penwidth: "1.0" },
+    },
+    {
+      criteria: { coreModule: true },
+      attributes: { style: "dashed", penwidth: "1.0" },
+    },
+    {
+      criteria: { "dependencyTypes[0]": "npm" },
+      attributes: { penwidth: "1.0" },
+    },
+  ],
+};