dependency-cruiser 11.14.0 → 11.15.0-beta-2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dependency-cruiser",
-  "version": "11.14.0",
+  "version": "11.15.0-beta-2",
   "description": "Validate and visualize dependencies. With your rules. JavaScript, TypeScript, CoffeeScript. ES6, CommonJS, AMD.",
   "keywords": [
     "static analysis",
@@ -152,9 +152,11 @@
     "glob": "7.2.0",
     "handlebars": "4.7.7",
     "indent-string": "^4.0.0",
-    "inquirer": "^8.2.4",
+    "interpret": "^2.2.0",
     "json5": "2.2.1",
     "lodash": "4.17.21",
+    "prompts": "2.4.2",
+    "rechoir": "^0.8.0",
     "safe-regex": "2.1.1",
     "semver": "^7.3.7",
     "semver-try-require": "^5.0.2",
@@ -170,6 +172,7 @@
     "@swc/core": "1.2.220",
     "@types/lodash": "4.14.182",
     "@types/node": "18.6.2",
+    "@types/prompts": "2.0.14",
     "@typescript-eslint/eslint-plugin": "5.31.0",
     "@typescript-eslint/parser": "5.31.0",
     "@vue/compiler-sfc": "3.2.37",
@@ -225,14 +228,14 @@
         "because": "https://github.com/typicode/husky/issues/822"
       },
       {
-        "package": "inquirer",
+        "package": "indent-string",
         "policy": "wanted",
-        "because": "version 9 only exports ejs - and we use cjs and don't transpile"
+        "because": "version 5 only exports ejs - and we use cjs and don't transpile"
       },
       {
-        "package": "indent-string",
+        "package": "interpret",
         "policy": "wanted",
-        "because": "version 5 only exports ejs - and we use cjs and don't transpile"
+        "because": "we want to keep interpret ~similar to what webpack-cli is using (which is ^2.2.0)"
       },
       {
         "package": "lint-staged",
@@ -244,6 +247,11 @@
         "policy": "wanted",
         "because": "version 4 only exports ejs - and we use cjs and don't transpile (this only used in unit tests - but one of'em is a cjs one ...)"
       },
