changelog-machine 1.1.0 → 2.0.0

package/lib/cli/commands/printHelp.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.printHelp = void 0;
-const printHelp = () => {
-    return console.log(`
-  Usage
-    $ npx changelog-machine -c changelog.config.json
-  
-  Options
-    --config, -c  Path to the configuration file
-    --version, -v  Show version
-    --help, -h  Show help
-    `);
-};
-exports.printHelp = printHelp;

package/lib/cli/commands/printMarkdown.d.ts

@@ -1,3 +0,0 @@
-import { Config } from '../../models';
-declare const printMarkdown: (config?: Config | undefined) => Promise<void>;
-export { printMarkdown };

package/lib/cli/commands/printMarkdown.js

@@ -1,26 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.printMarkdown = void 0;
-const async_1 = require("../../core/async");
-const markdown_1 = require("../../core/markdown");
-const default_1 = require("../../core/default");
-const printMarkdown = (config) => __awaiter(void 0, void 0, void 0, function* () {
-    var _a;
-    const output = yield (0, markdown_1.createMarkdown)(config);
-    try {
-        yield (0, async_1.outputFileAsync)((_a = config === null || config === void 0 ? void 0 : config.filePath) !== null && _a !== void 0 ? _a : default_1.defaultConfig.outputFilename, output);
-    }
-    catch (error) {
-        console.error(error);
-    }
-});
-exports.printMarkdown = printMarkdown;

package/lib/cli/commands/printVersion.d.ts

@@ -1,2 +0,0 @@
-declare const printVersion: () => void;
-export { printVersion };

package/lib/cli/commands/printVersion.js

@@ -1,12 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.printVersion = void 0;
-const printVersion = () => {
-    if (typeof process.env.npm_package_version === 'undefined') {
-        console.warn('Warning: No version information found.');
-    }
-    else {
-        console.log(`${process.env.npm_package_name} v${process.env.npm_package_version}`);
-    }
-};
-exports.printVersion = printVersion;

package/lib/cli/config/options.d.ts

@@ -1,3 +0,0 @@
-import minimist from 'minimist';
-declare const flags: minimist.Opts | undefined;
-export { flags };

package/lib/cli/config/options.js

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.flags = void 0;
-const flags = {
-    string: 'config',
-    boolean: ['version', 'help'],
-    alias: { v: 'version', h: 'help' },
-    unknown: (a) => {
-        console.log(`The argument '${a}' is invalid for this command. Please use --help to read the description of this command.`);
-        return false;
-    },
-};
-exports.flags = flags;

package/lib/cli/config/readConfigFile.d.ts

@@ -1,3 +0,0 @@
-import { Config } from '../../models';
-declare const readConfigFile: (configFilePath: string) => Promise<Config>;
-export { readConfigFile };

package/lib/cli/config/readConfigFile.js

@@ -1,25 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.readConfigFile = void 0;
-const async_1 = require("../../core/async");
-const readConfigFile = (configFilePath) => __awaiter(void 0, void 0, void 0, function* () {
-    var _a;
-    try {
-        const file = yield (0, async_1.readFileAsync)(configFilePath);
-        return JSON.parse(file.toLocaleString());
-    }
-    catch (error) {
-        throw new Error((_a = `Unable to read the config file at the location ${configFilePath}\n` +
-            error) !== null && _a !== void 0 ? _a : '');
-    }
-});
-exports.readConfigFile = readConfigFile;

package/lib/core/async.d.ts

@@ -1,9 +0,0 @@
-/// <reference types="node" />
-import { exec } from 'child_process';
-import { readFile, writeFile } from 'fs';
-declare const execAsync: typeof exec.__promisify__;
-declare const writeFileAsync: typeof writeFile.__promisify__;
-declare const readFileAsync: typeof readFile.__promisify__;
-declare const outputFileAsync: (path: string, contents: string) => Promise<void>;
-declare const checkPackageJsonExists: () => boolean;
-export { checkPackageJsonExists, execAsync, outputFileAsync, readFileAsync, writeFileAsync, };

