conventional-commits-parser 4.0.0 → 6.0.0

package/dist/regex.js

@@ -0,0 +1,49 @@
+const nomatchRegex = /(?!.*)/;
+function join(parts, joiner) {
+    return parts
+        .map(val => val.trim())
+        .filter(Boolean)
+        .join(joiner);
+}
+function getNotesRegex(noteKeywords, notesPattern) {
+    if (!noteKeywords) {
+        return nomatchRegex;
+    }
+    const noteKeywordsSelection = join(noteKeywords, '|');
+    if (!notesPattern) {
+        return new RegExp(`^[\\s|*]*(${noteKeywordsSelection})[:\\s]+(.*)`, 'i');
+    }
+    return notesPattern(noteKeywordsSelection);
+}
+function getReferencePartsRegex(issuePrefixes, issuePrefixesCaseSensitive) {
+    if (!issuePrefixes) {
+        return nomatchRegex;
+    }
+    const flags = issuePrefixesCaseSensitive ? 'g' : 'gi';
+    return new RegExp(`(?:.*?)??\\s*([\\w-\\.\\/]*?)??(${join(issuePrefixes, '|')})([\\w-]*\\d+)`, flags);
+}
+function getReferencesRegex(referenceActions) {
+    if (!referenceActions) {
+        // matches everything
+        return /()(.+)/gi;
+    }
+    const joinedKeywords = join(referenceActions, '|');
+    return new RegExp(`(${joinedKeywords})(?:\\s+(.*?))(?=(?:${joinedKeywords})|$)`, 'gi');
+}
+/**
+ * Make the regexes used to parse a commit.
+ * @param options
+ * @returns Regexes.
+ */
+export function getParserRegexes(options = {}) {
+    const notes = getNotesRegex(options.noteKeywords, options.notesPattern);
+    const referenceParts = getReferencePartsRegex(options.issuePrefixes, options.issuePrefixesCaseSensitive);
+    const references = getReferencesRegex(options.referenceActions);
+    return {
+        notes,
+        referenceParts,
+        references,
+        mentions: /@([\w-]+)/g
+    };
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicmVnZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvcmVnZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBS0EsTUFBTSxZQUFZLEdBQUcsUUFBUSxDQUFBO0FBRTdCLFNBQVMsSUFBSSxDQUFDLEtBQWUsRUFBRSxNQUFjO0lBQzNDLE9BQU8sS0FBSztTQUNULEdBQUcsQ0FBQyxHQUFHLENBQUMsRUFBRSxDQUFDLEdBQUcsQ0FBQyxJQUFJLEVBQUUsQ0FBQztTQUN0QixNQUFNLENBQUMsT0FBTyxDQUFDO1NBQ2YsSUFBSSxDQUFDLE1BQU0sQ0FBQyxDQUFBO0FBQ2pCLENBQUM7QUFFRCxTQUFTLGFBQWEsQ0FDcEIsWUFBa0MsRUFDbEMsWUFBb0Q7SUFFcEQsSUFBSSxDQUFDLFlBQVksRUFBRTtRQUNqQixPQUFPLFlBQVksQ0FBQTtLQUNwQjtJQUVELE1BQU0scUJBQXFCLEdBQUcsSUFBSSxDQUFDLFlBQVksRUFBRSxHQUFHLENBQUMsQ0FBQTtJQUVyRCxJQUFJLENBQUMsWUFBWSxFQUFFO1FBQ2pCLE9BQU8sSUFBSSxNQUFNLENBQUMsYUFBYSxxQkFBcUIsY0FBYyxFQUFFLEdBQUcsQ0FBQyxDQUFBO0tBQ3pFO0lBRUQsT0FBTyxZQUFZLENBQUMscUJBQXFCLENBQUMsQ0FBQTtBQUM1QyxDQUFDO0FBRUQsU0FBUyxzQkFBc0IsQ0FDN0IsYUFBbUMsRUFDbkMsMEJBQStDO0lBRS9DLElBQUksQ0FBQyxhQUFhLEVBQUU7UUFDbEIsT0FBTyxZQUFZLENBQUE7S0FDcEI7SUFFRCxNQUFNLEtBQUssR0FBRywwQkFBMEIsQ0FBQyxDQUFDLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQyxJQUFJLENBQUE7SUFFckQsT0FBTyxJQUFJLE1BQU0sQ0FBQyxtQ0FBbUMsSUFBSSxDQUFDLGFBQWEsRUFBRSxHQUFHLENBQUMsZ0JBQWdCLEVBQUUsS0FBSyxDQUFDLENBQUE7QUFDdkcsQ0FBQztBQUVELFNBQVMsa0JBQWtCLENBQ3pCLGdCQUFzQztJQUV0QyxJQUFJLENBQUMsZ0JBQWdCLEVBQUU7UUFDckIscUJBQXFCO1FBQ3JCLE9BQU8sVUFBVSxDQUFBO0tBQ2xCO0lBRUQsTUFBTSxjQUFjLEdBQUcsSUFBSSxDQUFDLGdCQUFnQixFQUFFLEdBQUcsQ0FBQyxDQUFBO0lBRWxELE9BQU8sSUFBSSxNQUFNLENBQUMsSUFBSSxjQUFjLHVCQUF1QixjQUFjLE1BQU0sRUFBRSxJQUFJLENBQUMsQ0FBQTtBQUN4RixDQUFDO0FBRUQ7Ozs7R0FJRztBQUNILE1BQU0sVUFBVSxnQkFBZ0IsQ0FDOUIsVUFBc0ksRUFBRTtJQUV4SSxNQUFNLEtBQUssR0FBRyxhQUFhLENBQUMsT0FBTyxDQUFDLFlBQVksRUFBRSxPQUFPLENBQUMsWUFBWSxDQUFDLENBQUE7SUFDdkUsTUFBTSxjQUFjLEdBQUcsc0JBQXNCLENBQUMsT0FBTyxDQUFDLGFBQWEsRUFBRSxPQUFPLENBQUMsMEJBQTBCLENBQUMsQ0FBQTtJQUN4RyxNQUFNLFVBQVUsR0FBRyxrQkFBa0IsQ0FBQyxPQUFPLENBQUMsZ0JBQWdCLENBQUMsQ0FBQTtJQUUvRCxPQUFPO1FBQ0wsS0FBSztRQUNMLGNBQWM7UUFDZCxVQUFVO1FBQ1YsUUFBUSxFQUFFLFlBQVk7S0FDdkIsQ0FBQTtBQUNILENBQUMifQ==

package/dist/stream.d.ts

@@ -0,0 +1,16 @@
+/// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" resolution-mode="require"/>
+import type { ParserStreamOptions } from './types.js';
+/**
+ * Create async generator function to parse async iterable of raw commits.
+ * @param options - CommitParser options.
+ * @returns Async generator function to parse async iterable of raw commits.
+ */
+export declare function parseCommits(options?: ParserStreamOptions): (rawCommits: Iterable<string | Buffer> | AsyncIterable<string | Buffer>) => AsyncGenerator<import("./types.js").Commit, void, unknown>;
+/**
+ * Create stream to parse commits.
+ * @param options - CommitParser options.
+ * @returns Stream of parsed commits.
+ */
+export declare function parseCommitsStream(options?: ParserStreamOptions): import("stream").Duplex;
+//# sourceMappingURL=stream.d.ts.map

package/dist/stream.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stream.d.ts","sourceRoot":"","sources":["../src/stream.ts"],"names":[],"mappings":";;AACA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAA;AAGrD;;;;GAIG;AACH,wBAAgB,YAAY,CAC1B,OAAO,GAAE,mBAAwB,gBAYnB,SAAS,MAAM,GAAG,MAAM,CAAC,GAAG,cAAc,MAAM,GAAG,MAAM,CAAC,gEAazE;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,GAAE,mBAAwB,2BAEnE"}

package/dist/stream.js

@@ -0,0 +1,38 @@
+import { Transform } from 'stream';
+import { CommitParser } from './CommitParser.js';
+/**
+ * Create async generator function to parse async iterable of raw commits.
+ * @param options - CommitParser options.
+ * @returns Async generator function to parse async iterable of raw commits.
+ */
+export function parseCommits(options = {}) {
+    const warnOption = options.warn;
+    const warn = warnOption === true
+        ? (err) => {
+            throw err;
+        }
+        : warnOption
+            ? (err) => warnOption(err.toString())
+            : () => { };
+    return async function* parse(rawCommits) {
+        const parser = new CommitParser(options);
+        let rawCommit;
+        for await (rawCommit of rawCommits) {
+            try {
+                yield parser.parse(rawCommit.toString());
+            }
+            catch (err) {
+                warn(err);
+            }
+        }
+    };
+}
+/**
+ * Create stream to parse commits.
+ * @param options - CommitParser options.
+ * @returns Stream of parsed commits.
+ */
+export function parseCommitsStream(options = {}) {
+    return Transform.from(parseCommits(options));
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic3RyZWFtLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL3N0cmVhbS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQUUsU0FBUyxFQUFFLE1BQU0sUUFBUSxDQUFBO0FBRWxDLE9BQU8sRUFBRSxZQUFZLEVBQUUsTUFBTSxtQkFBbUIsQ0FBQTtBQUVoRDs7OztHQUlHO0FBQ0gsTUFBTSxVQUFVLFlBQVksQ0FDMUIsVUFBK0IsRUFBRTtJQUVqQyxNQUFNLFVBQVUsR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFBO0lBQy9CLE1BQU0sSUFBSSxHQUFHLFVBQVUsS0FBSyxJQUFJO1FBQzlCLENBQUMsQ0FBQyxDQUFDLEdBQVUsRUFBRSxFQUFFO1lBQ2YsTUFBTSxHQUFHLENBQUE7UUFDWCxDQUFDO1FBQ0QsQ0FBQyxDQUFDLFVBQVU7WUFDVixDQUFDLENBQUMsQ0FBQyxHQUFVLEVBQUUsRUFBRSxDQUFDLFVBQVUsQ0FBQyxHQUFHLENBQUMsUUFBUSxFQUFFLENBQUM7WUFDNUMsQ0FBQyxDQUFDLEdBQUcsRUFBRSxHQUFjLENBQUMsQ0FBQTtJQUUxQixPQUFPLEtBQUssU0FBUyxDQUFDLENBQUMsS0FBSyxDQUMxQixVQUFzRTtRQUV0RSxNQUFNLE1BQU0sR0FBRyxJQUFJLFlBQVksQ0FBQyxPQUFPLENBQUMsQ0FBQTtRQUN4QyxJQUFJLFNBQTBCLENBQUE7UUFFOUIsSUFBSSxLQUFLLEVBQUUsU0FBUyxJQUFJLFVBQVUsRUFBRTtZQUNsQyxJQUFJO2dCQUNGLE1BQU0sTUFBTSxDQUFDLEtBQUssQ0FBQyxTQUFTLENBQUMsUUFBUSxFQUFFLENBQUMsQ0FBQTthQUN6QztZQUFDLE9BQU8sR0FBRyxFQUFFO2dCQUNaLElBQUksQ0FBQyxHQUFZLENBQUMsQ0FBQTthQUNuQjtTQUNGO0lBQ0gsQ0FBQyxDQUFBO0FBQ0gsQ0FBQztBQUVEOzs7O0dBSUc7QUFDSCxNQUFNLFVBQVUsa0JBQWtCLENBQUMsVUFBK0IsRUFBRTtJQUNsRSxPQUFPLFNBQVMsQ0FBQyxJQUFJLENBQUMsWUFBWSxDQUFDLE9BQU8sQ0FBQyxDQUFDLENBQUE7QUFDOUMsQ0FBQyJ9

package/dist/types.d.ts

@@ -0,0 +1,98 @@
+export interface ParserOptions {
+    /**
+     * Character used to comment out a line.
+     */
+    commentChar?: string;
+    /**
+     * Pattern to match merge headers. EG: branch merge, GitHub or GitLab like pull requests headers.
+     * When a merge header is parsed, the next line is used for conventional header parsing.
+     */
+    mergePattern?: RegExp;
+    /**
+     * Used to define what capturing group of `mergePattern`.
+     */
+    mergeCorrespondence?: string[];
+    /**
+     * Used to match header pattern.
+     */
+    headerPattern?: RegExp;
+    /**
+     * Breaking changes header pattern.
+     */
+    breakingHeaderPattern?: RegExp;
+    /**
+     * Used to define what capturing group of `headerPattern` captures what header part.
+     * The order of the array should correspond to the order of `headerPattern`'s capturing group.
+     */
+    headerCorrespondence?: string[];
+    /**
+     * Pattern to match what this commit reverts.
+     */
+    revertPattern?: RegExp;
+    /**
+     * Used to define what capturing group of `revertPattern` captures what reverted commit fields.
+     * The order of the array should correspond to the order of `revertPattern`'s capturing group.
+     */
+    revertCorrespondence?: string[];
+    /**
+     * Pattern to match other fields.
+     */
+    fieldPattern?: RegExp;
+    /**
+     * Keywords for important notes. This value is case **insensitive**.
+     */
+    noteKeywords?: string[];
+    /**
+     * A function that takes `noteKeywordsSelection` and returns a `RegExp` to be matched against the notes.
+     */
+    notesPattern?(text: string): RegExp;
+    /**
+     * The prefixes of an issue. EG: In `gh-123` `gh-` is the prefix.
+     */
+    issuePrefixes?: string[];
+    /**
+     * Used to define if `issuePrefixes` should be considered case sensitive.
+     */
+    issuePrefixesCaseSensitive?: boolean;
+    /**
+     * Keywords to reference an issue. This value is case **insensitive**.
+     */
+    referenceActions?: string[];
+}
+export interface ParserStreamOptions extends ParserOptions {
+    /**
+     * What warn function to use. For example, `console.warn.bind(console)`. By default, it's a noop. If it is `true`, it will error if commit cannot be parsed (strict).
+     */
+    warn?: boolean | ((message: string) => void);
+}
+export interface ParserRegexes {
+    notes: RegExp;
+    referenceParts: RegExp;
+    references: RegExp;
+    mentions: RegExp;
+}
+export interface CommitReference {
+    raw: string;
+    action: string | null;
+    owner: string | null;
+    repository: string | null;
+    issue: string;
+    prefix: string;
+}
+export interface CommitNote {
+    title: string;
+    text: string;
+}
+export type CommitMeta = Record<string, string | null>;
+export interface CommitBase {
+    merge: string | null;
+    revert: CommitMeta | null;
+    header: string | null;
+    body: string | null;
+    footer: string | null;
+    notes: CommitNote[];
+    mentions: string[];
+    references: CommitReference[];
+}
+export type Commit = CommitBase & CommitMeta;
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAA;IAC9B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAA;IAC9B;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAA;IAC/B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAA;IAC/B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,CAAA;IACvB;;OAEG;IACH,YAAY,CAAC,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;IACnC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAA;IACxB;;OAEG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAA;IACpC;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAA;CAC5B;AAED,MAAM,WAAW,mBAAoB,SAAQ,aAAa;IACxD;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,GAAG,CAAC,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC,CAAA;CAC7C;AAED,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,MAAM,CAAA;IACb,cAAc,EAAE,MAAM,CAAA;IACtB,UAAU,EAAE,MAAM,CAAA;IAClB,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,WAAW,eAAe;IAC9B,GAAG,EAAE,MAAM,CAAA;IACX,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,UAAU;IACzB,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC,CAAA;AAEtD,MAAM,WAAW,UAAU;IACzB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,MAAM,EAAE,UAAU,GAAG,IAAI,CAAA;IACzB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,KAAK,EAAE,UAAU,EAAE,CAAA;IACnB,QAAQ,EAAE,MAAM,EAAE,CAAA;IAClB,UAAU,EAAE,eAAe,EAAE,CAAA;CAC9B;AAED,MAAM,MAAM,MAAM,GAAG,UAAU,GAAG,UAAU,CAAA"}

package/dist/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvdHlwZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiJ9

package/dist/utils.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Remove leading and trailing newlines.
+ * @param input
+ * @returns String without leading and trailing newlines.
+ */
+export declare function trimNewLines(input: string): string;
+/**
+ * Append a newline to a string.
+ * @param src
+ * @param line
+ * @returns String with appended newline.
+ */
+export declare function appendLine(src: string | null, line: string | undefined): string;
+/**
+ * Creates a function that filters out comments lines.
+ * @param char
+ * @returns Comment filter function.
+ */
+export declare function getCommentFilter(char: string | undefined): (line: string) => boolean;
+/**
+ * Select lines before the scissor.
+ * @param lines
+ * @returns Lines before the scissor.
+ */
+export declare function truncateToScissor(lines: string[]): string[];
+/**
+ * Filter out GPG sign lines.
+ * @param line
+ * @returns True if the line is not a GPG sign line.
+ */
+export declare function gpgFilter(line: string): boolean;
+//# sourceMappingURL=utils.d.ts.map

package/dist/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,UAiBzC;AAED;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,EAAE,IAAI,EAAE,MAAM,GAAG,SAAS,UAEtE;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,UAE5C,MAAM,aAElB;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,MAAM,EAAE,YAQhD;AAED;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,WAErC"}

package/dist/utils.js

@@ -0,0 +1,59 @@
+const SCISSOR = '# ------------------------ >8 ------------------------';
+/**
+ * Remove leading and trailing newlines.
+ * @param input
+ * @returns String without leading and trailing newlines.
+ */
+export function trimNewLines(input) {
+    // To escape ReDos we should escape String#replace with regex.
+    const matches = input.match(/[^\r\n]/);
+    if (typeof matches?.index !== 'number') {
+        return '';
+    }
+    const firstIndex = matches.index;
+    let lastIndex = input.length - 1;
+    while (input[lastIndex] === '\r' || input[lastIndex] === '\n') {
+        lastIndex--;
+    }
+    return input.substring(firstIndex, lastIndex + 1);
+}
+/**
+ * Append a newline to a string.
+ * @param src
+ * @param line
+ * @returns String with appended newline.
+ */
+export function appendLine(src, line) {
+    return src ? `${src}\n${line || ''}` : line || '';
+}
+/**
+ * Creates a function that filters out comments lines.
+ * @param char
+ * @returns Comment filter function.
+ */
+export function getCommentFilter(char) {
+    return char
+        ? (line) => !line.startsWith(char)
+        : () => true;
+}
+/**
+ * Select lines before the scissor.
+ * @param lines
+ * @returns Lines before the scissor.
+ */
+export function truncateToScissor(lines) {
+    const scissorIndex = lines.indexOf(SCISSOR);
+    if (scissorIndex === -1) {
+        return lines;
+    }
+    return lines.slice(0, scissorIndex);
+}
+/**
+ * Filter out GPG sign lines.
+ * @param line
+ * @returns True if the line is not a GPG sign line.
+ */
+export function gpgFilter(line) {
+    return !line.match(/^\s*gpg:/);
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidXRpbHMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvdXRpbHMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsTUFBTSxPQUFPLEdBQUcsd0RBQXdELENBQUE7QUFFeEU7Ozs7R0FJRztBQUNILE1BQU0sVUFBVSxZQUFZLENBQUMsS0FBYTtJQUN4Qyw4REFBOEQ7SUFFOUQsTUFBTSxPQUFPLEdBQUcsS0FBSyxDQUFDLEtBQUssQ0FBQyxTQUFTLENBQUMsQ0FBQTtJQUV0QyxJQUFJLE9BQU8sT0FBTyxFQUFFLEtBQUssS0FBSyxRQUFRLEVBQUU7UUFDdEMsT0FBTyxFQUFFLENBQUE7S0FDVjtJQUVELE1BQU0sVUFBVSxHQUFHLE9BQU8sQ0FBQyxLQUFLLENBQUE7SUFDaEMsSUFBSSxTQUFTLEdBQUcsS0FBSyxDQUFDLE1BQU0sR0FBRyxDQUFDLENBQUE7SUFFaEMsT0FBTyxLQUFLLENBQUMsU0FBUyxDQUFDLEtBQUssSUFBSSxJQUFJLEtBQUssQ0FBQyxTQUFTLENBQUMsS0FBSyxJQUFJLEVBQUU7UUFDN0QsU0FBUyxFQUFFLENBQUE7S0FDWjtJQUVELE9BQU8sS0FBSyxDQUFDLFNBQVMsQ0FBQyxVQUFVLEVBQUUsU0FBUyxHQUFHLENBQUMsQ0FBQyxDQUFBO0FBQ25ELENBQUM7QUFFRDs7Ozs7R0FLRztBQUNILE1BQU0sVUFBVSxVQUFVLENBQUMsR0FBa0IsRUFBRSxJQUF3QjtJQUNyRSxPQUFPLEdBQUcsQ0FBQyxDQUFDLENBQUMsR0FBRyxHQUFHLEtBQUssSUFBSSxJQUFJLEVBQUUsRUFBRSxDQUFDLENBQUMsQ0FBQyxJQUFJLElBQUksRUFBRSxDQUFBO0FBQ25ELENBQUM7QUFFRDs7OztHQUlHO0FBQ0gsTUFBTSxVQUFVLGdCQUFnQixDQUFDLElBQXdCO0lBQ3ZELE9BQU8sSUFBSTtRQUNULENBQUMsQ0FBQyxDQUFDLElBQVksRUFBRSxFQUFFLENBQUMsQ0FBQyxJQUFJLENBQUMsVUFBVSxDQUFDLElBQUksQ0FBQztRQUMxQyxDQUFDLENBQUMsR0FBRyxFQUFFLENBQUMsSUFBSSxDQUFBO0FBQ2hCLENBQUM7QUFFRDs7OztHQUlHO0FBQ0gsTUFBTSxVQUFVLGlCQUFpQixDQUFDLEtBQWU7SUFDL0MsTUFBTSxZQUFZLEdBQUcsS0FBSyxDQUFDLE9BQU8sQ0FBQyxPQUFPLENBQUMsQ0FBQTtJQUUzQyxJQUFJLFlBQVksS0FBSyxDQUFDLENBQUMsRUFBRTtRQUN2QixPQUFPLEtBQUssQ0FBQTtLQUNiO0lBRUQsT0FBTyxLQUFLLENBQUMsS0FBSyxDQUFDLENBQUMsRUFBRSxZQUFZLENBQUMsQ0FBQTtBQUNyQyxDQUFDO0FBRUQ7Ozs7R0FJRztBQUNILE1BQU0sVUFBVSxTQUFTLENBQUMsSUFBWTtJQUNwQyxPQUFPLENBQUMsSUFBSSxDQUFDLEtBQUssQ0FBQyxVQUFVLENBQUMsQ0FBQTtBQUNoQyxDQUFDIn0=

package/package.json

@@ -1,29 +1,23 @@
 {
   "name": "conventional-commits-parser",
-  "version": "4.0.0",
-  "description": "Parse raw conventional commits",
-  "bugs": {
-    "url": "https://github.com/conventional-changelog/conventional-changelog/issues"
-  },
-  "homepage": "https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-commits-parser#readme",
+  "type": "module",
+  "version": "6.0.0",
+  "description": "Parse raw conventional commits.",
   "author": {
     "name": "Steve Mao",
     "email": "maochenyan@gmail.com",
     "url": "https://github.com/stevemao"
   },
+  "license": "MIT",
+  "homepage": "https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-commits-parser#readme",
   "repository": {
     "type": "git",
-    "url": "https://github.com/conventional-changelog/conventional-changelog.git"
+    "url": "https://github.com/conventional-changelog/conventional-changelog.git",
+    "directory": "packages/conventional-commits-parser"
   },
-  "license": "MIT",
-  "engines": {
-    "node": ">=14"
+  "bugs": {
+    "url": "https://github.com/conventional-changelog/conventional-changelog/issues"
   },
-  "files": [
-    "index.js",
-    "cli.js",
-    "lib"
-  ],
   "keywords": [
     "conventional-commits-parser",
     "changelog",
@@ -32,19 +26,20 @@
     "parsing",
     "logs"
   ],
-  "dependencies": {
-    "JSONStream": "^1.3.5",
-    "is-text-path": "^1.0.1",
-    "meow": "^8.1.2",
-    "split2": "^3.2.2"
+  "engines": {
+    "node": ">=18"
   },
-  "bin": {
-    "conventional-commits-parser": "cli.js"
+  "exports": {
+    "types": "./dist/index.d.ts",
+    "import": "./dist/index.js"
   },
-  "devDependencies": {
-    "forceable-tty": "^0.1.0"
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "meow": "^13.0.0"
   },
-  "scripts": {
-    "test-windows": "echo 'make work on windows'"
+  "bin": {
+    "conventional-commits-parser": "./dist/cli/index.js"
   }
 }

package/cli.js

@@ -1,170 +0,0 @@
-#!/usr/bin/env node
-'use strict'
-const conventionalCommitsParser = require('./')
-const fs = require('fs')
-const { Transform } = require('stream')
-const isTextPath = require('is-text-path')
-const JSONStream = require('JSONStream')
-const meow = require('meow')
-const readline = require('readline')
-const split = require('split2')
-
-const filePaths = []
-let separator = '\n\n\n'
-
-const cli = meow(`
-    Practice writing commit messages or parse messages from files.
-    If used without specifying a text file path, you will enter an interactive shell.
-    Otherwise the commit messages in the files are parsed and printed
-    By default, commits will be split by three newlines ('\\n\\n\\n') or you can specify a separator.
-
-    Usage
-      conventional-commits-parser [<commit-separator>]
-      conventional-commits-parser [<commit-separator>] <path> [<path> ...]
-      cat <path> | conventional-commits-parser [<commit-separator>]
-
-    Example
-      conventional-commits-parser
-      conventional-commits-parser log.txt
-      cat log.txt | conventional-commits-parser
-      conventional-commits-parser log2.txt '===' >> parsed.txt
-
-    Options
-      -p, --header-pattern              Regex to match header pattern
-      -c, --header-correspondence       Comma separated parts used to define what capturing group of 'headerPattern' captures what
-      -r, --reference-actions           Comma separated keywords that used to reference issues
-      -i, --issue-prefixes              Comma separated prefixes of an issue
-      --issue-prefixes-case-sensitive   Treat issue prefixes as case sensitive
-      -n, --note-keywords               Comma separated keywords for important notes
-      -f, --field-pattern               Regex to match other fields
-      --revert-pattern                  Regex to match revert pattern
-      --revert-correspondence           Comma separated fields used to define what the commit reverts
-      -v, --verbose                     Verbose output
-`, {
-  flags: {
-    'header-pattern': {
-      alias: 'p',
-      type: 'string'
-    },
-    'header-correspondence': {
-      alias: 'c',
-      type: 'string'
-    },
-    'reference-actions': {
-      alias: 'r',
-      type: 'string'
-    },
-    'issue-prefixes': {
-      alias: 'i',
-      type: 'string'
-    },
-    'issue-prefixes-case-sensitive': {
-      type: 'boolean'
-    },
-    'note-keywords': {
-      alias: 'n',
-      type: 'string'
-    },
-    'field-pattern': {
-      alias: 'f',
-      type: 'string'
-    },
-    'revert-pattern': {
-      type: 'string'
-    },
-    'revert-correspondence': {
-      type: 'string'
-    },
-    verbose: {
-      alias: 'v',
-      type: 'boolean'
-    }
-  }
-})
-
-cli.input.forEach(function (arg) {
-  if (isTextPath(arg)) {
-    filePaths.push(arg)
-  } else {
-    separator = arg
-  }
-})
-
-const length = filePaths.length
-const options = cli.flags
-
-if (options.verbose) {
-  options.warn = console.log.bind(console)
-}
-
-function processFile (fileIndex) {
-  const filePath = filePaths[fileIndex]
-  fs.createReadStream(filePath)
-    .on('error', function (err) {
-      console.warn('Failed to read file ' + filePath + '\n' + err)
-      if (++fileIndex < length) {
-        processFile(fileIndex)
-      }
-    })
-    .pipe(split(separator))
-    .pipe(conventionalCommitsParser(options))
-    .pipe(JSONStream.stringify())
-    .on('end', function () {
-      if (++fileIndex < length) {
-        processFile(fileIndex)
-      }
-    })
-    .pipe(process.stdout)
-}
-
-if (process.stdin.isTTY) {
-  if (length > 0) {
-    processFile(0)
-  } else {
-    let commit = ''
-    const stream = new Transform({
-      transform: (chunk, enc, cb) => cb(null, chunk)
-    })
-    const rl = readline.createInterface({
-      input: process.stdin,
-      output: process.stdout,
-      terminal: true
-    })
-
-    stream.pipe(conventionalCommitsParser(options))
-      .pipe(JSONStream.stringify('', '', ''))
-      .pipe(
-        new Transform({
-          transform (chunk, enc, cb) {
-            if (chunk.toString() === '""') {
-              cb(null, 'Commit cannot be parsed\n')
-            } else {
-              cb(null, chunk + '\n')
-            }
-          }
-        })
-      )
-      .pipe(process.stdout)
-
-    rl.on('line', function (line) {
-      commit += line + '\n'
-      if (commit.indexOf(separator) === -1) {
-        return
-      }
-
-      stream.write(commit)
-      commit = ''
-    })
-  }
-} else {
-  options.warn = true
-  process.stdin
-    .pipe(split(separator))
-    .pipe(conventionalCommitsParser(options))
-    .on('error', function (err) {
-      console.error(err.toString())
-      process.exit(1)
-    })
-    .pipe(JSONStream.stringify())
-    .pipe(process.stdout)
-}

package/index.js

@@ -1,105 +0,0 @@
-'use strict'
-
-const { Transform } = require('stream')
-const parser = require('./lib/parser')
-const regex = require('./lib/regex')
-
-function assignOpts (options) {
-  options = {
-    headerPattern: /^(\w*)(?:\(([\w$.\-*/ ]*)\))?: (.*)$/,
-    headerCorrespondence: ['type', 'scope', 'subject'],
-    referenceActions: [
-      'close',
-      'closes',
-      'closed',
-      'fix',
-      'fixes',
-      'fixed',
-      'resolve',
-      'resolves',
-      'resolved'
-    ],
-    issuePrefixes: ['#'],
-    noteKeywords: ['BREAKING CHANGE', 'BREAKING-CHANGE'],
-    fieldPattern: /^-(.*?)-$/,
-    revertPattern: /^Revert\s"([\s\S]*)"\s*This reverts commit (\w*)\./,
-    revertCorrespondence: ['header', 'hash'],
-    warn: function () {},
-    mergePattern: null,
-    mergeCorrespondence: null,
-    ...options
-  }
-
-  if (typeof options.headerPattern === 'string') {
-    options.headerPattern = new RegExp(options.headerPattern)
-  }
-
-  if (typeof options.headerCorrespondence === 'string') {
-    options.headerCorrespondence = options.headerCorrespondence.split(',')
-  }
-
-  if (typeof options.referenceActions === 'string') {
-    options.referenceActions = options.referenceActions.split(',')
-  }
-
-  if (typeof options.issuePrefixes === 'string') {
-    options.issuePrefixes = options.issuePrefixes.split(',')
-  }
-
-  if (typeof options.noteKeywords === 'string') {
-    options.noteKeywords = options.noteKeywords.split(',')
-  }
-
-  if (typeof options.fieldPattern === 'string') {
-    options.fieldPattern = new RegExp(options.fieldPattern)
-  }
-
-  if (typeof options.revertPattern === 'string') {
-    options.revertPattern = new RegExp(options.revertPattern)
-  }
-
-  if (typeof options.revertCorrespondence === 'string') {
-    options.revertCorrespondence = options.revertCorrespondence.split(',')
-  }
-
-  if (typeof options.mergePattern === 'string') {
-    options.mergePattern = new RegExp(options.mergePattern)
-  }
-
-  return options
-}
-
-function conventionalCommitsParser (options) {
-  options = assignOpts(options)
-  const reg = regex(options)
-
-  return new Transform({
-    objectMode: true,
-    highWaterMark: 16,
-    transform (data, enc, cb) {
-      let commit
-
-      try {
-        commit = parser(data.toString(), options, reg)
-        cb(null, commit)
-      } catch (err) {
-        if (options.warn === true) {
-          cb(err)
-        } else {
-          options.warn(err.toString())
-          cb(null, '')
-        }
-      }
-    }
-  })
-}
-
-function sync (commit, options) {
-  options = assignOpts(options)
-  const reg = regex(options)
-
-  return parser(commit, options, reg)
-}
-
-module.exports = conventionalCommitsParser
-module.exports.sync = sync