Plato on Github
Report Home
lib/resource-types/keep-a-changelog.js
Maintainability
68.15
Lines of code
103
Difficulty
28.57
Estimated Errors
0.54
Function weight
By Complexity
By SLOC
"use strict" import keepAChangelog from 'keep-a-changelog'; import fs from 'fs'; import stringFormat from 'string-format'; const parser = keepAChangelog.parser; const Release = keepAChangelog.Release; /** * Set a release version number to the latest release within the changelog, with date set to current date. * The changelog follows keep a changelog format https://keepachangelog.com . * * @param {String} version: version value to set * @param {Object} resource: resource configuration which contains type, path, and params * @param {Object} opts: optional settings * - dryRun: when true, changelog file won't be modified * @param {Function} cb: standard cb(err, result) callback */ function setReleaseVersion(version, resource, opts, cb) { const changelog = parser(fs.readFileSync(resource.path, 'UTF-8')); changelog.tagNameBuilder = function (release) { // Use tagFormat option to format the version to be used as SCM tag const formattedVersion = stringFormat(opts.tagFormat, { version: release.version }); return formattedVersion; }; const latestRelease = changelog.releases[0]; latestRelease.setVersion(version); latestRelease.setDate(new Date()); if (!opts.dryRun) { fs.writeFile(resource.path, changelog.toString(), cb); } else { cb(); } } /** * Add a new release to the changelog having the post-release version and an unreleased date. * The changelog follows keep a changelog format https://keepachangelog.com . * * @param {String} version: version value to set * @param {Object} resource: resource configuration which contains type, path, and params * @param {Object} opts: optional settings * - dryRun: when true, changelog file won't be modified * @param {Function} cb: standard cb(err, result) callback */ function setPostReleaseVersion(version, resource, opts, cb) { const changelog = parser(fs.readFileSync(resource.path, 'UTF-8')); changelog.tagNameBuilder = function (release) { // Use tagFormat option to format the version to be used as SCM tag const formattedVersion = stringFormat(opts.tagFormat, { version: release.version }); return formattedVersion; }; const postRelease = new Release(); changelog.addRelease(postRelease); if (!opts.dryRun) { fs.writeFile(resource.path, changelog.toString(), cb); } else { cb(); } } /** * Get version value from the changelog's latest release. * The changelog follows keep a changelog format https://keepachangelog.com . * It's common for the latest positioned version value for keep a changelog to be set to 'Unreleased' * in order to indicate that it's the one that's currently in progress. * Hence we need to handle two scenarios here: * - when latest release has a version number, then use that as the current version * - when latest release is 'Unreleased' (version is undefined after parsing), then use the previous release and append a '.0' suffix * - otherwise defaults to '0.0.0' * * @param {Object} resource: resource configuration which contains type, path, and params * @param {Function} cb: standard cb(err, result) callback */ function getVersion(resource, cb) { function readCb(err, result) { let version; if (!err) { const changelog = parser(result); const latestRelease = changelog.releases[0]; const latestReleaseMinusOne = changelog.releases[1]; if (latestRelease.version) { version = latestRelease.version; } else if (latestReleaseMinusOne.version) { version = latestReleaseMinusOne.version + '.0'; } else { version = '0.0.0'; } } cb(err, version); } fs.readFile(resource.path, 'UTF-8', readCb); } const exports = { setReleaseVersion: setReleaseVersion, setPostReleaseVersion: setPostReleaseVersion, getVersion: getVersion }; export { exports as default };