feature(init): write to .dependency-cruiser.cjs when package type equ…

…als module (sverweij#479)

doc/faq.md

@@ -224,6 +224,8 @@ and ✖'s in the output should be a thing of the past.
 
 **A**: Rename your .dependency-cruiser.js to .dependency-cruiser.cjs
 
+> As of version 10.1.0 the `--init` generator automatically does this for you.
+
 ## Features
 
 ### Q: How do I enable TypeScript, CoffeeScript or LiveScript in dependency-cruiser?
@@ -410,6 +412,8 @@ module.exports = {
 };
 ```
 
+> Newer versions of the `--init` generator automatically do this for you.
+
 ## Expanding dependency-cruiser
 
 ### Q: How do I add a new output format?

src/cli/init-config/environment-helpers.js

@@ -1,6 +1,8 @@
 const fs = require("fs");
 const path = require("path");
 const _has = require("lodash/has");
+const _get = require("lodash/get");
+const { DEFAULT_CONFIG_FILE_NAME } = require("../defaults");
 
 const LIKELY_SOURCE_FOLDERS = ["src", "lib", "app", "bin", "sources"];
 const LIKELY_TEST_FOLDERS = ["test", "spec", "tests", "specs", "bdd"];
@@ -45,6 +47,18 @@ function babelIsConfiguredInManifest() {
   return lReturnValue;
 }
 
+function isTypeModule() {
+  let lReturnValue = false;
+
+  try {
+    lReturnValue = _get(readManifest(), "type", "commonjs") === "module";
+  } catch (pError) {
+    // silently ignore - we'll return false anyway then
+  }
+
+  return lReturnValue;
+}
+
 function getFolderNames(pFolderName) {
   return fs
     .readdirSync(pFolderName, "utf8")
@@ -117,12 +131,16 @@ const getTestFolderCandidates = getFolderCandidates(LIKELY_TEST_FOLDERS);
 const getMonoRepoPackagesCandidates = getFolderCandidates(
   LIKELY_PACKAGES_FOLDERS
 );
+function getDefaultConfigFileName() {
+  return isTypeModule() ? ".dependency-cruiser.cjs" : DEFAULT_CONFIG_FILE_NAME;
+}
 
 module.exports = {
   readManifest,
   fileExists,
   toSourceLocationArray,
   isLikelyMonoRepo,
+  isTypeModule,
   hasTestsWithinSource,
   getFolderCandidates,
   getBabelConfigCandidates,
@@ -134,4 +152,5 @@ module.exports = {
   getSourceFolderCandidates,
   getTestFolderCandidates,
   getMonoRepoPackagesCandidates,
+  getDefaultConfigFileName,
 };

src/cli/init-config/index.js

@@ -12,6 +12,7 @@ const {
   getWebpackConfigCandidates,
   hasTSConfigCandidates,
   getTSConfigCandidates,
+  getDefaultConfigFileName,
 } = require("./environment-helpers");
 const {
   writeRunScriptsToManifest,
@@ -80,7 +81,7 @@ module.exports = (pInit) => {
     /* c8 ignore stop */
   } else {
     const lNormalizedInitConfig = normalizeInitOptions(getOneshotConfig(pInit));
-    if (!fileExists($defaults.DEFAULT_CONFIG_FILE_NAME)) {
+    if (!fileExists(getDefaultConfigFileName())) {
       writeConfig(buildConfig(lNormalizedInitConfig));
     }
 

src/cli/init-config/write-config.js

@@ -1,8 +1,10 @@
 const fs = require("fs");
 const figures = require("figures");
 const chalk = require("chalk");
-const { DEFAULT_CONFIG_FILE_NAME } = require("../defaults");
-const { fileExists } = require("./environment-helpers");
+const {
+  fileExists,
+  getDefaultConfigFileName,
+} = require("./environment-helpers");
 
 /**
  * Write a .dependency-cruiser config to the current directory
@@ -18,7 +20,7 @@ const { fileExists } = require("./environment-helpers");
  */
 module.exports = function writeConfig(
   pConfig,
-  pFileName = DEFAULT_CONFIG_FILE_NAME
+  pFileName = getDefaultConfigFileName()
 ) {
   if (fileExists(pFileName)) {
     throw new Error(`A '${pFileName}' already exists here - leaving it be.\n`);

test/cli/init-config/environment-helpers-matching-filenames.spec.mjs

@@ -180,3 +180,57 @@ describe("cli/init-config/environment-helpers - hasWebpackConfigCandidates", ()
     expect(helpers.hasWebpackConfigCandidates()).to.equal(false);
   });
 });
+
+describe("cli/init-config/environment-helpers - isTypeModule", () => {
+  const WORKINGDIR = process.cwd();
+  afterEach("tear down", () => {
+    process.chdir(WORKINGDIR);
+  });
+  it("Returns false when there is no manifest", () => {
+    process.chdir("test/cli/init-config/fixtures/is-type-module-empty");
+    expect(helpers.isTypeModule()).to.equal(false);
+  });
+  it("Returns false when there's no type in the manifest", () => {
+    process.chdir("test/cli/init-config/fixtures/is-type-module-not-present");
+    expect(helpers.isTypeModule()).to.equal(false);
+  });
+  it("Returns false when the type in the manifest equals commonjs", () => {
+    process.chdir("test/cli/init-config/fixtures/is-type-module-commonjs");
+    expect(helpers.isTypeModule()).to.equal(false);
+  });
+  it("Returns true when the type in the manifest equals module", () => {
+    process.chdir("test/cli/init-config/fixtures/is-type-module");
+    expect(helpers.isTypeModule()).to.equal(true);
+  });
+});
+
+describe("cli/init-config/environment-helpers - getDefaultConfigFileName", () => {
+  const WORKINGDIR = process.cwd();
+  afterEach("tear down", () => {
+    process.chdir(WORKINGDIR);
+  });
+  it("Returns false when there is no manifest", () => {
+    process.chdir("test/cli/init-config/fixtures/is-type-module-empty");
+    expect(helpers.getDefaultConfigFileName()).to.equal(
+      ".dependency-cruiser.js"
+    );
+  });
+  it("Returns false when there's no type in the manifest", () => {
+    process.chdir("test/cli/init-config/fixtures/is-type-module-not-present");
+    expect(helpers.getDefaultConfigFileName()).to.equal(
+      ".dependency-cruiser.js"
+    );
+  });
+  it("Returns false when the type in the manifest equals commonjs", () => {
+    process.chdir("test/cli/init-config/fixtures/is-type-module-commonjs");
+    expect(helpers.getDefaultConfigFileName()).to.equal(
+      ".dependency-cruiser.js"
+    );
+  });
+  it("Returns true when the type in the manifest equals module", () => {
+    process.chdir("test/cli/init-config/fixtures/is-type-module");
+    expect(helpers.getDefaultConfigFileName()).to.equal(
+      ".dependency-cruiser.cjs"
+    );
+  });
+});

test/cli/init-config/fixtures/is-type-module-commonjs/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

test/cli/init-config/fixtures/is-type-module-not-present/package.json

@@ -0,0 +1 @@
+{}

test/cli/init-config/fixtures/is-type-module/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}