feat(commitlint): move .commitlintrc.js to package.json (#277)

BREAKING CHANGE: remove `.commitlintrc.js` file
ybiquitous · Nov 18, 2018 · 0884342 · 0884342
1 parent c8796fb
commit 0884342
Show file tree

Hide file tree

Showing 8 changed files with 12 additions and 20 deletions.
diff --git a/lib/init.js b/lib/init.js
@@ -61,6 +61,9 @@ class Init {
       }
       Object.assign(packageInfo[key], originalPackage[key]);
     });
+    packageInfo.commitlint = {
+      extends: ["@commitlint/config-conventional"],
+    };
 
     await this.writeFile("package.json", JSON.stringify(packageInfo, null, 2));
   }
@@ -85,11 +88,9 @@ module.exports = async function init({
   await cmd.writePackageFile(".editorconfig");
   await cmd.writePackageFile(".markdownlint.json");
   await cmd.writeTemplateFile(".eslintrc.js");
-  await cmd.writeTemplateFile(".commitlintrc.js");
 };
 
 module.exports.desc = `Setup npm project:
 - Update 'package.json'
-- Create '.commitlintrc.js'
 - Create '.editorconfig'
 - Create '.eslintrc.js'`;
diff --git a/templates/.commitlintrc.js b/templates/.commitlintrc.js
diff --git a/test/fixtures/.commitlintrc_expected.js b/test/fixtures/.commitlintrc_expected.js
diff --git a/test/fixtures/package-empty_expected.json b/test/fixtures/package-empty_expected.json
@@ -28,5 +28,8 @@
     "scripts": {
       "postchangelog": "prettier --write CHANGELOG.md"
     }
+  },
+  "commitlint": {
+    "extends": ["@commitlint/config-conventional"]
   }
 }
diff --git a/test/fixtures/package-normal.json b/test/fixtures/package-normal.json
@@ -5,5 +5,8 @@
   },
   "lint-staged": {
     "*.css": "xyz"
+  },
+  "commitlint": {
+    "extends": []
   }
 }
diff --git a/test/fixtures/package-normal_expected.json b/test/fixtures/package-normal_expected.json
@@ -29,5 +29,8 @@
     "scripts": {
       "postchangelog": "prettier --write CHANGELOG.md"
     }
+  },
+  "commitlint": {
+    "extends": ["@commitlint/config-conventional"]
   }
 }
diff --git a/test/help.test.js b/test/help.test.js
@@ -7,7 +7,6 @@ cli.js <command>
 Commands:
   cli.js init  Setup npm project:
                - Update 'package.json'
-               - Create '.commitlintrc.js'
                - Create '.editorconfig'
                - Create '.eslintrc.js'
 

diff --git a/test/init.test.js b/test/init.test.js
@@ -90,17 +90,6 @@ test("init", t => {
     t.end();
   });
 
-  testInSandbox('write ".commitlintrc.js"', async (t, ctx) => {
-    await ctx.fixture("package-normal.json");
-    await init(ctx.initArgs);
-    t.ok(ctx.logMessage().includes(".commitlintrc.js was updated."));
-
-    const actual = await ctx.readWorkFile(".commitlintrc.js");
-    const expected = await ctx.readFixture(".commitlintrc_expected.js");
-    t.is(actual, expected);
-    t.end();
-  });
-
   testInSandbox("throw error if no package.json", async (t, ctx) => {
     const error = await init(ctx.initArgs).catch(err => err);
     t.ok(error instanceof Error);