package/lib/core/async.js

@@ -1,32 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.writeFileAsync = exports.readFileAsync = exports.outputFileAsync = exports.execAsync = exports.checkPackageJsonExists = void 0;
-const child_process_1 = require("child_process");
-const fs_1 = require("fs");
-const path_1 = require("path");
-const util_1 = require("util");
-const execAsync = (0, util_1.promisify)(child_process_1.exec);
-exports.execAsync = execAsync;
-const writeFileAsync = (0, util_1.promisify)(fs_1.writeFile);
-exports.writeFileAsync = writeFileAsync;
-const readFileAsync = (0, util_1.promisify)(fs_1.readFile);
-exports.readFileAsync = readFileAsync;
-const mkdirAsync = (0, util_1.promisify)(fs_1.mkdir);
-const outputFileAsync = (path, contents) => __awaiter(void 0, void 0, void 0, function* () {
-    yield mkdirAsync((0, path_1.dirname)(path), { recursive: true });
-    yield writeFileAsync(path, contents);
-});
-exports.outputFileAsync = outputFileAsync;
-const checkPackageJsonExists = () => {
-    return (0, fs_1.existsSync)('package.json');
-};
-exports.checkPackageJsonExists = checkPackageJsonExists;

package/lib/core/default.d.ts

@@ -1,6 +0,0 @@
-declare const defaultConfig: {
-    outputFilename: string;
-    title: string;
-    description: string;
-};
-export { defaultConfig };

package/lib/core/default.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.defaultConfig = void 0;
-const defaultConfig = {
-    outputFilename: 'CHANGELOG.md',
-    title: 'Changelog',
-    description: 'All notable changes to this project will be documented in this file. Dates are displayed in UTC.',
-};
-exports.defaultConfig = defaultConfig;

package/lib/core/git.d.ts

@@ -1,8 +0,0 @@
-import { Commit } from '../models';
-declare const groupCommitsByTags: (blacklistPattern: string | undefined) => Promise<{
-    commits: Commit[];
-    previousTag: string;
-    tag: string;
-    date: Date;
-}[]>;
-export { groupCommitsByTags };

package/lib/core/git.js

