@release-it/keep-a-changelog 2.3.0 → 2.4.0

package/index.js

@@ -20,7 +20,7 @@ class KeepAChangelog extends Plugin {
     this.addUnreleased = addUnreleased === undefined ? false : Boolean(addUnreleased);
     this.keepUnreleased = keepUnreleased === undefined ? false : Boolean(keepUnreleased);
     this.addVersionUrl = addVersionUrl === undefined ? false : Boolean(addVersionUrl);
-    this.head = head || 'HEAD'
+    this.head = head || 'HEAD';
 
     this.changelogPath = path.resolve(this.filename);
     this.changelogContent = fs.readFileSync(this.changelogPath, 'utf-8');
@@ -35,6 +35,12 @@ class KeepAChangelog extends Plugin {
   }
 
   getChangelog(latestVersion) {
+    const { isIncrement } = this.config;
+    // Return the unchanged changelog content when no increment is made
+    if (!isIncrement) {
+      return this.changelogContent;
+    }
+
     const { changelog } = this.getContext();
     if (changelog) return changelog;
 
@@ -75,8 +81,9 @@ class KeepAChangelog extends Plugin {
     // Add or update the Unreleased link
     const unreleasedUrl = `${repositoryUrl}/compare/${tagName}...${this.head}`;
     const unreleasedLink = `[Unreleased]: ${unreleasedUrl}`;
-    if (updatedChangelog.includes('[Unreleased]:')) {
-      updatedChangelog = updatedChangelog.replace(new RegExp('\\[Unreleased\\]\\:.*' + this.head), unreleasedLink);
+    const hasUnreleasedLink = /^\[(Unreleased)\]\: .*$/im;
+    if (hasUnreleasedLink.test(updatedChangelog)) {
+      updatedChangelog = updatedChangelog.replace(hasUnreleasedLink, '[$1]: ' + unreleasedUrl);
     } else {
       updatedChangelog = `${updatedChangelog}${this.EOL}${this.EOL}${unreleasedLink}`;
     }
@@ -94,8 +101,8 @@ class KeepAChangelog extends Plugin {
 
   beforeRelease() {
     const { addUnreleased, keepUnreleased, addVersionUrl } = this;
-    const { isDryRun } = this.config;
-    if (isDryRun || keepUnreleased) return;
+    const { isDryRun, isIncrement } = this.config;
+    if (isDryRun || keepUnreleased || !isIncrement) return;
     const { version } = this.getContext();
     const formattedDate = getFormattedDate();
     const unreleasedTitle = addUnreleased ? this.unreleasedTitle + this.EOL + this.EOL : '';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@release-it/keep-a-changelog",
-  "version": "2.3.0",
+  "version": "2.4.0",
   "description": "Keep-a-changelog plugin for release-it",
   "main": "index.js",
   "scripts": {

package/test.js

@@ -23,8 +23,8 @@ mock({
   './CHANGELOG-UNRELEASED.md': '## [Unreleased]\n\n* Item A\n* Item B\n\n## [1.0.0] - 2020-05-02\n\n* Item C\n* Item D',
   './CHANGELOG-VERSION_URL.md':
     '## [Unreleased]\n\n* Item A\n* Item B\n\n## [1.0.0] - 2020-05-02\n\n* Item C\n* Item D\n\n[Unreleased]: https://github.com/release-it/release-it/compare/1.0.0..HEAD\n[1.0.0]: https://github.com/release-it/release-it/compare/0.0.0...1.0.0',
-    './CHANGELOG-VERSION_URL_HEAD.md':
-      '## [Unreleased]\n\n* Item A\n* Item B\n\n## [1.0.0] - 2020-05-02\n\n* Item C\n* Item D\n\n[Unreleased]: https://github.com/release-it/release-it/compare/1.0.0..main\n[1.0.0]: https://github.com/release-it/release-it/compare/0.0.0...1.0.0',
+  './CHANGELOG-VERSION_URL_HEAD.md':
+    '## [Unreleased]\n\n* Item A\n* Item B\n\n## [1.0.0] - 2020-05-02\n\n* Item C\n* Item D\n\n[Unreleased]: https://github.com/release-it/release-it/compare/1.0.0..main\n[1.0.0]: https://github.com/release-it/release-it/compare/0.0.0...1.0.0',
   './CHANGELOG-VERSION_URL_UNRELEASED.md':
     '## [Unreleased]\n\n* Item A\n* Item B\n\n## [1.0.0] - 2020-05-02\n\n* Item C\n* Item D\n\n[Unreleased]: https://github.com/user/project/compare/1.0.0..HEAD\n[1.0.0]: https://github.com/user/project/compare/0.0.0...1.0.0',
   './CHANGELOG-VERSION_URL_NEW.md': '## [Unreleased]\n\n* Item A\n* Item B'
@@ -52,6 +52,13 @@ test('should throw for empty "unreleased" section', async t => {
   await assert.rejects(runTasks(plugin), /There are no entries under "Unreleased" section in CHANGELOG-EMPTY\.md/);
 });
 
+test('should not throw for empty "unreleased" section when no-increment flag is set', async t => {
+  const options = { increment: false, [namespace]: { filename: 'CHANGELOG-EMPTY.md' } };
+  const plugin = factory(Plugin, { namespace, options });
+  await runTasks(plugin);
+  assert.equal(plugin.getChangelog(), readFile('./CHANGELOG-EMPTY.md'));
+});
+
 test('should throw for missing section for previous release', async t => {
   const options = { [namespace]: { filename: 'CHANGELOG-MISSING.md' } };
   const plugin = factory(Plugin, { namespace, options });

package/.prettierrc

@@ -1,7 +0,0 @@
-{
-  "printWidth": 120,
-  "singleQuote": true,
-  "proseWrap": "always",
-  "trailingComma": "none",
-  "arrowParens": "avoid"
-}