feat(prettier): format CHANGELOG.md (#274)

BREAKING CHANGE: remove `.prettierignore` file
ybiquitous · Nov 18, 2018 · be9a697 · be9a697
1 parent a89ba5d
commit be9a697
Show file tree

Hide file tree

Showing 6 changed files with 23 additions and 15 deletions.
diff --git a/.prettierignore b/.prettierignore
diff --git a/lib/init.js b/lib/init.js
@@ -54,7 +54,7 @@ class Init {
       });
 
     // update other keys
-    const keys = ["husky", "lint-staged"];
+    const keys = ["husky", "lint-staged", "standard-version"];
     keys.forEach(key => {
       if (!(key in packageInfo)) {
         packageInfo[key] = {};
@@ -83,7 +83,6 @@ module.exports = async function init({
   const cmd = new Init(cwd, logger);
   await cmd.updatePackageFile();
   await cmd.writePackageFile(".editorconfig");
-  await cmd.writePackageFile(".prettierignore");
   await cmd.writePackageFile(".markdownlint.json");
   await cmd.writeTemplateFile(".eslintrc.js");
   await cmd.writeTemplateFile(".commitlintrc.js");

diff --git a/package.json b/package.json
@@ -69,20 +69,22 @@
         "git add"
       ],
       "*.md": [
-        "markdownlint"
+        "markdownlint --ignore CHANGELOG.md"
       ],
       "*.{html,json,md,yaml,yml}": [
         "prettier --write",
         "git add"
       ]
-    },
-    "ignore": [
-      "CHANGELOG.md"
-    ]
+    }
   },
   "prettier": {
     "trailingComma": "es5"
   },
+  "standard-version": {
+    "scripts": {
+      "postchangelog": "prettier --write CHANGELOG.md"
+    }
+  },
   "browserslist": [
     "> 1%",
     "not ie 11",

diff --git a/test/fixtures/package-empty_expected.json b/test/fixtures/package-empty_expected.json
@@ -20,9 +20,13 @@
   "lint-staged": {
     "linters": {
       "*.{js,jsx,mjs}": ["eslint --fix --no-ignore", "git add"],
-      "*.md": ["markdownlint"],
+      "*.md": ["markdownlint --ignore CHANGELOG.md"],
       "*.{html,json,md,yaml,yml}": ["prettier --write", "git add"]
-    },
-    "ignore": ["CHANGELOG.md"]
+    }
+  },
+  "standard-version": {
+    "scripts": {
+      "postchangelog": "prettier --write CHANGELOG.md"
+    }
   }
 }
diff --git a/test/fixtures/package-normal_expected.json b/test/fixtures/package-normal_expected.json
@@ -21,9 +21,13 @@
     "*.css": "xyz",
     "linters": {
       "*.{js,jsx,mjs}": ["eslint --fix --no-ignore", "git add"],
-      "*.md": ["markdownlint"],
+      "*.md": ["markdownlint --ignore CHANGELOG.md"],
       "*.{html,json,md,yaml,yml}": ["prettier --write", "git add"]
-    },
-    "ignore": ["CHANGELOG.md"]
+    }
+  },
+  "standard-version": {
+    "scripts": {
+      "postchangelog": "prettier --write CHANGELOG.md"
+    }
   }
 }
diff --git a/test/init.test.js b/test/init.test.js
@@ -64,7 +64,7 @@ test("init", t => {
     t.end();
   });
 
-  [".editorconfig", ".prettierignore", ".markdownlint.json"].forEach(file => {
+  [".editorconfig", ".markdownlint.json"].forEach(file => {
     testInSandbox(`write "${file}"`, async (t, ctx) => {
       await ctx.fixture("package-normal.json");
       await init(ctx.initArgs);