From d0a7ce3017b83084db1039867f0baa0533da03a1 Mon Sep 17 00:00:00 2001 From: Vincent Weevers Date: Fri, 12 Nov 2021 13:27:55 +0100 Subject: [PATCH] Breaking: replace `remark-changelog` with `remark-common-changelog` Drops support of `Unreleased` section. Linting will now emit an error if such a section is encountered in a `CHANGELOG.md`. Ref https://github.com/vweevers/hallmark/issues/81 Ref https://github.com/vweevers/hallmark/issues/82 Ref https://github.com/vweevers/remark-changelog/issues/12 --- README.md | 4 ++-- index.js | 2 +- package.json | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 0b20f0a..6e0f947 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ This module saves you time in three ways: - **No configuration.** The easiest way to enforce markdown code quality in your project. No decisions to make. No `remark` plugins to manage. -- **Automatically format markdown.** Run `hallmark fix` to format markdown, wrap GitHub issues and usernames in links, autocomplete a `CHANGELOG.md` following [Keep A Changelog](https://keepachangelog.com/en/1.0.0/), and more. +- **Automatically format markdown.** Run `hallmark fix` to format markdown, wrap GitHub issues and usernames in links, autocomplete a `CHANGELOG.md` following [Common Changelog](https://common-changelog.org) and more. - **Catch style issues & mistakes early.** Save code review time by eliminating back-and-forth between reviewer & contributor. ## Quick Start @@ -214,7 +214,7 @@ While `hallmark lint` will warn about unlinked references. ### `changelog` -An object containing options to be passed to [`remark-changelog`](https://github.com/vweevers/remark-changelog): +An object containing options to be passed to [`remark-common-changelog`](https://github.com/vweevers/remark-common-changelog): - `submodules` (boolean): enable experimental git submodule support. Will (upon encountering new or empty changelog entries) collect commits from submodules and list them in the changelog as `: `. diff --git a/index.js b/index.js index 1678daf..a99e272 100644 --- a/index.js +++ b/index.js @@ -75,7 +75,7 @@ function hallmark (options, callback) { }] : null, - [require('remark-changelog'), { cwd, fix, pkg, repository, ...changelog }], + [require('remark-common-changelog'), { cwd, fix, pkg, repository, ...changelog }], [require('remark-github'), { repository }], // Does nothing unless configured diff --git a/package.json b/package.json index a334cd0..cba7fb2 100644 --- a/package.json +++ b/package.json @@ -25,8 +25,8 @@ "github-url-from-git": "^1.5.0", "remark": "^12.0.1", "remark-autolink-references": "^1.0.0", - "remark-changelog": "^1.2.1", "remark-collapse": "~0.1.2", + "remark-common-changelog": "^0.0.2", "remark-git-contributors": "^3.0.0", "remark-github": "^9.0.1", "remark-lint": "^7.0.1",