feat(commitlint): switched generated config file from js to json

to improve esm compatibility and simplify lifting

Author: travi

package-lock.json

@@ -57,6 +57,7 @@
     "provenance": true
   },
   "dependencies": {
+    "@form8ion/config-file": "^1.0.1",
     "@form8ion/core": "^2.0.0",
     "@form8ion/javascript-core": "^9.0.0",
     "deepmerge": "^4.2.2",

package.json

@@ -1,7 +1,10 @@
-import {promises as fsPromises} from 'fs';
+import {fileTypes} from '@form8ion/core';
+import * as configFile from '@form8ion/config-file';
+
 import any from '@travi/any';
 import {assert} from 'chai';
 import sinon from 'sinon';
+
 import scaffoldCommitlint from './commitlint';
 
 suite('commitlint scaffolder', () => {
@@ -10,7 +13,7 @@ suite('commitlint scaffolder', () => {
   setup(() => {
     sandbox = sinon.createSandbox();
 
-    sandbox.stub(fsPromises, 'writeFile');
+    sandbox.stub(configFile, 'write');
   });
 
   teardown(() => sandbox.restore());
@@ -25,9 +28,13 @@ suite('commitlint scaffolder', () => {
       {devDependencies: [configPackageName]}
     );
     assert.calledWith(
-      fsPromises.writeFile,
-      `${projectRoot}/.commitlintrc.js`,
-      `module.exports = {extends: ['${configName}']};`
+      configFile.write,
+      {
+        format: fileTypes.JSON,
+        name: 'commitlint',
+        config: {extends: [configName]},
+        path: projectRoot
+      }
     );
   });
 });

src/commitlint-test.js

@@ -1,7 +1,13 @@
-import {promises as fsPromises} from 'fs';
+import {fileTypes} from '@form8ion/core';
+import {write} from '@form8ion/config-file';
 
 export default async function ({config, projectRoot}) {
-  await fsPromises.writeFile(`${projectRoot}/.commitlintrc.js`, `module.exports = {extends: ['${config.name}']};`);
+  await write({
+    format: fileTypes.JSON,
+    name: 'commitlint',
+    path: projectRoot,
+    config: {extends: [config.name]}
+  });
 
   return {devDependencies: [config.packageName]};
 }

src/commitlint.js

@@ -1,5 +1,9 @@
 Feature: Scaffolder
 
+  Scenario: configure the convention
+    When the project is scaffolded
+    Then commitlint will be configured
+
   Scenario: project not on github actions
     When the project is scaffolded
 

test/integration/features/scaffolder.feature

@@ -1,12 +1,16 @@
 import {resolve} from 'path';
 import {dump} from 'js-yaml';
 
-import {After, When} from '@cucumber/cucumber';
+import {After, Before, When} from '@cucumber/cucumber';
 import stubbedFs from 'mock-fs';
 import any from '@travi/any';
 
 const stubbedNodeModules = stubbedFs.load(resolve(__dirname, '..', '..', '..', '..', 'node_modules'));
-const projectRoot = process.cwd();
+
+Before(function () {
+  this.projectRoot = process.cwd();
+  this.commilintConfigName = `@${any.word()}`;
+});
 
 After(function () {
   stubbedFs.restore();
@@ -18,7 +22,7 @@ When('the project is scaffolded', async function () {
 
   stubbedFs({node_modules: stubbedNodeModules});
 
-  await scaffold({projectRoot, configs: {}});
+  await scaffold({projectRoot: this.projectRoot, configs: {commitlint: {name: this.commilintConfigName}}});
 });
 
 When('the project is lifted', async function () {
@@ -86,7 +90,7 @@ When('the project is lifted', async function () {
     })
   });
 
-  if (await test({projectRoot})) {
-    await lift({projectRoot});
+  if (await test({projectRoot: this.projectRoot})) {
+    await lift({projectRoot: this.projectRoot});
   }
 });

test/integration/features/step_definitions/common-steps.js

@@ -0,0 +1,11 @@
+import {promises as fs} from 'node:fs';
+
+import {When} from '@cucumber/cucumber';
+import {assert} from 'chai';
+
+When('commitlint will be configured', async function () {
+  assert.equal(
+    await fs.readFile(`${this.projectRoot}/.commitlintrc.json`, 'utf-8'),
+    JSON.stringify({extends: [this.commilintConfigName]}, null, 2)
+  );
+});