@@ -1,88 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __asyncValues = (this && this.__asyncValues) || function (o) {
-    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
-    var m = o[Symbol.asyncIterator], i;
-    return m ? m.call(o) : (o = typeof __values === "function" ? __values(o) : o[Symbol.iterator](), i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i);
-    function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
-    function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.groupCommitsByTags = void 0;
-const async_1 = require("./async");
-const getReleaseTags = () => __awaiter(void 0, void 0, void 0, function* () {
-    const command = `git tag -l --sort=-creatordate --format="%(creatordate:short),%(refname:short)"`;
-    const result = yield (0, async_1.execAsync)(command);
-    return result.stdout
-        .split('\n')
-        .filter((tag) => !!tag)
-        .map((tag) => {
-        const value = tag.split(',');
-        return {
-            creatorDate: value[0],
-            tag: value[1],
-        };
-    });
-});
-const getReleaseCommits = (toTag, fromTag, blacklistPattern) => __awaiter(void 0, void 0, void 0, function* () {
-    const separator = '_||_';
-    const command = `git log ${fromTag}..${toTag} --no-merges --pretty=format:"%ad${separator}%h${separator}%ae${separator}%s"`;
-    const logResult = yield (0, async_1.execAsync)(command);
-    return logResult.stdout
-        .split('\n')
-        .filter((message) => !!message)
-        .map((message) => {
-        const data = message.split(separator);
-        return {
-            date: new Date(data[0]),
-            hash: data[1],
-            author: data[2],
-            subject: data[3],
-        };
-    })
-        .filter((commit) => {
-        if (!blacklistPattern) {
-            return true;
-        }
-        return !new RegExp(blacklistPattern, 'gm').test(commit.subject);
-    });
-});
-const groupCommitsByTags = (blacklistPattern) => __awaiter(void 0, void 0, void 0, function* () {
-    var e_1, _a;
-    const releaseCommits = [];
-    const headTag = {
-        creatorDate: new Date().toISOString().slice(0, 10),
-        tag: 'HEAD',
-    };
-    const allTags = [headTag, ...(yield getReleaseTags())];
-    try {
-        for (var _b = __asyncValues(allTags.slice(0, -1).entries()), _c; _c = yield _b.next(), !_c.done;) {
-            const [index, value] = _c.value;
-            const previousTag = allTags[index + 1].tag;
-            const commits = yield getReleaseCommits(value.tag, previousTag, blacklistPattern);
-            releaseCommits.push({
-                commits,
-                previousTag,
-                tag: value.tag,
-                date: new Date(value.creatorDate),
-            });
-        }
-    }
-    catch (e_1_1) { e_1 = { error: e_1_1 }; }
-    finally {
-        try {
-            if (_c && !_c.done && (_a = _b.return)) yield _a.call(_b);
-        }
-        finally { if (e_1) throw e_1.error; }
-    }
-    return releaseCommits;
-});
-exports.groupCommitsByTags = groupCommitsByTags;

package/lib/core/markdown.d.ts

@@ -1,8 +0,0 @@
-import { Config } from '../models';
-/**
- * Returns a changelog formatted in Markdown syntax
- * @param config Config
- * @returns Text in Markdown syntax
- */
-declare const createMarkdown: (config?: Config | undefined) => Promise<string>;
-export { createMarkdown };

package/lib/core/markdown.js

@@ -1,85 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createMarkdown = void 0;
-const default_1 = require("./default");
-const git_1 = require("./git");
-const createLink = (linkText, url) => {
-    return `[${linkText}](${url})`;
-};
-const formatDate = (date) => {
-    return date.toLocaleString('en', {
-        month: 'long',
-        day: 'numeric',
-        year: 'numeric',
-    });
-};
-const ticketRecognition = (commitMessage) => {
-    var _a, _b;
-    return (_b = (_a = commitMessage.match(/\((?<ticket>#\d+)\)/)) === null || _a === void 0 ? void 0 : _a.groups) === null || _b === void 0 ? void 0 : _b.ticket;
-};
-const createReleaseSubtitle = (group, repository) => {
-    const latestTag = 'v' + process.env.npm_package_version;
-    const unreleasedChanges = latestTag === group.previousTag;
-    const latestVersion = unreleasedChanges ? 'Unreleased changes' : latestTag;
-    const tagIsHead = group.tag === 'HEAD';
-    const subtitleLinkText = tagIsHead ? latestVersion : group.tag;
-    const subtitleLinkCurrentTag = tagIsHead
-        ? unreleasedChanges
-            ? 'HEAD'
-            : latestTag
-        : group.tag;
-    const subtitleLink = `${repository}/compare/${group.previousTag}...${subtitleLinkCurrentTag}`;
-    const subtitle = `${createLink(subtitleLinkText, subtitleLink)}`;
-    return `#### ${repository ? subtitle : subtitleLinkText}`;
-};
-const createDateInformation = (group) => {
-    return `> ${formatDate(group.date)}`;
-};
-const createCommitList = (group, repository) => {
-    return group.commits.reduce((result, commit) => {
-        const ticket = ticketRecognition(commit.subject);
-        let reference = '';
-        if (ticket) {
-            commit.subject = commit.subject.replace(`(${ticket})`, ''); // remove ticket number
-            const ticketLinkText = `\`${ticket}\``;
-            reference = repository
-                ? createLink(ticketLinkText, `${repository}/pull/${ticket.slice(1)}`)
-                : ticketLinkText;
-        }
-        else {
-            const commitHashText = `\`${commit.hash}\``;
-            reference = repository
-                ? createLink(commitHashText, `${repository}/commit/${commit.hash}`)
-                : commitHashText;
-        }
-        return (result +
-            `- ${commit.subject.replace(/[<<]/, '&lt;').trim()} ${reference}\n`);
-    }, '');
-};
-/**
- * Returns a changelog formatted in Markdown syntax
- * @param config Config
- * @returns Text in Markdown syntax
- */
-const createMarkdown = (config) => __awaiter(void 0, void 0, void 0, function* () {
-    var _a, _b;
-    const title = `### ${(_a = config === null || config === void 0 ? void 0 : config.title) !== null && _a !== void 0 ? _a : default_1.defaultConfig.title} \n\n ${(_b = config === null || config === void 0 ? void 0 : config.description) !== null && _b !== void 0 ? _b : default_1.defaultConfig.description}\n\n`;
-    const tagGroups = yield (0, git_1.groupCommitsByTags)(config === null || config === void 0 ? void 0 : config.blacklistPattern);
-    return (title +
-        tagGroups.reduce((markdown, group) => {
-            const subtitle = createReleaseSubtitle(group, config === null || config === void 0 ? void 0 : config.repositoryUrl);
-            const date = createDateInformation(group);
-            const commitList = createCommitList(group, config === null || config === void 0 ? void 0 : config.repositoryUrl);
-            return `${markdown} \n${subtitle} \n\n${date} \n\n${commitList}`;
-        }, ''));
-});
-exports.createMarkdown = createMarkdown;

package/lib/core/test-helpers.d.ts

@@ -1,6 +0,0 @@
-import { MockedFunction } from 'ts-jest/dist/utils/testing';
-export declare const createExecAsyncMock: () => MockedFunction<() => Promise<{
-    stdout: string;
-    stderr: string;
-}>>;
-export declare const mockNewDateTime: () => void;

package/lib/core/test-helpers.js

@@ -1,14 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.mockNewDateTime = exports.createExecAsyncMock = void 0;
-const jest_mock_1 = require("jest-mock");
-const async_1 = require("./async");
-const createExecAsyncMock = () => {
-    const mockExecAsync = (0, jest_mock_1.mocked)(async_1.execAsync);
-    return mockExecAsync;
-};
-exports.createExecAsyncMock = createExecAsyncMock;
-const mockNewDateTime = () => {
-    jest.useFakeTimers().setSystemTime(new Date('2022-02-08').getTime());
-};
-exports.mockNewDateTime = mockNewDateTime;

package/lib/models/commit.d.ts

@@ -1,6 +0,0 @@
-export interface Commit {
-    date: Date;
-    hash: string;
-    author: string;
-    subject: string;
-}

package/lib/models/commit.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/lib/models/config.d.ts

@@ -1,30 +0,0 @@
-export interface Config {
-    /**
-     * Name of the file in which the output should be written. Can also include a path name.
-     * @default `CHANGELOG.md`
-     * @optional
-     */
-    filePath?: string;
-    /**
-     * Title of the page
-     * @default `Changelog`
-     * @optional
-     */
-    title?: string;
-    /**
-     * Description of the page
-     * @default `All notable changes to this project will be documented in this file. Dates are displayed in UTC.`
-     * @optional
-     */
-    description?: string;
-    /**
-     * URL of the repository
-     * @optional If not set, no links will be provided.
-     */
-    repositoryUrl?: string;
-    /**
-     * Regular expression pattern to exclude commit messages
-     * @optional
-     */
-    blacklistPattern?: string;
-}

package/lib/models/config.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/lib/models/index.d.ts

@@ -1,3 +0,0 @@
-export * from './commit';
-export * from './config';
-export * from './tagGroup';

package/lib/models/index.js

@@ -1,15 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./commit"), exports);
-__exportStar(require("./config"), exports);
-__exportStar(require("./tagGroup"), exports);

package/lib/models/tagGroup.d.ts

@@ -1,7 +0,0 @@
-import { Commit } from './commit';
-export interface TagGroup {
-    commits: Commit[];
-    previousTag: string;
-    tag: string;
-    date: Date;
-}

package/lib/models/tagGroup.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });