Skip to content

Commit d0a7ce3

Browse files
committed
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 #81 Ref #82 Ref vweevers/remark-changelog#12
1 parent 6c2206d commit d0a7ce3

3 files changed

Lines changed: 4 additions & 4 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@
4343
This module saves you time in three ways:
4444

4545
- **No configuration.** The easiest way to enforce markdown code quality in your project. No decisions to make. No `remark` plugins to manage.
46-
- **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.
46+
- **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.
4747
- **Catch style issues & mistakes early.** Save code review time by eliminating back-and-forth between reviewer & contributor.
4848

4949
## Quick Start
@@ -214,7 +214,7 @@ While `hallmark lint` will warn about unlinked references.
214214

215215
### `changelog`
216216

217-
An object containing options to be passed to [`remark-changelog`](https://github.com/vweevers/remark-changelog):
217+
An object containing options to be passed to [`remark-common-changelog`](https://github.com/vweevers/remark-common-changelog):
218218

219219
- `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 `<submodule>: <message>`.
220220

index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ function hallmark (options, callback) {
7575
}]
7676
: null,
7777

78-
[require('remark-changelog'), { cwd, fix, pkg, repository, ...changelog }],
78+
[require('remark-common-changelog'), { cwd, fix, pkg, repository, ...changelog }],
7979
[require('remark-github'), { repository }],
8080

8181
// Does nothing unless configured

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@
2525
"github-url-from-git": "^1.5.0",
2626
"remark": "^12.0.1",
2727
"remark-autolink-references": "^1.0.0",
28-
"remark-changelog": "^1.2.1",
2928
"remark-collapse": "~0.1.2",
29+
"remark-common-changelog": "^0.0.2",
3030
"remark-git-contributors": "^3.0.0",
3131
"remark-github": "^9.0.1",
3232
"remark-lint": "^7.0.1",

0 commit comments

Comments
 (0)