@release-it/keep-a-changelog 2.0.0 → 2.2.2

package/README.md

@@ -21,8 +21,10 @@ In [release-it](https://github.com/release-it/release-it) config:
 
 ## Options
 
-| option         | default value  | description                                                  |
-| -------------- | -------------- | ------------------------------------------------------------ |
-| filename       | `CHANGELOG.md` | File with changelogs.                                        |
+| option         | default value  | description                                                                                                                                      |
+| -------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
+| filename       | `CHANGELOG.md` | File with changelogs.                                                                                                                            |
 | strictLatest   | `true`         | Entry of latest version must be present in order to get correct changelog. Set this option to `false` if you expect latest version without logs. |
-| keepUnreleased | `false`        | It leaves "Unreleased" title row unchanged if set to `true`. |
+| addUnreleased  | `false`        | It leaves "Unreleased" title row if set to `true`.                                                                                               |
+| keepUnreleased | `false`        | It leaves "Unreleased" title row unchanged if set to `true`.                                                                                     |
+| addVersionUrl  | `false`        | Links the version to the according changeset.                                                                                                    |

package/index.js

@@ -11,18 +11,21 @@ const getFormattedDate = () => {
 };
 
 class KeepAChangelog extends Plugin {
-  init() {
-    const { filename, strictLatest, keepUnreleased } = this.options;
+  async init() {
+    await super.init();
+    const { filename, strictLatest, addUnreleased, keepUnreleased, addVersionUrl } = this.options;
 
     this.filename = filename || 'CHANGELOG.md';
     this.strictLatest = strictLatest === undefined ? true : Boolean(strictLatest);
+    this.addUnreleased = addUnreleased === undefined ? false : Boolean(addUnreleased);
     this.keepUnreleased = keepUnreleased === undefined ? false : Boolean(keepUnreleased);
+    this.addVersionUrl = addVersionUrl === undefined ? false : Boolean(addVersionUrl);
 
     this.changelogPath = path.resolve(this.filename);
     this.changelogContent = fs.readFileSync(this.changelogPath, 'utf-8');
     this.EOL = detectNewline(this.changelogContent);
     this.unreleasedTitleRaw = 'Unreleased';
-    this.unreleasedTitle = `${this.EOL}${this.EOL}## [${this.unreleasedTitleRaw}]${this.EOL}`;
+    this.unreleasedTitle = `## [${this.unreleasedTitleRaw}]`;
 
     const hasUnreleasedSection = this.changelogContent.includes(this.unreleasedTitle);
     if (!hasUnreleasedSection) {
@@ -62,15 +65,47 @@ class KeepAChangelog extends Plugin {
     this.setContext({ version });
   }
 
+  addVersionUrls(changelog) {
+    const { version, latestVersion, tagName, latestTag, repo } = this.config.getContext();
+    let updatedChangelog = changelog;
+
+    const repositoryUrl = `https://${repo.host}/${repo.repository}`;
+
+    // Add or update the Unreleased link
+    const unreleasedUrl = `${repositoryUrl}/compare/${tagName}...HEAD`;
+    const unreleasedLink = `[Unreleased]: ${unreleasedUrl}`;
+    if (updatedChangelog.includes('[Unreleased]:')) {
+      updatedChangelog = updatedChangelog.replace(/\[Unreleased\]\:.*HEAD/, unreleasedLink);
+    } else {
+      updatedChangelog = `${updatedChangelog}${this.EOL}${this.EOL}${unreleasedLink}`;
+    }
+
+    // Add a link for the new version
+    const latestVersionLink = `[${latestVersion}]:`;
+    const releaseUrl = `${repositoryUrl}/compare/${latestTag}...${tagName}`;
+    const releaseLink = `[${version}]: ${releaseUrl}`;
+    if (updatedChangelog.includes(latestVersionLink)) {
+      return updatedChangelog.replace(latestVersionLink, `${releaseLink}${this.EOL}${latestVersionLink}`);
+    } else {
+      return `${updatedChangelog}${this.EOL}${releaseLink}`;
+    }
+  }
+
   beforeRelease() {
-    const { keepUnreleased } = this;
+    const { addUnreleased, keepUnreleased, addVersionUrl } = this;
     const { isDryRun } = this.config;
     if (isDryRun || keepUnreleased) return;
     const { version } = this.getContext();
     const formattedDate = getFormattedDate();
-    const releaseTitle = `${this.EOL}${this.EOL}## [${version}] - ${formattedDate}${this.EOL}`;
-    const changelog = this.changelogContent.replace(this.unreleasedTitle, releaseTitle);
-    fs.writeFileSync(this.changelogPath, changelog);
+    const unreleasedTitle = addUnreleased ? this.unreleasedTitle + this.EOL + this.EOL : '';
+    const releaseTitle = `${unreleasedTitle}## [${version}] - ${formattedDate}`;
+    let changelog = this.changelogContent.replace(this.unreleasedTitle, releaseTitle);
+
+    if (addVersionUrl) {
+      changelog = this.addVersionUrls(changelog);
+    }
+
+    fs.writeFileSync(this.changelogPath, changelog.trim() + this.EOL);
   }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@release-it/keep-a-changelog",
-  "version": "2.0.0",
+  "version": "2.2.2",
   "description": "Keep-a-changelog plugin for release-it",
   "main": "index.js",
   "scripts": {
@@ -10,7 +10,11 @@
   "keywords": [
     "release",
     "release-it",
-    "release-it-plugin"
+    "release-it-plugin",
+    "keep-a-changelog",
+    "changelog",
+    "changes",
+    "unreleased"
   ],
   "license": "MIT",
   "repository": {
@@ -30,11 +34,11 @@
   "devDependencies": {
     "bron": "^1.1.1",
     "mock-fs": "^4.13.0",
-    "release-it": "^14.0.0",
-    "sinon": "^9.0.3"
+    "release-it": "^14.2.0",
+    "sinon": "^9.2.1"
   },
   "peerDependencies": {
-    "release-it": "^14.0.0"
+    "release-it": "^14.2.0"
   },
   "engines": {
     "node": ">=10"

package/test.js

@@ -2,6 +2,7 @@ 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('.');
 
@@ -9,18 +10,25 @@ 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';
 
 mock({
-  './CHANGELOG-FOO.md': '\n\n## [FOO]\n\n* Item A\n* Item B',
-  './CHANGELOG-UNRELEASED.md': '\n\n## [Unreleased]\n\n* Item A\n* Item B',
-  './CHANGELOG-EMPTY.md': '\n\n## [Unreleased]\n\n\n\n## [1.0.0]\n\n* Item A\n* Item B',
-  './CHANGELOG-FULL.md': '\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',
+  './CHANGELOG-FOO.md': '## [FOO]\n\n* Item A\n* Item B',
+  './CHANGELOG-MISSING.md': '## [Unreleased]\n\n* Item A\n* Item B',
+  './CHANGELOG-EMPTY.md': '## [Unreleased]\n\n\n\n## [1.0.0]\n\n* Item A\n* Item B',
+  './CHANGELOG-FULL.md':
+    '# Changelog\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',
+  './CHANGELOG-NO-STRICT.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-DRYRUN.md': initialDryRunFileContents,
-  './CHANGELOG-LESS_NEW_LINES.md':
-    '\n\n## [Unreleased]\n* Item A\n* Item B\n## [1.0.0] - 2020-05-02\n* Item C\n* Item D',
+  './CHANGELOG-LESS_NEW_LINES.md': '## [Unreleased]\n* Item A\n* Item B\n## [1.0.0] - 2020-05-02\n* Item C\n* Item D',
   './CHANGELOG-EOL.md':
-    '\r\n\r\n## [Unreleased]\r\n\r\n* Item A\r\n* Item B\r\n\r\n## [1.0.0] - 2020-05-02\r\n\r\n* Item C\r\n* Item D'
+    '\r\n\r\n## [Unreleased]\r\n\r\n* Item A\r\n* Item B\r\n\r\n## [1.0.0] - 2020-05-02\r\n\r\n* Item C\r\n* Item D',
+  './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_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'
 });
 
-const readFile = file => fs.readFileSync(file).toString().trim();
+const readFile = file => fs.readFileSync(file).toString();
 
 const namespace = 'keep-a-changelog';
 
@@ -43,12 +51,9 @@ test('should throw for empty "unreleased" section', async t => {
 });
 
 test('should throw for missing section for previous release', async t => {
-  const options = { [namespace]: { filename: 'CHANGELOG-UNRELEASED.md' } };
+  const options = { [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-UNRELEASED\.md/
-  );
+  await assert.rejects(runTasks(plugin), /Missing section for previous release \("1\.0\.0"\) in CHANGELOG-MISSING\.md/);
 });
 
 test('should find very first changelog with disabled strict latest option', async t => {
@@ -65,18 +70,18 @@ test('should write changelog', async t => {
   assert.equal(plugin.getChangelog(), '* Item A\n* Item B');
   assert.match(
     readFile('./CHANGELOG-FULL.md'),
-    /## \[1\.0\.1\] - [0-9]{4}-[0-9]{2}-[0-9]{2}\n\n\* Item A\n\* Item B\n\n## \[1\.0\.0\] - 2020-05-02\n\n\* Item C\n*\* Item D/
+    /^# Changelog\n\n## \[1\.0\.1] - [0-9]{4}-[0-9]{2}-[0-9]{2}\n\n\* Item A\n\* Item B\n\n## \[1\.0\.0] - 2020-05-02\n\n\* Item C\n*\* Item D\n$/
   );
 });
 
-test('should write changelog even with disabled strict latest option', async t => {
-  const options = { [namespace]: { filename: 'CHANGELOG-FULL.md', strictLatest: false } };
+test('should write changelog even with `strictLatest: false`', async t => {
+  const options = { [namespace]: { filename: 'CHANGELOG-NO-STRICT.md', strictLatest: false } };
   const plugin = factory(Plugin, { namespace, options });
   await runTasks(plugin);
   assert.equal(plugin.getChangelog(), '* Item A\n* Item B');
   assert.match(
-    readFile('./CHANGELOG-FULL.md'),
-    /## \[1\.0\.1\] - [0-9]{4}-[0-9]{2}-[0-9]{2}\n\n\* Item A\n\* Item B\n\n## \[1\.0\.0\] - 2020-05-02\n\n\* Item C\n*\* Item D/
+    readFile('./CHANGELOG-NO-STRICT.md'),
+    /## \[1\.0\.1] - [0-9]{4}-[0-9]{2}-[0-9]{2}\n\n\* Item A\n\* Item B\n\n## \[1\.0\.0] - 2020-05-02\n\n\* Item C\n*\* Item D/
   );
 });
 
@@ -84,14 +89,14 @@ test('should not write changelog in dry run', async t => {
   const options = { 'dry-run': true, [namespace]: { filename: 'CHANGELOG-DRYRUN.md' } };
   const plugin = factory(Plugin, { namespace, options });
   await runTasks(plugin);
-  assert.equal(fs.readFileSync('./CHANGELOG-DRYRUN.md').toString(), initialDryRunFileContents);
+  assert.equal(readFile('./CHANGELOG-DRYRUN.md'), initialDryRunFileContents);
 });
 
 test('should not write changelog with keep unreleased option', async t => {
   const options = { [namespace]: { filename: 'CHANGELOG-DRYRUN.md', keepUnreleased: true } };
   const plugin = factory(Plugin, { namespace, options });
   await runTasks(plugin);
-  assert.equal(fs.readFileSync('./CHANGELOG-DRYRUN.md').toString(), initialDryRunFileContents);
+  assert.equal(readFile('./CHANGELOG-DRYRUN.md'), initialDryRunFileContents);
 });
 
 test('should find changelog even if less new lines is used', async t => {
@@ -101,13 +106,83 @@ test('should find changelog even if less new lines is used', async t => {
   assert.equal(plugin.getChangelog(), '* Item A\n* Item B');
 });
 
-test('should write changelog (with different EOL)', async t => {
+test('should write changelog with different EOL', async t => {
   const options = { [namespace]: { filename: 'CHANGELOG-EOL.md' } };
   const plugin = factory(Plugin, { namespace, options });
   await runTasks(plugin);
   assert.equal(plugin.getChangelog(), '* Item A\r\n* Item B');
   assert.match(
     readFile('./CHANGELOG-EOL.md'),
-    /## \[1\.0\.1\] - [0-9]{4}-[0-9]{2}-[0-9]{2}\r\n\r\n\* Item A\r\n\* Item B\r\n\r\n## \[1\.0\.0\] - 2020-05-02\r\n\r\n\* Item C\r\n*\* Item D/
+    /^## \[1\.0\.1] - [0-9]{4}-[0-9]{2}-[0-9]{2}\r\n\r\n\* Item A\r\n\* Item B\r\n\r\n## \[1\.0\.0] - 2020-05-02\r\n\r\n\* Item C\r\n*\* Item D\r\n/
+  );
+});
+
+test('should write changelog and add unreleased section', async t => {
+  const options = { [namespace]: { filename: 'CHANGELOG-UNRELEASED.md', addUnreleased: true } };
+  const plugin = factory(Plugin, { namespace, options });
+  await runTasks(plugin);
+  assert.equal(plugin.getChangelog(), '* Item A\n* Item B');
+  assert.match(
+    readFile('./CHANGELOG-UNRELEASED.md'),
+    /^## \[Unreleased]\n\n## \[1\.0\.1] - [0-9]{4}-[0-9]{2}-[0-9]{2}\n\n\* Item A\n\* Item B\n\n## \[1\.0\.0] - 2020-05-02\n\n\* Item C\n*\* Item D/
+  );
+});
+
+test('should add links to the end of the file', async t => {
+  const options = { [namespace]: { filename: 'CHANGELOG-VERSION_URL.md', addVersionUrl: true } };
+  const plugin = factory(Plugin, { namespace, options });
+  plugin.config.setContext({
+    latestTag: '1.0.0',
+    repo: {
+      host: 'github.com',
+      repository: 'release-it/release-it'
+    }
+  });
+  await runTasks(plugin);
+  assert.equal(plugin.getChangelog(), '* Item A\n* Item B');
+  assert.match(
+    readFile('./CHANGELOG-VERSION_URL.md'),
+    /^## \[1\.0\.1] - [0-9]{4}-[0-9]{2}-[0-9]{2}\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\.1\.\.\.HEAD\n\[1\.0\.1]: https:\/\/github\.com\/release-it\/release-it\/compare\/1\.0\.0\.\.\.1\.0\.1\n\[1\.0\.0]: https:\/\/github\.com\/release-it\/release-it\/compare\/0\.0\.0\.\.\.1\.0\.0\n$/
+  );
+});
+
+test('should add unreleased section and links to the end of the file', async t => {
+  const options = {
+    [namespace]: { filename: 'CHANGELOG-VERSION_URL_UNRELEASED.md', addVersionUrl: true, addUnreleased: true }
+  };
+  const plugin = factory(Plugin, { namespace, options });
+  plugin.config.setContext({
+    latestTag: '1.0.0',
+    repo: {
+      host: 'github.com',
+      repository: 'user/project'
+    }
+  });
+  await runTasks(plugin);
+  assert.equal(plugin.getChangelog(), '* Item A\n* Item B');
+  assert.match(
+    readFile('./CHANGELOG-VERSION_URL_UNRELEASED.md'),
+    /^## \[Unreleased]\n\n## \[1\.0\.1] - [0-9]{4}-[0-9]{2}-[0-9]{2}\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\.1\.\.\.HEAD\n\[1\.0\.1]: https:\/\/github\.com\/user\/project\/compare\/1\.0\.0\.\.\.1\.0\.1\n\[1\.0\.0]: https:\/\/github\.com\/user\/project\/compare\/0\.0\.0\.\.\.1\.0\.0\n/
+  );
+});
+
+test('should add link to the end of a new changelog', async t => {
+  const options = {
+    [namespace]: { filename: 'CHANGELOG-VERSION_URL_NEW.md', addVersionUrl: true, strictLatest: false }
+  };
+  const plugin = factory(Plugin, { namespace, options });
+  sinon.stub(plugin, 'getLatestVersion').returns('0.0.0');
+  plugin.config.setContext({
+    increment: 'major',
+    repo: {
+      host: 'github.com',
+      repository: 'user/project'
+    }
+  });
+  await runTasks(plugin);
+  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\/compare\/0\.0\.0\.\.\.1\.0\.0\n$/
   );
 });