yaclt
Version:
Yet Another Change Log Tool
76 lines • 8.39 kB
JavaScript
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.CliOptions = void 0;
var file_utils_1 = require("../utils/file-utils");
var string_utils_1 = require("../utils/string-utils");
var coerceFileArg = function (createIfNotExist) {
if (createIfNotExist === void 0) { createIfNotExist = true; }
return function (filePath) {
if (createIfNotExist) {
file_utils_1.touchFile(filePath);
}
return filePath;
};
};
exports.CliOptions = {
logsDir: {
type: "string",
normalize: true,
default: "changelogs/",
describe: "The directory to find and place individual changelog entries",
global: true,
},
branchFormat: {
type: "string",
describe: "Regular expression with a capturing group to parse the issue ID out of your git branch. Implies --requireIssueIds and assumes that --format includes %issueid%",
global: true,
},
changelogFile: {
type: "string",
normalize: true,
default: "CHANGELOG.md",
describe: "The name of the global changelog file to collect entries into",
coerce: coerceFileArg(true),
global: true,
},
changeTypes: {
type: "array",
default: ["NEW", "IMPROVED", "FIXED"],
describe: "The allowed change type tags",
global: true,
},
requireIssueIds: {
type: "boolean",
default: true,
describe: "Require issue IDs in changelog entries",
global: true,
},
format: {
type: "string",
default: "[{{" + string_utils_1.StringFormatParams.changeType + "}}] {{" + string_utils_1.StringFormatParams.message + "}} {{echo \"{\"}}#{{" + string_utils_1.StringFormatParams.issueId + "}}{{echo \"}\"}}\n",
describe: "Changelog entry format, as a Handlebars template. To make change type tags optional, simply don't include the Handlebars variable for it.",
global: true,
},
plumbing: {
alias: "p",
type: "boolean",
default: false,
describe: "Reduce output to just the relevant data, e.g. filepaths for `new` and `prepare-release`, `true/false` for `validate`, for scripting purposes. Also disables opening `$EDITOR`. Passing this option will override `--quiet` or `--verbose`.",
global: true,
},
quiet: {
alias: "q",
type: "boolean",
default: false,
describe: "Silence all output.",
global: true,
},
verbose: {
alias: "v",
type: "boolean",
default: false,
describe: "Output additional command logs and information.",
global: true,
},
};
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoib3B0aW9ucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9jbGkvb3B0aW9ucy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFDQSxrREFBZ0Q7QUFDaEQsc0RBQTJEO0FBRTNELElBQU0sYUFBYSxHQUNqQixVQUFDLGdCQUF1QjtJQUF2QixpQ0FBQSxFQUFBLHVCQUF1QjtJQUN4QixPQUFBLFVBQUMsUUFBZ0I7UUFDZixJQUFJLGdCQUFnQixFQUFFO1lBQ3BCLHNCQUFTLENBQUMsUUFBUSxDQUFDLENBQUM7U0FDckI7UUFFRCxPQUFPLFFBQVEsQ0FBQztJQUNsQixDQUFDO0FBTkQsQ0FNQyxDQUFDO0FBY1MsUUFBQSxVQUFVLEdBQStCO0lBQ3BELE9BQU8sRUFBRTtRQUNQLElBQUksRUFBRSxRQUFRO1FBQ2QsU0FBUyxFQUFFLElBQUk7UUFDZixPQUFPLEVBQUUsYUFBYTtRQUN0QixRQUFRLEVBQUUsOERBQThEO1FBQ3hFLE1BQU0sRUFBRSxJQUFJO0tBQ2I7SUFDRCxZQUFZLEVBQUU7UUFDWixJQUFJLEVBQUUsUUFBUTtRQUNkLFFBQVEsRUFDTixnS0FBZ0s7UUFDbEssTUFBTSxFQUFFLElBQUk7S0FDYjtJQUNELGFBQWEsRUFBRTtRQUNiLElBQUksRUFBRSxRQUFRO1FBQ2QsU0FBUyxFQUFFLElBQUk7UUFDZixPQUFPLEVBQUUsY0FBYztRQUN2QixRQUFRLEVBQUUsK0RBQStEO1FBQ3pFLE1BQU0sRUFBRSxhQUFhLENBQUMsSUFBSSxDQUFDO1FBQzNCLE1BQU0sRUFBRSxJQUFJO0tBQ2I7SUFDRCxXQUFXLEVBQUU7UUFDWCxJQUFJLEVBQUUsT0FBTztRQUNiLE9BQU8sRUFBRSxDQUFDLEtBQUssRUFBRSxVQUFVLEVBQUUsT0FBTyxDQUFDO1FBQ3JDLFFBQVEsRUFBRSw4QkFBOEI7UUFDeEMsTUFBTSxFQUFFLElBQUk7S0FDYjtJQUNELGVBQWUsRUFBRTtRQUNmLElBQUksRUFBRSxTQUFTO1FBQ2YsT0FBTyxFQUFFLElBQUk7UUFDYixRQUFRLEVBQUUsd0NBQXdDO1FBQ2xELE1BQU0sRUFBRSxJQUFJO0tBQ2I7SUFDRCxNQUFNLEVBQUU7UUFDTixJQUFJLEVBQUUsUUFBUTtRQUNkLE9BQU8sRUFBRSxRQUFNLGlDQUFrQixDQUFDLFVBQVUsY0FBUyxpQ0FBa0IsQ0FBQyxPQUFPLDRCQUFxQixpQ0FBa0IsQ0FBQyxPQUFPLHVCQUFrQjtRQUNoSixRQUFRLEVBQ04sMklBQTJJO1FBQzdJLE1BQU0sRUFBRSxJQUFJO0tBQ2I7SUFDRCxRQUFRLEVBQUU7UUFDUixLQUFLLEVBQUUsR0FBRztRQUNWLElBQUksRUFBRSxTQUFTO1FBQ2YsT0FBTyxFQUFFLEtBQUs7UUFDZCxRQUFRLEVBQ04sNE9BQTRPO1FBQzlPLE1BQU0sRUFBRSxJQUFJO0tBQ2I7SUFDRCxLQUFLLEVBQUU7UUFDTCxLQUFLLEVBQUUsR0FBRztRQUNWLElBQUksRUFBRSxTQUFTO1FBQ2YsT0FBTyxFQUFFLEtBQUs7UUFDZCxRQUFRLEVBQUUscUJBQXFCO1FBQy9CLE1BQU0sRUFBRSxJQUFJO0tBQ2I7SUFDRCxPQUFPLEVBQUU7UUFDUCxLQUFLLEVBQUUsR0FBRztRQUNWLElBQUksRUFBRSxTQUFTO1FBQ2YsT0FBTyxFQUFFLEtBQUs7UUFDZCxRQUFRLEVBQUUsaURBQWlEO1FBQzNELE1BQU0sRUFBRSxJQUFJO0tBQ2I7Q0FDRixDQUFDIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgT3B0aW9ucyB9IGZyb20gXCJ5YXJnc1wiO1xuaW1wb3J0IHsgdG91Y2hGaWxlIH0gZnJvbSBcIi4uL3V0aWxzL2ZpbGUtdXRpbHNcIjtcbmltcG9ydCB7IFN0cmluZ0Zvcm1hdFBhcmFtcyB9IGZyb20gXCIuLi91dGlscy9zdHJpbmctdXRpbHNcIjtcblxuY29uc3QgY29lcmNlRmlsZUFyZyA9XG4gIChjcmVhdGVJZk5vdEV4aXN0ID0gdHJ1ZSkgPT5cbiAgKGZpbGVQYXRoOiBzdHJpbmcpOiBzdHJpbmcgPT4ge1xuICAgIGlmIChjcmVhdGVJZk5vdEV4aXN0KSB7XG4gICAgICB0b3VjaEZpbGUoZmlsZVBhdGgpO1xuICAgIH1cblxuICAgIHJldHVybiBmaWxlUGF0aDtcbiAgfTtcblxuZXhwb3J0IGludGVyZmFjZSBHbG9iYWxBcmd2IHtcbiAgcGx1bWJpbmc6IGJvb2xlYW47XG4gIGxvZ3NEaXI6IHN0cmluZztcbiAgYnJhbmNoRm9ybWF0Pzogc3RyaW5nO1xuICBjaGFuZ2Vsb2dGaWxlOiBzdHJpbmc7XG4gIGNoYW5nZVR5cGVzOiBzdHJpbmdbXTtcbiAgcmVxdWlyZUlzc3VlSWRzOiBib29sZWFuO1xuICBmb3JtYXQ6IHN0cmluZztcbiAgcXVpZXQ6IGJvb2xlYW47XG4gIHZlcmJvc2U6IGJvb2xlYW47XG59XG5cbmV4cG9ydCBjb25zdCBDbGlPcHRpb25zOiB7IFtrZXk6IHN0cmluZ106IE9wdGlvbnMgfSA9IHtcbiAgbG9nc0Rpcjoge1xuICAgIHR5cGU6IFwic3RyaW5nXCIsXG4gICAgbm9ybWFsaXplOiB0cnVlLFxuICAgIGRlZmF1bHQ6IFwiY2hhbmdlbG9ncy9cIixcbiAgICBkZXNjcmliZTogXCJUaGUgZGlyZWN0b3J5IHRvIGZpbmQgYW5kIHBsYWNlIGluZGl2aWR1YWwgY2hhbmdlbG9nIGVudHJpZXNcIixcbiAgICBnbG9iYWw6IHRydWUsXG4gIH0sXG4gIGJyYW5jaEZvcm1hdDoge1xuICAgIHR5cGU6IFwic3RyaW5nXCIsXG4gICAgZGVzY3JpYmU6XG4gICAgICBcIlJlZ3VsYXIgZXhwcmVzc2lvbiB3aXRoIGEgY2FwdHVyaW5nIGdyb3VwIHRvIHBhcnNlIHRoZSBpc3N1ZSBJRCBvdXQgb2YgeW91ciBnaXQgYnJhbmNoLiBJbXBsaWVzIC0tcmVxdWlyZUlzc3VlSWRzIGFuZCBhc3N1bWVzIHRoYXQgLS1mb3JtYXQgaW5jbHVkZXMgJWlzc3VlaWQlXCIsXG4gICAgZ2xvYmFsOiB0cnVlLFxuICB9LFxuICBjaGFuZ2Vsb2dGaWxlOiB7XG4gICAgdHlwZTogXCJzdHJpbmdcIixcbiAgICBub3JtYWxpemU6IHRydWUsXG4gICAgZGVmYXVsdDogXCJDSEFOR0VMT0cubWRcIixcbiAgICBkZXNjcmliZTogXCJUaGUgbmFtZSBvZiB0aGUgZ2xvYmFsIGNoYW5nZWxvZyBmaWxlIHRvIGNvbGxlY3QgZW50cmllcyBpbnRvXCIsXG4gICAgY29lcmNlOiBjb2VyY2VGaWxlQXJnKHRydWUpLFxuICAgIGdsb2JhbDogdHJ1ZSxcbiAgfSxcbiAgY2hhbmdlVHlwZXM6IHtcbiAgICB0eXBlOiBcImFycmF5XCIsXG4gICAgZGVmYXVsdDogW1wiTkVXXCIsIFwiSU1QUk9WRURcIiwgXCJGSVhFRFwiXSxcbiAgICBkZXNjcmliZTogXCJUaGUgYWxsb3dlZCBjaGFuZ2UgdHlwZSB0YWdzXCIsXG4gICAgZ2xvYmFsOiB0cnVlLFxuICB9LFxuICByZXF1aXJlSXNzdWVJZHM6IHtcbiAgICB0eXBlOiBcImJvb2xlYW5cIixcbiAgICBkZWZhdWx0OiB0cnVlLFxuICAgIGRlc2NyaWJlOiBcIlJlcXVpcmUgaXNzdWUgSURzIGluIGNoYW5nZWxvZyBlbnRyaWVzXCIsXG4gICAgZ2xvYmFsOiB0cnVlLFxuICB9LFxuICBmb3JtYXQ6IHtcbiAgICB0eXBlOiBcInN0cmluZ1wiLFxuICAgIGRlZmF1bHQ6IGBbe3ske1N0cmluZ0Zvcm1hdFBhcmFtcy5jaGFuZ2VUeXBlfX19XSB7eyR7U3RyaW5nRm9ybWF0UGFyYW1zLm1lc3NhZ2V9fX0ge3tlY2hvIFwie1wifX0je3ske1N0cmluZ0Zvcm1hdFBhcmFtcy5pc3N1ZUlkfX19e3tlY2hvIFwifVwifX1cXG5gLFxuICAgIGRlc2NyaWJlOlxuICAgICAgXCJDaGFuZ2Vsb2cgZW50cnkgZm9ybWF0LCBhcyBhIEhhbmRsZWJhcnMgdGVtcGxhdGUuIFRvIG1ha2UgY2hhbmdlIHR5cGUgdGFncyBvcHRpb25hbCwgc2ltcGx5IGRvbid0IGluY2x1ZGUgdGhlIEhhbmRsZWJhcnMgdmFyaWFibGUgZm9yIGl0LlwiLFxuICAgIGdsb2JhbDogdHJ1ZSxcbiAgfSxcbiAgcGx1bWJpbmc6IHtcbiAgICBhbGlhczogXCJwXCIsXG4gICAgdHlwZTogXCJib29sZWFuXCIsXG4gICAgZGVmYXVsdDogZmFsc2UsXG4gICAgZGVzY3JpYmU6XG4gICAgICBcIlJlZHVjZSBvdXRwdXQgdG8ganVzdCB0aGUgcmVsZXZhbnQgZGF0YSwgZS5nLiBmaWxlcGF0aHMgZm9yIGBuZXdgIGFuZCBgcHJlcGFyZS1yZWxlYXNlYCwgYHRydWUvZmFsc2VgIGZvciBgdmFsaWRhdGVgLCBmb3Igc2NyaXB0aW5nIHB1cnBvc2VzLiBBbHNvIGRpc2FibGVzIG9wZW5pbmcgYCRFRElUT1JgLiBQYXNzaW5nIHRoaXMgb3B0aW9uIHdpbGwgb3ZlcnJpZGUgYC0tcXVpZXRgIG9yIGAtLXZlcmJvc2VgLlwiLFxuICAgIGdsb2JhbDogdHJ1ZSxcbiAgfSxcbiAgcXVpZXQ6IHtcbiAgICBhbGlhczogXCJxXCIsXG4gICAgdHlwZTogXCJib29sZWFuXCIsXG4gICAgZGVmYXVsdDogZmFsc2UsXG4gICAgZGVzY3JpYmU6IFwiU2lsZW5jZSBhbGwgb3V0cHV0LlwiLFxuICAgIGdsb2JhbDogdHJ1ZSxcbiAgfSxcbiAgdmVyYm9zZToge1xuICAgIGFsaWFzOiBcInZcIixcbiAgICB0eXBlOiBcImJvb2xlYW5cIixcbiAgICBkZWZhdWx0OiBmYWxzZSxcbiAgICBkZXNjcmliZTogXCJPdXRwdXQgYWRkaXRpb25hbCBjb21tYW5kIGxvZ3MgYW5kIGluZm9ybWF0aW9uLlwiLFxuICAgIGdsb2JhbDogdHJ1ZSxcbiAgfSxcbn07XG4iXX0=