Noviny/add prettier on changelog write (#61)

* run prettier on changelogs before writing them
changesets · Jun 1, 2019 · 7fa4264 · 7fa4264
1 parent 6dc510f
commit 7fa4264
Show file tree

Hide file tree

Showing 5 changed files with 36 additions and 5 deletions.
diff --git a/.changeset/cuddly-mails-change/changes.json b/.changeset/cuddly-mails-change/changes.json
@@ -0,0 +1,4 @@
+{
+  "releases": [{ "name": "@changesets/cli", "type": "patch" }],
+  "dependents": []
+}
diff --git a/.changeset/cuddly-mails-change/changes.md b/.changeset/cuddly-mails-change/changes.md
@@ -0,0 +1,3 @@
+When bumping, run prettier over the changelog file.
+
+If you want this option turned off, add `disabledLanguage: ["markdown"] to your prettier config.
diff --git a/...res__/simple-project-with-changelogs/packages/has-filled-changelog/CHANGELOG.md b/...res__/simple-project-with-changelogs/packages/has-filled-changelog/CHANGELOG.md
@@ -1,5 +1,6 @@
 # Has Empty Changelog
 
 ## 1.0.0
+
 - [patch] This existed before [b8bb699](https://bitbucket.org/atlassian/atlaskit-mk-2/commits/b8bb699)
 - [minor] This also existed before [abcdefg](https://bitbucket.org/atlassian/atlaskit-mk-2/commits/abcdefg)
diff --git a/packages/cli/src/utils/updateChangelog/__tests__/updateChangelog.test.js b/packages/cli/src/utils/updateChangelog/__tests__/updateChangelog.test.js
@@ -38,6 +38,7 @@ const noChangelogFileChangeset = {
 const filledChangelogContent = `# Has Empty Changelog
 
 ## 1.0.0
+
 - [patch] This existed before [b8bb699](https://bitbucket.org/atlassian/atlaskit-mk-2/commits/b8bb699)
 - [minor] This also existed before [abcdefg](https://bitbucket.org/atlassian/atlaskit-mk-2/commits/abcdefg)
 `;
@@ -134,6 +135,7 @@ describe("updateChangelog", () => {
     expect(updatedChangelog).toEqual(`# has-empty-changelog
 
 ## 1.1.0
+
 ### Minor Changes
 
 - b8bb699: This is a summary
@@ -148,6 +150,7 @@ describe("updateChangelog", () => {
     expect(updatedChangelog).toEqual(`# has-empty-changelog
 
 ## 1.1.0
+
 ### Minor Changes
 
 - abcdefg: This is a second summary
@@ -168,21 +171,26 @@ describe("updateChangelog", () => {
     const updatedExistingChangelog = fs
       .readFileSync(existingChangelogPath)
       .toString();
+
     expect(updatedChangelog).toEqual(`# has-empty-changelog
 
 ## 1.1.0
+
 ### Minor Changes
 
 - b8bb699: This is a summary
 `);
+
     expect(updatedExistingChangelog).toEqual(`# Has Empty Changelog
 
 ## 1.0.1
+
 ### Patch Changes
 
 - b8bb699: This is a summary
 
 ## 1.0.0
+
 - [patch] This existed before [b8bb699](https://bitbucket.org/atlassian/atlaskit-mk-2/commits/b8bb699)
 - [minor] This also existed before [abcdefg](https://bitbucket.org/atlassian/atlaskit-mk-2/commits/abcdefg)
 `);
@@ -224,11 +232,13 @@ describe("updateChangelog", () => {
     expect(updatedChangelog).toEqual(`# Has Empty Changelog
 
 ## 1.1.0
+
 ### Minor Changes
 
 - b8bb699: This is a summary
 
 ## 1.0.0
+
 - [patch] This existed before [b8bb699](https://bitbucket.org/atlassian/atlaskit-mk-2/commits/b8bb699)
 - [minor] This also existed before [abcdefg](https://bitbucket.org/atlassian/atlaskit-mk-2/commits/abcdefg)
 `);

diff --git a/packages/cli/src/utils/updateChangelog/index.js b/packages/cli/src/utils/updateChangelog/index.js
@@ -1,7 +1,8 @@
 import fs from "fs-extra";
-
 import path from "path";
 import util from "util";
+import prettier from "prettier";
+
 import generateMarkdownTemplate from "./template";
 import logger from "../logger";
 import * as bolt from "../bolt-replacements";
@@ -35,7 +36,7 @@ export default async function updateChangelog(releaseObject, opts) {
     const templateString = `\n\n${markdown.trim("\n")}\n`;
     try {
       if (fs.existsSync(changelogPath)) {
-        await prependFile(changelogPath, templateString, pkg);
+        await prependFile(changelogPath, templateString, pkg, cwd);
       } else {
         await writeFile(changelogPath, `# ${pkg.name}${templateString}`);
       }
@@ -49,14 +50,26 @@ export default async function updateChangelog(releaseObject, opts) {
   return udpatedChangelogs;
 }
 
-async function prependFile(filePath, data, pkg) {
+async function prependFile(filePath, data, pkg, cwd) {
+  const prettierConfig = await prettier.resolveConfig(cwd);
+
   const fileData = fs.readFileSync(filePath).toString();
   // if the file exists but doesn't have the header, we'll add it in
   if (!fileData) {
     const completelyNewChangelog = `# ${pkg.name}${data}`;
-    fs.writeFileSync(filePath, completelyNewChangelog);
+    fs.writeFileSync(
+      filePath,
+      prettier.format(completelyNewChangelog, {
+        ...prettierConfig,
+        parser: "markdown"
+      })
+    );
     return;
   }
   const newChangelog = fileData.replace("\n", data);
-  fs.writeFileSync(filePath, newChangelog);
+
+  fs.writeFileSync(
+    filePath,
+    prettier.format(newChangelog, { ...prettierConfig, parser: "markdown" })
+  );
 }