@release-it/keep-a-changelog 2.5.0 → 3.1.0

package/index.js

@@ -1,8 +1,8 @@
-const { Plugin } = require('release-it');
-const fs = require('fs');
-const path = require('path');
-const detectNewline = require('detect-newline');
-var format = require('string-template');
+import { Plugin } from 'release-it';
+import fs from 'fs';
+import path from 'path';
+import { detectNewline } from 'detect-newline';
+import format from 'string-template';
 
 const pad = num => ('0' + num).slice(-2);
 
@@ -53,37 +53,48 @@ 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;
 
     const { filename, strictLatest } = this;
-
     const previousReleaseTitle = strictLatest ? `## [${latestVersion}]` : `## [`;
     const hasPreviousReleaseSection = this.changelogContent.includes(previousReleaseTitle);
-
     if (strictLatest && !hasPreviousReleaseSection) {
       throw Error(`Missing section for previous release ("${latestVersion}") in ${filename}.`);
     }
 
-    const startIndex = this.changelogContent.indexOf(this.unreleasedTitle) + this.unreleasedTitle.length;
-    let endIndex = this.changelogContent.indexOf(previousReleaseTitle, startIndex);
-    if (!strictLatest && endIndex === -1) {
-      endIndex = this.changelogContent.length;
+    const { isIncrement } = this.config;
+    const titleToFind = isIncrement ? this.unreleasedTitleRaw : latestVersion;
+    const changelogContent = this.getChangelogEntryContent(titleToFind);
+
+    this.setContext({ changelog: changelogContent });
+    return changelogContent;
+  }
+
+  getChangelogEntryContent(releaseTitleRaw) {
+    const { filename, changelogContent, EOL } = this;
+
+    const releaseTitleMarkdown = `## [${releaseTitleRaw}]`;
+    const previousReleaseTitle = `## [`;
+
+    const indexOfReleaseTitle = changelogContent.indexOf(releaseTitleMarkdown);
+
+    if (indexOfReleaseTitle === -1) {
+      throw Error(`Missing section for previous release ("${releaseTitleRaw}") in ${filename}.`);
+    }
+
+    const entryContentStartIndex = changelogContent.indexOf(EOL, indexOfReleaseTitle);
+    let entryContentEndIndex = changelogContent.indexOf(previousReleaseTitle, entryContentStartIndex);
+    if (entryContentEndIndex === -1) {
+      entryContentEndIndex = changelogContent.length;
     }
 
-    const changelogContent = this.changelogContent.substring(startIndex, endIndex).trim();
-    if (!changelogContent) {
-      throw Error(`There are no entries under "${this.unreleasedTitleRaw}" section in ${filename}.`);
+    const changelogEntryContent = changelogContent.substring(entryContentStartIndex, entryContentEndIndex).trim();
+    if (!changelogEntryContent) {
+      throw Error(`There are no entries under "${releaseTitleRaw}" section in ${filename}.`);
     }
 
-    this.setContext({ changelog: changelogContent });
-    return changelogContent;
+    return changelogEntryContent;
   }
 
   bump(version) {
@@ -107,7 +118,7 @@ class KeepAChangelog extends Plugin {
     }
 
     // Add a link for the first tagged version
-    if (!latestTag) {
+    if (!latestTag || latestTag === '0.0.0') {
       const firstVersionUrl = format(this.versionUrlFormats.firstVersionUrl, { repositoryUrl, tagName });
       const firstVersionLink = `[${version}]: ${firstVersionUrl}`;
       return `${updatedChangelog}${this.EOL}${firstVersionLink}`;
@@ -142,4 +153,4 @@ class KeepAChangelog extends Plugin {
   }
 }
 
-module.exports = KeepAChangelog;
+export default KeepAChangelog;

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@release-it/keep-a-changelog",
-  "version": "2.5.0",
+  "version": "3.1.0",
   "description": "Keep-a-changelog plugin for release-it",
-  "main": "index.js",
+  "type": "module",
+  "exports": "./index.js",
   "scripts": {
     "test": "bron test.js",
     "release": "release-it"
@@ -29,20 +30,20 @@
     "url": "https://webpro.nl"
   },
   "dependencies": {
-    "detect-newline": "^3.1.0",
+    "detect-newline": "^4.0.0",
     "string-template": "^1.0.0"
   },
   "devDependencies": {
-    "bron": "^1.1.1",
-    "mock-fs": "^5.0.0",
-    "release-it": "^14.13.1",
-    "sinon": "^11.1.1"
+    "bron": "^2.0.3",
+    "mock-fs": "^5.1.4",
+    "release-it": "^15.3.0",
+    "sinon": "^14.0.0"
   },
   "peerDependencies": {
-    "release-it": "^14.13.1"
+    "release-it": "^15.0.0-esm.4"
   },
   "engines": {
-    "node": ">=10"
+    "node": ">=14"
   },
   "release-it": {
     "github": {

package/test.js

@@ -1,10 +1,10 @@
-const fs = require('fs');
-const test = require('bron');
-const assert = require('assert').strict;
-const mock = require('mock-fs');
-const sinon = require('sinon');
-const { factory, runTasks } = require('release-it/test/util');
-const Plugin = require('.');
+import { strict as assert } from 'assert';
+import test from 'bron';
+import fs from 'fs';
+import mock from 'mock-fs';
+import { factory, runTasks } from 'release-it/test/util/index.js';
+import sinon from 'sinon';
+import Plugin from './index.js';
 
 const initialDryRunFileContents =
   '\n\n## [Unreleased]\n\n* Item A\n* Item B\n\n## [1.0.0] - 2020-05-02\n\n* Item C\n* Item D';
@@ -56,11 +56,30 @@ 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 => {
+test('should throw for missing "unreleased" section when no-increment flag is set if changelog is misformatted', async t => {
+  const options = { increment: false, [namespace]: { filename: 'CHANGELOG-FOO.md' } };
+  const plugin = factory(Plugin, { namespace, options });
+  await assert.rejects(runTasks(plugin), /Missing "Unreleased" section in CHANGELOG-FOO.md/);
+});
+
+test('should throw for missing "1.0.0" section when no-increment flag is set', async t => {
+  const options = { increment: false, [namespace]: { filename: 'CHANGELOG-MISSING.md' } };
+  const plugin = factory(Plugin, { namespace, options });
+  await assert.rejects(runTasks(plugin), /Missing section for previous release \("1\.0\.0"\) in CHANGELOG-MISSING\.md/);
+});
+
+test('should find "1.0.0" section when no-increment flag is set when items under version', 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'));
+  assert.equal(plugin.getChangelog('1.0.0'), '* Item A\n* Item B');
+});
+
+test('should find "1.0.0" section when no-increment flag is set when items under unreleased and version', async t => {
+  const options = { increment: false, [namespace]: { filename: 'CHANGELOG-FULL.md' } };
+  const plugin = factory(Plugin, { namespace, options });
+  await runTasks(plugin);
+  assert.equal(plugin.getChangelog('1.0.0'), '* Item C\n* Item D');
 });
 
 test('should throw for missing section for previous release', async t => {
@@ -263,6 +282,6 @@ test('should add links to the end of a new changelog', async t => {
   assert.equal(plugin.getChangelog(), '* Item A\n* Item B');
   assert.match(
     readFile('./CHANGELOG-VERSION_URL_NEW.md'),
-    /^## \[1\.0\.0] - [0-9]{4}-[0-9]{2}-[0-9]{2}\n\n\* Item A\n\* Item B\n\n\[unreleased]: https:\/\/github\.com\/user\/project\/compare\/1\.0\.0\.\.\.HEAD\n\[1.0.0]: https:\/\/github\.com\/user\/project\/releases\/tag\/1\.0\.0\n$/
+    /^## \[1\.0\.0] - [0-9]{4}-[0-9]{2}-[0-9]{2}\n\n\* Item A\n\* Item B\n\n\[unreleased]: https:\/\/github\.com\/user\/project\/compare\/1\.0\.0\.\.\.HEAD\n\[1\.0\.0]: https:\/\/github\.com\/user\/project\/releases\/tag\/1\.0\.0\n$/
   );
 });