Skip to content

Commit

Permalink
Breaking: replace remark-changelog with remark-common-changelog
Browse files Browse the repository at this point in the history
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
  • Loading branch information
vweevers committed Nov 14, 2021
1 parent 6c2206d commit d0a7ce3
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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 `<submodule>: <message>`.

Expand Down
2 changes: 1 addition & 1 deletion index.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down

0 comments on commit d0a7ce3

Please sign in to comment.