Name: helper-changelog
Owner: Helpers
Description: Template helper for generating a markdown-formatted changelog from an object, array or yaml file. Should work with Handlebars or Lo-Dash or any engine with support for helper functions.
Created: 2015-03-16 16:03:37.0
Updated: 2017-04-07 05:13:04.0
Pushed: 2016-07-21 10:00:00.0
Homepage: null
Size: 17
Language: JavaScript
GitHub Committers
| User | Most Recent Commit | # Commits |
|---|
Other Committers
| User | Most Recent Commit | # Commits |
|---|
Template helper for generating a markdown-formatted changelog from an object, array or yaml file.
This is a template helper that takes a changelog object, array, or filepath to a changelog file, and converts it to a markdown formatted changelog that looks something like this:
[v0.2.0] - 2016-12-26
xed**
xed [bug 10,997]
[v0.1.0] - 2016-12-25
precated**
precated `.foo` and `.bar`
anged**
anged behavior of `.baz`
See stringify-changelog for details.
changelog = require('helper-changelog');
changelog(value, locals) %>
value {String|Object|Array}: If the value is a string it will be regarded as a filepath. Supported file formats are yaml, json, and markdown.locals: Locals or options to pass to stringify-changelog. If a markdown file is passed, and it follows [keep-a-changelog][] conventions, the helper will attempt to generate reflinks to match the headings.Note: When a filepath is passed, the file name can be anything, but the extension is used for determining how to parse the file:
ile path to a valid yaml file
changelog("CHANGELOG") %>
changelog("CHANGELOG.yml") %>
changelog("CHANGELOG.yaml") %>
ile path to a valid JSON file
changelog("CHANGELOG.json") %>
hangelog object passed as a variable on the context
changelog(changes) %>
hangelog object passed as locals
changelog({
0.1.0": {
date: "2016-12-26",
changes: [ "Got stuck in another chimney." ]
>
hangelog array passed as locals
changelog([
date: "2016-12-26",
version: "v0.1.0",
changes: [ "Got stuck in another chimney." ]
>
YAML
The contents of the file must be valid YAML following this format:
.0:
te: "2016-12-26"
anges:
- Got stuck in another chimney.
See stringify-changelog for additional options.
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Install dev dependencies:
m install -d && npm test
Jon Schlinkert
Copyright © 2016, Jon Schlinkert. Released under the MIT license.
This file was generated by verb, v0.9.0, on July 21, 2016.