Security News
Internet Archive Hacked, 31 Million Record Compromised
The Internet Archive's "Wayback Machine" has been hacked and defaced, with 31 millions records compromised.
keep-a-changelog
Advanced tools
Node package to parse and generate changelogs following the [keepachangelog](http://keepachangelog.com/en/1.0.0/) format.
Node package to parse and generate changelogs following the keepachangelog format.
You can install it from the npm repository using npm/yarn:
npm install keep-a-changelog
const { parser } = require('keep-a-changelog');
const fs = require('fs');
//Parse a changelog file
const changelog = parser(fs.readFileSync('CHANGELOG.md', 'UTF-8'));
//Generate the new changelog string
console.log(changelog.toString());
const { Changelog, Release } = require('keep-a-changelog');
const changelog = new Changelog('My project')
.addRelease(
new Release('0.1.0', '2017-12-06')
.added('New awesome feature')
.added('New other awesome feature')
.fixed('Bug #3')
.removed('Drop support for X')
)
.addRelease(
new Release('0.2.0', '2017-12-09')
.security('Fixed security vulnerability')
.deprecated('Feature X is deprecated')
);
console.log(changelog.toString());
By default, the tag names are v
+ version number. For example, the tag for the version 2.4.9
is v2.4.9
. To change this behavior, set a new tagNameBuilder
:
const changelog = new Changelog();
changelog.tagNameBuilder = release => `version-${release.version}`;
By default and according to the keepachangelog format, the change types are
Added
,
Changed
,
Deprecated
,
Removed
,
Fixed
,
and Security
.
In case you'd like add another type in order to use is in your changelog, you basically need to extend the Release
class to support new types. Additionally, you have to tell the parser
that it should create instances of your new extended Release
in order to parse your changelog correctly.
For example, we would like to add a type Maintenance
.
Extend the provided Release
class:
class CustomRelease extends Release {
constructor(version, date, description) {
super(version, date, description);
// add whatever types you want - in lowercase
const newChangeTypes = [
['maintenance', []]
];
this.changes = new Map([...this.changes, ...newChangeTypes]);
}
// for convenience, add a new method to add change of type 'maintanance'
maintenance(change) {
return this.addChange('maintenance', change);
}
}
And once you want to use the parser:
const releaseCreator = (ver, date, desc) => new CustomRelease(ver, date, desc)
const changelog = parser(changelogTextContent, {releaseCreator})
This library provides the changelog
command to normalize the changelog format. It reads the CHANGELOG.md file and override it with the new format:
changelog
To use other file name:
changelog --file=History.md
To generate an empty new CHANGELOG.md file:
changelog --init
Available options:
Option | Description |
---|---|
--file | The markdown file of the changelog. The default value is CHANGELOG.md . |
--url | The base url used to build the diff urls of the different releases. It is taken from the existing diff urls in the markdown. If no urls are found, try to catch it using the url of the git remote repository. |
--https | Set to false to use http instead https in the url (--https=false ). |
--init | Init a new empty changelog file. |
FAQs
Node package to parse and generate changelogs following the [keepachangelog](https://keepachangelog.com/) format.
The npm package keep-a-changelog receives a total of 4,921 weekly downloads. As such, keep-a-changelog popularity was classified as popular.
We found that keep-a-changelog demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The Internet Archive's "Wayback Machine" has been hacked and defaced, with 31 millions records compromised.
Security News
TC39 is meeting in Tokyo this week and they have approved nearly a dozen proposals to advance to the next stages.
Security News
Our threat research team breaks down two malicious npm packages designed to exploit developer trust, steal your data, and destroy data on your machine.