+      {
+        "package": "rechoir",
+        "policy": "wanted",
+        "because": "we want to keep rechoir ~similar to what webpack-cli is using (which is ^0.7.0, but ^0.8.0 is similar enough and more recent anyway)"
+      },
       {
         "package": "wrap-ansi",
         "policy": "wanted",

package/src/cli/init-config/get-user-input.js

@@ -1,141 +1,141 @@
-const inquirer = require("inquirer");
+const prompts = require("prompts");
 const {
+  isLikelyMonoRepo,
+  getMonoRepoPackagesCandidates,
   getSourceFolderCandidates,
   getTestFolderCandidates,
-  hasBabelConfigCandidates,
-  getBabelConfigCandidates,
   hasJSConfigCandidates,
-  getJSConfigCandidates,
   hasTSConfigCandidates,
+  hasTestsWithinSource,
+  toSourceLocationArray,
+  getJSConfigCandidates,
   getTSConfigCandidates,
+  hasBabelConfigCandidates,
+  getBabelConfigCandidates,
   hasWebpackConfigCandidates,
   getWebpackConfigCandidates,
-  getMonoRepoPackagesCandidates,
-  hasTestsWithinSource,
-  isLikelyMonoRepo,
-  toSourceLocationArray,
 } = require("./environment-helpers");
 const { validateLocation } = require("./inquirer-validators");
 
-const INQUIRER_QUESTIONS = [
+function toPromptChoice(pString) {
+  return {
+    title: pString,
+    value: pString,
+  };
+}
+
+/** @type {import('@types/prompts').PromptObject[]} */
+const QUESTIONS = [
   {
     name: "isMonoRepo",
-    type: "confirm",
-    message: "This looks like a mono repo. Is that correct?",
-    default: isLikelyMonoRepo(),
-    when: () => isLikelyMonoRepo(),
+    type: () => (isLikelyMonoRepo() ? "confirm" : false),
+    message: "This looks like mono repo. Is that correct?",
+    initial: isLikelyMonoRepo(),
   },
   {
     name: "sourceLocation",
-    type: "input",
+    type: (_, pAnswers) => (pAnswers.isMonoRepo ? "text" : false),
     message: "Mono repo it is! Where do your packages live?",
-    default: getMonoRepoPackagesCandidates(),
+    initial: getMonoRepoPackagesCandidates(),
     validate: validateLocation,
-    when: (pAnswers) => pAnswers.isMonoRepo,
   },
   {
     name: "combinedDependencies",
-    type: "confirm",
+    type: (_, pAnswers) => (pAnswers.isMonoRepo ? "confirm" : false),
     message:
       "Do your packages use dependencies declared in the root of your repo?",
-    default: false,
-    when: (pAnswers) => pAnswers.isMonoRepo,
+    initial: false,
   },
   {
     name: "sourceLocation",
-    type: "input",
+    type: (_, pAnswers) => (pAnswers.isMonoRepo ? false : "text"),
     message: "Where do your source files live?",
-    default: getSourceFolderCandidates(),
+    initial: getSourceFolderCandidates(),
     validate: validateLocation,
-    when: (pAnswers) => !pAnswers.isMonoRepo,
   },
   {
     name: "hasTestsOutsideSource",
-    type: "confirm",
+    type: (_, pAnswers) => (pAnswers.isMonoRepo ? false : "confirm"),
     message: "Do your test files live in a separate folder?",
-    default: (pAnswers) => {
+    initial: (_, pAnswers) => {
       return !hasTestsWithinSource(
         getTestFolderCandidates(),
         toSourceLocationArray(pAnswers.sourceLocation)
       );
     },
-    when: (pAnswers) => !pAnswers.isMonoRepo,
   },
   {
     name: "testLocation",
-    type: "input",
+    type: (_, pAnswers) =>
+      pAnswers.hasTestsOutsideSource && !pAnswers.isMonoRepo ? "text" : false,
     message: "Where do your test files live?",
-    default: getTestFolderCandidates(),
+    initial: getTestFolderCandidates(),
     validate: validateLocation,
-    when: (pAnswers) => pAnswers.hasTestsOutsideSource && !pAnswers.isMonoRepo,
   },
   {
     name: "useJsConfig",
-    type: "confirm",
+    type: () =>
+      hasJSConfigCandidates() && !hasTSConfigCandidates() ? "confirm" : false,
     message: "Looks like you're using a 'jsconfig.json'. Use that?",
-    default: true,
-    when: () => hasJSConfigCandidates() && !hasTSConfigCandidates(),
+    initial: true,
   },
   {
     name: "jsConfig",
-    type: "list",
-    message: "Full path to your 'jsconfig.json':",
-    choices: getJSConfigCandidates(),
-    when: (pAnswers) => pAnswers.useJsConfig,
+    type: (_, pAnswers) => (pAnswers.useJsConfig ? "select" : false),
+    message: "Full path to your 'jsconfig.json",
+    choices: getJSConfigCandidates().map((pCandidate) => ({
+      title: pCandidate,
+      value: pCandidate,
+    })),
   },
   {
     name: "useTsConfig",
-    type: "confirm",
-    message: "Looks like you're using TypeScript. Use a 'tsconfig.json'?",
-    default: true,
-    when: () => hasTSConfigCandidates(),
+    type: () => (hasTSConfigCandidates() ? "confirm" : false),
+    message: "Looks like you're using a 'tsconfig.json'. Use that?",
+    initial: true,
   },
   {
     name: "tsConfig",
-    type: "list",
-    message: "Full path to your 'tsconfig.json':",
-    choices: getTSConfigCandidates(),
-    when: (pAnswers) => pAnswers.useTsConfig,
+    type: (_, pAnswers) => (pAnswers.useTsConfig ? "select" : false),
+    message: "Full path to your 'tsconfig.json",
+    choices: getTSConfigCandidates().map(toPromptChoice),
   },
   {
     name: "tsPreCompilationDeps",
-    type: "confirm",
+    type: (_, pAnswers) => (pAnswers.useTsConfig ? "confirm" : false),
     message:
       "Also regard TypeScript dependencies that exist only before compilation?",
-    when: (pAnswers) => pAnswers.useTsConfig,
+    initial: true,
   },
   {
     name: "useBabelConfig",
-    type: "confirm",
+    type: () => (hasBabelConfigCandidates() ? "confirm" : false),
     message: "Looks like you're using Babel. Use a babel config?",
-    default: true,
-    when: () => hasBabelConfigCandidates(),
+    initial: true,
   },
   {
     name: "babelConfig",
-    type: "list",
+    type: (_, pAnswers) => (pAnswers.useBabelConfig ? "select" : false),
     message: "Full path to your babel config:",
-    choices: getBabelConfigCandidates(),
-    when: (pAnswers) => pAnswers.useBabelConfig,
+    choices: getBabelConfigCandidates().map(toPromptChoice),
   },
   {
-    name: "useWebpackConfig",
-    type: "confirm",
+    name: "useWebPackConfig",
+    type: () => (hasWebpackConfigCandidates() ? "confirm" : false),
     message: "Looks like you're using webpack - specify a webpack config?",
-    default: true,
-    when: () => hasWebpackConfigCandidates(),
+    initial: true,
   },
   {
     name: "webpackConfig",
-    type: "list",
+    type: (_, pAnswers) => (pAnswers.useWebpackConfig ? "select" : false),
     message: "Full path to your webpack config:",
-    choices: getWebpackConfigCandidates(),
-    when: (pAnswers) => pAnswers.useWebpackConfig,
+    choices: getWebpackConfigCandidates().map(toPromptChoice),
   },
 ];
+
 /**
  * @return {Promise<import("../../../types/init-config").IPartialInitConfig>}
  */
 module.exports = function getUserInput() {
-  return inquirer.prompt(INQUIRER_QUESTIONS);
+  return prompts(QUESTIONS);
 };

package/src/config-utl/extract-webpack-resolve-config.js

@@ -1,3 +1,4 @@
+const { extname } = require("path");
 const makeAbsolute = require("./make-absolute");
 
 function pryConfigFromTheConfig(
@@ -22,6 +23,52 @@ function pryConfigFromTheConfig(
   return lReturnValue;
 }
 
+function suggestModules(pSuggestionList, pWebpackConfigFilename) {
+  let lReturnValue = "";
+  let lSuggestionList = pSuggestionList;
+
+  if (pSuggestionList && typeof pSuggestionList === "string") {
+    lSuggestionList = [pSuggestionList];
+  }
+
+  if (Array.isArray(lSuggestionList) && lSuggestionList.length > 0) {
+    lReturnValue = lSuggestionList.reduce(
+      (pAll, pCurrent) =>
+        (pAll += `         - ${pCurrent.module || pCurrent}\n`),
+      `\n         Some npm modules that might fix that problem (one of which you'll` +
+        `\n         need so '${pWebpackConfigFilename}' works with webpack anyway):\n`
+    );
+  }
+  return lReturnValue;
+}
+
+function tryRegisterNonNative(pWebpackConfigFilename) {
+  const lConfigExtension = extname(pWebpackConfigFilename);
+
+  if (lConfigExtension === ".mjs") {
+    throw new Error(
+      `dependency-cruiser currently does not support webpack configurations in` +
+        `\n         ES Module format (like '${pWebpackConfigFilename}').\n`
+    );
+  }
+
+  const interpret = require("interpret");
+  const rechoir = require("rechoir");
+
+  try {
+    rechoir.prepare(interpret.extensions, pWebpackConfigFilename);
+  } catch (pError) {
+    throw new Error(
+      `${pError.message}` +
+        `\n${suggestModules(
+          // eslint-disable-next-line security/detect-object-injection
+          interpret.extensions[lConfigExtension],
+          pWebpackConfigFilename
+        )}`
+    );
+  }
+}
+
 /**
  * Reads the file with name `pWebpackConfigFilename` and (applying the
  * environment `pEnvironment` and the arguments `pArguments` (which can
@@ -35,16 +82,23 @@ function pryConfigFromTheConfig(
  * @throws {Error} when the webpack config isn't usable (e.g. because it
  *                 doesn't exist, or because it's invalid)
  */
+// eslint-disable-next-line max-lines-per-function, complexity
 module.exports = function extractWebpackResolveConfig(
   pWebpackConfigFilename,
   pEnvironment,
   pArguments
 ) {
   let lReturnValue = {};
+  const lNativelySupportedExtensions = [".js", ".cjs", ".json", ".node"];
+  const lWebpackConfigFilename = makeAbsolute(pWebpackConfigFilename);
+
+  if (!lNativelySupportedExtensions.includes(extname(pWebpackConfigFilename))) {
+    tryRegisterNonNative(pWebpackConfigFilename);
+  }
 
   try {
     /* eslint node/global-require:0, security/detect-non-literal-require:0, import/no-dynamic-require:0 */
-    const lWebpackConfigModule = require(makeAbsolute(pWebpackConfigFilename));
+    const lWebpackConfigModule = require(lWebpackConfigFilename);
     const lWebpackConfig = pryConfigFromTheConfig(
       lWebpackConfigModule,
       pEnvironment,

package/src/extract/transpile/meta.d.ts

@@ -7,7 +7,7 @@ export interface ITranspilerWrapper {
   ) => string;
 }
 
-export type getWrapper = (pExtension, pTranspileOptions) => ITranspilerWrapper;
+export function getWrapper(pExtension, pTranspileOptions): ITranspilerWrapper;
 
 export const scannableExtensions: string[];
 
@@ -19,4 +19,4 @@ export interface IAvailableTranspiler {
   available: boolean;
 }
 
-export type getAvailableTranspilers = () => IAvailableTranspiler[];
+export function getAvailableTranspilers(): IAvailableTranspiler[];

package/src/meta.js

@@ -1,7 +1,7 @@
 /* generated - don't edit */
 
 module.exports = {
-  version: "11.14.0",
+  version: "11.15.0-beta-2",
   engines: {
     node: "^12.20||^14||>=16",
   },

package/src/validate/index.d.ts

@@ -34,27 +34,27 @@ export interface IValidationResult {
  * Validates the pModule module against the given
  * ruleset pRuleSet
  */
-export type module = (
+export function module(
   pRuleSet: IFlattenedRuleSet,
   pModule: IModule
-) => IValidationResult;
+): IValidationResult;
 
 /**
  * Validates the pFrom and pTo dependency pair against the given
  * ruleset pRuleSet
  */
-export type dependency = (
+export function dependency(
   pRuleSet: IFlattenedRuleSet,
   pFrom: IModule,
   pTo: IDependency
-) => IValidationResult;
+): IValidationResult;
 
 /**
  * Validates the pFrom and pTo dependency pair against the given
  * ruleset pRuleSet
  */
-export type folder = (
+export function folder(
   pRuleSet: IFlattenedRuleSet,
   pFromFolder: IFolder,
   pToFolder: IFolderDependency
-) => IValidationResult;
+): IValidationResult;

package/types/dependency-cruiser.d.ts

@@ -73,12 +73,12 @@ export interface IReporterOutput {
  *                        before calling make sure to flatten them out if you want them
  *                        used (e.g. with 'dependency-cruiser/config-utl/extract-ts-config')
  */
-export type cruise = (
+export function cruise(
   pFileAndDirectoryArray: string[],
   pCruiseOptions?: ICruiseOptions,
   pResolveOptions?: IResolveOptions,
   pTSConfig?: any
-) => IReporterOutput;
+): IReporterOutput;
 
 export interface ITranspileOptions {
   /**
@@ -113,12 +113,12 @@ export interface ITranspileOptions {
  * @param pTranspileOptions Object to hold options to pass to underlying transpilers
  *                        like TypeScript or Babel
  */
-export type futureCruise = (
+export function futureCruise(
   pFileAndDirectoryArray: string[],
   pCruiseOptions?: ICruiseOptions,
   pResolveOptions?: IResolveOptions,
   pTranspileOptions?: ITranspileOptions
-) => IReporterOutput;
+): IReporterOutput;
 
 /**
  * Given a cruise result, formats it with the given reporter (pOutputType)
@@ -127,10 +127,10 @@ export type futureCruise = (
  *                    to the [dependency-cruiser results schema](https://github.com/sverweij/dependency-cruiser/blob/develop/src/schema/cruise-result.json)
  * @param pOutputType Which reporter to use to format the cruise result with
  */
-export type format = (
+export function format(
   pResult: ICruiseResult,
   pFormatOptions: IFormatOptions
-) => IReporterOutput;
+): IReporterOutput;
 
 /**
  * Returns an array of supported transpilers and for each of the transpilers
@@ -138,4 +138,4 @@ export type format = (
  * - the supported version range (semver version range)
  * - whether or not the transpiler is available in the current environment
  */
-export type getAvailableTranspilers = () => IAvailableTranspiler[];
+export function getAvailableTranspilers(): IAvailableTranspiler[];