conventional-commits-parser 5.0.0 → 6.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,320 @@
1
+ import { getParserRegexes } from './regex.js';
2
+ import { trimNewLines, appendLine, getCommentFilter, gpgFilter, truncateToScissor } from './utils.js';
3
+ import { defaultOptions } from './options.js';
4
+ /**
5
+ * Helper to create commit object.
6
+ * @param initialData - Initial commit data.
7
+ * @returns Commit object with empty data.
8
+ */
9
+ export function createCommitObject(initialData = {}) {
10
+ // @ts-expect-error: You can read properties from `Commit` without problems, but you can't assign object to this type. So here is helper for that.
11
+ return {
12
+ merge: null,
13
+ revert: null,
14
+ header: null,
15
+ body: null,
16
+ footer: null,
17
+ notes: [],
18
+ mentions: [],
19
+ references: [],
20
+ ...initialData
21
+ };
22
+ }
23
+ /**
24
+ * Commit message parser.
25
+ */
26
+ export class CommitParser {
27
+ options;
28
+ regexes;
29
+ lines = [];
30
+ lineIndex = 0;
31
+ commit = createCommitObject();
32
+ constructor(options = {}) {
33
+ this.options = {
34
+ ...defaultOptions,
35
+ ...options
36
+ };
37
+ this.regexes = getParserRegexes(this.options);
38
+ }
39
+ currentLine() {
40
+ return this.lines[this.lineIndex];
41
+ }
42
+ nextLine() {
43
+ return this.lines[this.lineIndex++];
44
+ }
45
+ isLineAvailable() {
46
+ return this.lineIndex < this.lines.length;
47
+ }
48
+ parseReference(input, action) {
49
+ const { regexes } = this;
50
+ if (regexes.url.test(input)) {
51
+ return null;
52
+ }
53
+ const matches = regexes.referenceParts.exec(input);
54
+ if (!matches) {
55
+ return null;
56
+ }
57
+ let [raw, repository = null, prefix, issue] = matches;
58
+ let owner = null;
59
+ if (repository) {
60
+ const slashIndex = repository.indexOf('/');
61
+ if (slashIndex !== -1) {
62
+ owner = repository.slice(0, slashIndex);
63
+ repository = repository.slice(slashIndex + 1);
64
+ }
65
+ }
66
+ return {
67
+ raw,
68
+ action,
69
+ owner,
70
+ repository,
71
+ prefix,
72
+ issue
73
+ };
74
+ }
75
+ parseReferences(input) {
76
+ const { regexes } = this;
77
+ const regex = input.match(regexes.references)
78
+ ? regexes.references
79
+ : /()(.+)/gi;
80
+ const references = [];
81
+ let matches;
82
+ let action;
83
+ let sentence;
84
+ let reference;
85
+ while (true) {
86
+ matches = regex.exec(input);
87
+ if (!matches) {
88
+ break;
89
+ }
90
+ action = matches[1] || null;
91
+ sentence = matches[2] || '';
92
+ while (true) {
93
+ reference = this.parseReference(sentence, action);
94
+ if (!reference) {
95
+ break;
96
+ }
97
+ references.push(reference);
98
+ }
99
+ }
100
+ return references;
101
+ }
102
+ skipEmptyLines() {
103
+ let line = this.currentLine();
104
+ while (line !== undefined && !line.trim()) {
105
+ this.nextLine();
106
+ line = this.currentLine();
107
+ }
108
+ }
109
+ parseMerge() {
110
+ const { commit, options } = this;
111
+ const correspondence = options.mergeCorrespondence || [];
112
+ const merge = this.currentLine();
113
+ const matches = merge && options.mergePattern
114
+ ? merge.match(options.mergePattern)
115
+ : null;
116
+ if (matches) {
117
+ this.nextLine();
118
+ commit.merge = matches[0] || null;
119
+ correspondence.forEach((key, index) => {
120
+ commit[key] = matches[index + 1] || null;
121
+ });
122
+ return true;
123
+ }
124
+ return false;
125
+ }
126
+ parseHeader(isMergeCommit) {
127
+ if (isMergeCommit) {
128
+ this.skipEmptyLines();
129
+ }
130
+ const { commit, options } = this;
131
+ const correspondence = options.headerCorrespondence || [];
132
+ const header = commit.header ?? this.nextLine();
133
+ let matches = null;
134
+ if (header) {
135
+ if (options.breakingHeaderPattern) {
136
+ matches = header.match(options.breakingHeaderPattern);
137
+ }
138
+ if (!matches && options.headerPattern) {
139
+ matches = header.match(options.headerPattern);
140
+ }
141
+ }
142
+ if (header) {
143
+ commit.header = header;
144
+ }
145
+ if (matches) {
146
+ correspondence.forEach((key, index) => {
147
+ commit[key] = matches[index + 1] || null;
148
+ });
149
+ }
150
+ }
151
+ parseMeta() {
152
+ const { options, commit } = this;
153
+ if (!options.fieldPattern || !this.isLineAvailable()) {
154
+ return false;
155
+ }
156
+ let matches;
157
+ let field = null;
158
+ let parsed = false;
159
+ while (this.isLineAvailable()) {
160
+ matches = this.currentLine().match(options.fieldPattern);
161
+ if (matches) {
162
+ field = matches[1] || null;
163
+ this.nextLine();
164
+ continue;
165
+ }
166
+ if (field) {
167
+ parsed = true;
168
+ commit[field] = appendLine(commit[field], this.currentLine());
169
+ this.nextLine();
170
+ }
171
+ else {
172
+ break;
173
+ }
174
+ }
175
+ return parsed;
176
+ }
177
+ parseNotes() {
178
+ const { regexes, commit } = this;
179
+ if (!this.isLineAvailable()) {
180
+ return false;
181
+ }
182
+ const matches = this.currentLine().match(regexes.notes);
183
+ let references = [];
184
+ if (matches) {
185
+ const note = {
186
+ title: matches[1],
187
+ text: matches[2]
188
+ };
189
+ commit.notes.push(note);
190
+ commit.footer = appendLine(commit.footer, this.currentLine());
191
+ this.nextLine();
192
+ while (this.isLineAvailable()) {
193
+ if (this.parseMeta()) {
194
+ return true;
195
+ }
196
+ if (this.parseNotes()) {
197
+ return true;
198
+ }
199
+ references = this.parseReferences(this.currentLine());
200
+ if (references.length) {
201
+ commit.references.push(...references);
202
+ }
203
+ else {
204
+ note.text = appendLine(note.text, this.currentLine());
205
+ }
206
+ commit.footer = appendLine(commit.footer, this.currentLine());
207
+ this.nextLine();
208
+ if (references.length) {
209
+ break;
210
+ }
211
+ }
212
+ return true;
213
+ }
214
+ return false;
215
+ }
216
+ parseBodyAndFooter(isBody) {
217
+ const { commit } = this;
218
+ if (!this.isLineAvailable()) {
219
+ return isBody;
220
+ }
221
+ const references = this.parseReferences(this.currentLine());
222
+ const isStillBody = !references.length && isBody;
223
+ if (isStillBody) {
224
+ commit.body = appendLine(commit.body, this.currentLine());
225
+ }
226
+ else {
227
+ commit.references.push(...references);
228
+ commit.footer = appendLine(commit.footer, this.currentLine());
229
+ }
230
+ this.nextLine();
231
+ return isStillBody;
232
+ }
233
+ parseBreakingHeader() {
234
+ const { commit, options } = this;
235
+ if (!options.breakingHeaderPattern || commit.notes.length || !commit.header) {
236
+ return;
237
+ }
238
+ const matches = commit.header.match(options.breakingHeaderPattern);
239
+ if (matches) {
240
+ commit.notes.push({
241
+ title: 'BREAKING CHANGE',
242
+ text: matches[3]
243
+ });
244
+ }
245
+ }
246
+ parseMentions(input) {
247
+ const { commit, regexes } = this;
248
+ let matches;
249
+ for (;;) {
250
+ matches = regexes.mentions.exec(input);
251
+ if (!matches) {
252
+ break;
253
+ }
254
+ commit.mentions.push(matches[1]);
255
+ }
256
+ }
257
+ parseRevert(input) {
258
+ const { commit, options } = this;
259
+ const correspondence = options.revertCorrespondence || [];
260
+ const matches = options.revertPattern
261
+ ? input.match(options.revertPattern)
262
+ : null;
263
+ if (matches) {
264
+ commit.revert = correspondence.reduce((meta, key, index) => {
265
+ meta[key] = matches[index + 1] || null;
266
+ return meta;
267
+ }, {});
268
+ }
269
+ }
270
+ cleanupCommit() {
271
+ const { commit } = this;
272
+ if (commit.body) {
273
+ commit.body = trimNewLines(commit.body);
274
+ }
275
+ if (commit.footer) {
276
+ commit.footer = trimNewLines(commit.footer);
277
+ }
278
+ commit.notes.forEach((note) => {
279
+ note.text = trimNewLines(note.text);
280
+ });
281
+ }
282
+ /**
283
+ * Parse commit message string into an object.
284
+ * @param input - Commit message string.
285
+ * @returns Commit object.
286
+ */
287
+ parse(input) {
288
+ if (!input.trim()) {
289
+ throw new TypeError('Expected a raw commit');
290
+ }
291
+ const commentFilter = getCommentFilter(this.options.commentChar);
292
+ const rawLines = trimNewLines(input).split(/\r?\n/);
293
+ const lines = truncateToScissor(rawLines).filter(line => commentFilter(line) && gpgFilter(line));
294
+ const commit = createCommitObject();
295
+ this.lines = lines;
296
+ this.lineIndex = 0;
297
+ this.commit = commit;
298
+ const isMergeCommit = this.parseMerge();
299
+ this.parseHeader(isMergeCommit);
300
+ if (commit.header) {
301
+ commit.references = this.parseReferences(commit.header);
302
+ }
303
+ let isBody = true;
304
+ while (this.isLineAvailable()) {
305
+ this.parseMeta();
306
+ if (this.parseNotes()) {
307
+ isBody = false;
308
+ }
309
+ if (!this.parseBodyAndFooter(isBody)) {
310
+ isBody = false;
311
+ }
312
+ }
313
+ this.parseBreakingHeader();
314
+ this.parseMentions(input);
315
+ this.parseRevert(input);
316
+ this.cleanupCommit();
317
+ return commit;
318
+ }
319
+ }
320
+ //# sourceMappingURL=data:application/json;base64,{"version":3,"file":"CommitParser.js","sourceRoot":"","sources":["../src/CommitParser.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAA;AAC7C,OAAO,EACL,YAAY,EACZ,UAAU,EACV,gBAAgB,EAChB,SAAS,EACT,iBAAiB,EAClB,MAAM,YAAY,CAAA;AACnB,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAA;AAE7C;;;;GAIG;AACH,MAAM,UAAU,kBAAkB,CAAC,cAA+B,EAAE;IAClE,kJAAkJ;IAClJ,OAAO;QACL,KAAK,EAAE,IAAI;QACX,MAAM,EAAE,IAAI;QACZ,MAAM,EAAE,IAAI;QACZ,IAAI,EAAE,IAAI;QACV,MAAM,EAAE,IAAI;QACZ,KAAK,EAAE,EAAE;QACT,QAAQ,EAAE,EAAE;QACZ,UAAU,EAAE,EAAE;QACd,GAAG,WAAW;KACf,CAAA;AACH,CAAC;AAED;;GAEG;AACH,MAAM,OAAO,YAAY;IACN,OAAO,CAAe;IACtB,OAAO,CAAe;IAC/B,KAAK,GAAa,EAAE,CAAA;IACpB,SAAS,GAAG,CAAC,CAAA;IACb,MAAM,GAAG,kBAAkB,EAAE,CAAA;IAErC,YAAY,UAAyB,EAAE;QACrC,IAAI,CAAC,OAAO,GAAG;YACb,GAAG,cAAc;YACjB,GAAG,OAAO;SACX,CAAA;QACD,IAAI,CAAC,OAAO,GAAG,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;IAC/C,CAAC;IAEO,WAAW;QACjB,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;IACnC,CAAC;IAEO,QAAQ;QACd,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,CAAA;IACrC,CAAC;IAEO,eAAe;QACrB,OAAO,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAA;IAC3C,CAAC;IAEO,cAAc,CACpB,KAAa,EACb,MAAqB;QAErB,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAA;QAExB,IAAI,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAA;SACZ;QAED,MAAM,OAAO,GAAG,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAElD,IAAI,CAAC,OAAO,EAAE;YACZ,OAAO,IAAI,CAAA;SACZ;QAED,IAAI,CACF,GAAG,EACH,UAAU,GAAG,IAAI,EACjB,MAAM,EACN,KAAK,CACN,GAAG,OAAO,CAAA;QACX,IAAI,KAAK,GAAkB,IAAI,CAAA;QAE/B,IAAI,UAAU,EAAE;YACd,MAAM,UAAU,GAAG,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;YAE1C,IAAI,UAAU,KAAK,CAAC,CAAC,EAAE;gBACrB,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,EAAE,UAAU,CAAC,CAAA;gBACvC,UAAU,GAAG,UAAU,CAAC,KAAK,CAAC,UAAU,GAAG,CAAC,CAAC,CAAA;aAC9C;SACF;QAED,OAAO;YACL,GAAG;YACH,MAAM;YACN,KAAK;YACL,UAAU;YACV,MAAM;YACN,KAAK;SACN,CAAA;IACH,CAAC;IAEO,eAAe,CACrB,KAAa;QAEb,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAA;QACxB,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC;YAC3C,CAAC,CAAC,OAAO,CAAC,UAAU;YACpB,CAAC,CAAC,UAAU,CAAA;QACd,MAAM,UAAU,GAAsB,EAAE,CAAA;QACxC,IAAI,OAA+B,CAAA;QACnC,IAAI,MAAqB,CAAA;QACzB,IAAI,QAAgB,CAAA;QACpB,IAAI,SAAiC,CAAA;QAErC,OAAO,IAAI,EAAE;YACX,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;YAE3B,IAAI,CAAC,OAAO,EAAE;gBACZ,MAAK;aACN;YAED,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,IAAI,IAAI,CAAA;YAC3B,QAAQ,GAAG,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,CAAA;YAE3B,OAAO,IAAI,EAAE;gBACX,SAAS,GAAG,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;gBAEjD,IAAI,CAAC,SAAS,EAAE;oBACd,MAAK;iBACN;gBAED,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;aAC3B;SACF;QAED,OAAO,UAAU,CAAA;IACnB,CAAC;IAEO,cAAc;QACpB,IAAI,IAAI,GAAG,IAAI,CAAC,WAAW,EAAE,CAAA;QAE7B,OAAO,IAAI,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE;YACzC,IAAI,CAAC,QAAQ,EAAE,CAAA;YACf,IAAI,GAAG,IAAI,CAAC,WAAW,EAAE,CAAA;SAC1B;IACH,CAAC;IAEO,UAAU;QAChB,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAA;QAChC,MAAM,cAAc,GAAG,OAAO,CAAC,mBAAmB,IAAI,EAAE,CAAA;QACxD,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,EAAE,CAAA;QAChC,MAAM,OAAO,GAAG,KAAK,IAAI,OAAO,CAAC,YAAY;YAC3C,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC;YACnC,CAAC,CAAC,IAAI,CAAA;QAER,IAAI,OAAO,EAAE;YACX,IAAI,CAAC,QAAQ,EAAE,CAAA;YAEf,MAAM,CAAC,KAAK,GAAG,OAAO,CAAC,CAAC,CAAC,IAAI,IAAI,CAAA;YAEjC,cAAc,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;gBACpC,MAAM,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,KAAK,GAAG,CAAC,CAAC,IAAI,IAAI,CAAA;YAC1C,CAAC,CAAC,CAAA;YAEF,OAAO,IAAI,CAAA;SACZ;QAED,OAAO,KAAK,CAAA;IACd,CAAC;IAEO,WAAW,CAAC,aAAsB;QACxC,IAAI,aAAa,EAAE;YACjB,IAAI,CAAC,cAAc,EAAE,CAAA;SACtB;QAED,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAA;QAChC,MAAM,cAAc,GAAG,OAAO,CAAC,oBAAoB,IAAI,EAAE,CAAA;QACzD,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAA;QAC/C,IAAI,OAAO,GAA4B,IAAI,CAAA;QAE3C,IAAI,MAAM,EAAE;YACV,IAAI,OAAO,CAAC,qBAAqB,EAAE;gBACjC,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAA;aACtD;YAED,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,aAAa,EAAE;gBACrC,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,CAAA;aAC9C;SACF;QAED,IAAI,MAAM,EAAE;YACV,MAAM,CAAC,MAAM,GAAG,MAAM,CAAA;SACvB;QAED,IAAI,OAAO,EAAE;YACX,cAAc,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;gBACpC,MAAM,CAAC,GAAG,CAAC,GAAG,OAAQ,CAAC,KAAK,GAAG,CAAC,CAAC,IAAI,IAAI,CAAA;YAC3C,CAAC,CAAC,CAAA;SACH;IACH,CAAC;IAEO,SAAS;QACf,MAAM,EACJ,OAAO,EACP,MAAM,EACP,GAAG,IAAI,CAAA;QAER,IAAI,CAAC,OAAO,CAAC,YAAY,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE;YACpD,OAAO,KAAK,CAAA;SACb;QAED,IAAI,OAAgC,CAAA;QACpC,IAAI,KAAK,GAAkB,IAAI,CAAA;QAC/B,IAAI,MAAM,GAAG,KAAK,CAAA;QAElB,OAAO,IAAI,CAAC,eAAe,EAAE,EAAE;YAC7B,OAAO,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,CAAA;YAExD,IAAI,OAAO,EAAE;gBACX,KAAK,GAAG,OAAO,CAAC,CAAC,CAAC,IAAI,IAAI,CAAA;gBAC1B,IAAI,CAAC,QAAQ,EAAE,CAAA;gBACf,SAAQ;aACT;YAED,IAAI,KAAK,EAAE;gBACT,MAAM,GAAG,IAAI,CAAA;gBACb,MAAM,CAAC,KAAK,CAAC,GAAG,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,CAAA;gBAC7D,IAAI,CAAC,QAAQ,EAAE,CAAA;aAChB;iBAAM;gBACL,MAAK;aACN;SACF;QAED,OAAO,MAAM,CAAA;IACf,CAAC;IAEO,UAAU;QAChB,MAAM,EACJ,OAAO,EACP,MAAM,EACP,GAAG,IAAI,CAAA;QAER,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE;YAC3B,OAAO,KAAK,CAAA;SACb;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;QACvD,IAAI,UAAU,GAAsB,EAAE,CAAA;QAEtC,IAAI,OAAO,EAAE;YACX,MAAM,IAAI,GAAe;gBACvB,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC;gBACjB,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;aACjB,CAAA;YAED,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;YACvB,MAAM,CAAC,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,CAAA;YAC7D,IAAI,CAAC,QAAQ,EAAE,CAAA;YAEf,OAAO,IAAI,CAAC,eAAe,EAAE,EAAE;gBAC7B,IAAI,IAAI,CAAC,SAAS,EAAE,EAAE;oBACpB,OAAO,IAAI,CAAA;iBACZ;gBAED,IAAI,IAAI,CAAC,UAAU,EAAE,EAAE;oBACrB,OAAO,IAAI,CAAA;iBACZ;gBAED,UAAU,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAA;gBAErD,IAAI,UAAU,CAAC,MAAM,EAAE;oBACrB,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,CAAA;iBACtC;qBAAM;oBACL,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,CAAA;iBACtD;gBAED,MAAM,CAAC,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,CAAA;gBAC7D,IAAI,CAAC,QAAQ,EAAE,CAAA;gBAEf,IAAI,UAAU,CAAC,MAAM,EAAE;oBACrB,MAAK;iBACN;aACF;YAED,OAAO,IAAI,CAAA;SACZ;QAED,OAAO,KAAK,CAAA;IACd,CAAC;IAEO,kBAAkB,CAAC,MAAe;QACxC,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAA;QAEvB,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE;YAC3B,OAAO,MAAM,CAAA;SACd;QAED,MAAM,UAAU,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAA;QAC3D,MAAM,WAAW,GAAG,CAAC,UAAU,CAAC,MAAM,IAAI,MAAM,CAAA;QAEhD,IAAI,WAAW,EAAE;YACf,MAAM,CAAC,IAAI,GAAG,UAAU,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,CAAA;SAC1D;aAAM;YACL,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,CAAA;YACrC,MAAM,CAAC,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,CAAA;SAC9D;QAED,IAAI,CAAC,QAAQ,EAAE,CAAA;QAEf,OAAO,WAAW,CAAA;IACpB,CAAC;IAEO,mBAAmB;QACzB,MAAM,EACJ,MAAM,EACN,OAAO,EACR,GAAG,IAAI,CAAA;QAER,IAAI,CAAC,OAAO,CAAC,qBAAqB,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE;YAC3E,OAAM;SACP;QAED,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAA;QAElE,IAAI,OAAO,EAAE;YACX,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC;gBAChB,KAAK,EAAE,iBAAiB;gBACxB,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;aACjB,CAAC,CAAA;SACH;IACH,CAAC;IAEO,aAAa,CAAC,KAAa;QACjC,MAAM,EACJ,MAAM,EACN,OAAO,EACR,GAAG,IAAI,CAAA;QACR,IAAI,OAA+B,CAAA;QAEnC,SAAS;YACP,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;YAEtC,IAAI,CAAC,OAAO,EAAE;gBACZ,MAAK;aACN;YAED,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAA;SACjC;IACH,CAAC;IAEO,WAAW,CAAC,KAAa;QAC/B,MAAM,EACJ,MAAM,EACN,OAAO,EACR,GAAG,IAAI,CAAA;QACR,MAAM,cAAc,GAAG,OAAO,CAAC,oBAAoB,IAAI,EAAE,CAAA;QACzD,MAAM,OAAO,GAAG,OAAO,CAAC,aAAa;YACnC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC;YACpC,CAAC,CAAC,IAAI,CAAA;QAER,IAAI,OAAO,EAAE;YACX,MAAM,CAAC,MAAM,GAAG,cAAc,CAAC,MAAM,CAAa,CAAC,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE;gBACrE,IAAI,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,KAAK,GAAG,CAAC,CAAC,IAAI,IAAI,CAAA;gBAEtC,OAAO,IAAI,CAAA;YACb,CAAC,EAAE,EAAE,CAAC,CAAA;SACP;IACH,CAAC;IAEO,aAAa;QACnB,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAA;QAEvB,IAAI,MAAM,CAAC,IAAI,EAAE;YACf,MAAM,CAAC,IAAI,GAAG,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;SACxC;QAED,IAAI,MAAM,CAAC,MAAM,EAAE;YACjB,MAAM,CAAC,MAAM,GAAG,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;SAC5C;QAED,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YAC5B,IAAI,CAAC,IAAI,GAAG,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACrC,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,KAAa;QACjB,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE;YACjB,MAAM,IAAI,SAAS,CAAC,uBAAuB,CAAC,CAAA;SAC7C;QAED,MAAM,aAAa,GAAG,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAA;QAChE,MAAM,QAAQ,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;QACnD,MAAM,KAAK,GAAG,iBAAiB,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,SAAS,CAAC,IAAI,CAAC,CAAC,CAAA;QAChG,MAAM,MAAM,GAAG,kBAAkB,EAAE,CAAA;QAEnC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;QAClB,IAAI,CAAC,SAAS,GAAG,CAAC,CAAA;QAClB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QAEpB,MAAM,aAAa,GAAG,IAAI,CAAC,UAAU,EAAE,CAAA;QAEvC,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC,CAAA;QAE/B,IAAI,MAAM,CAAC,MAAM,EAAE;YACjB,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;SACxD;QAED,IAAI,MAAM,GAAG,IAAI,CAAA;QAEjB,OAAO,IAAI,CAAC,eAAe,EAAE,EAAE;YAC7B,IAAI,CAAC,SAAS,EAAE,CAAA;YAEhB,IAAI,IAAI,CAAC,UAAU,EAAE,EAAE;gBACrB,MAAM,GAAG,KAAK,CAAA;aACf;YAED,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,EAAE;gBACpC,MAAM,GAAG,KAAK,CAAA;aACf;SACF;QAED,IAAI,CAAC,mBAAmB,EAAE,CAAA;QAC1B,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAA;QACzB,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAA;QACvB,IAAI,CAAC,aAAa,EAAE,CAAA;QAEpB,OAAO,MAAM,CAAA;IACf,CAAC;CACF"}
@@ -0,0 +1,3 @@
1
+ #!/usr/bin/env node
2
+ export {};
3
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/cli/index.ts"],"names":[],"mappings":""}
@@ -0,0 +1,103 @@
1
+ #!/usr/bin/env node
2
+ import { pipeline } from 'stream/promises';
3
+ import meow from 'meow';
4
+ import { parseCommits } from '../index.js';
5
+ import { parseOptions } from './options.js';
6
+ import { readRawCommitsFromFiles, readRawCommitsFromLine, readRawCommitsFromStdin, stringify } from './utils.js';
7
+ const DEFAULT_SEPARATOR = '\n\n\n';
8
+ const cli = meow(`
9
+ Practice writing commit messages or parse messages from files.
10
+ If used without specifying a text file path, you will enter an interactive shell.
11
+ Otherwise the commit messages in the files are parsed and printed
12
+ By default, commits will be split by three newlines ('\\n\\n\\n') or you can specify a separator.
13
+
14
+ Usage
15
+ conventional-commits-parser [-s <commit-separator>]
16
+ conventional-commits-parser [-s <commit-separator>] <path> [<path> ...]
17
+ cat <path> | conventional-commits-parser [-s <commit-separator>]
18
+
19
+ Example
20
+ conventional-commits-parser
21
+ conventional-commits-parser log.txt
22
+ cat log.txt | conventional-commits-parser
23
+ conventional-commits-parser log2.txt -s '===' >> parsed.txt
24
+
25
+ Options
26
+ -s, --separator Commit separator
27
+ -p, --header-pattern Regex to match header pattern
28
+ -c, --header-correspondence Comma separated parts used to define what capturing group of 'headerPattern' captures what
29
+ -r, --reference-actions Comma separated keywords that used to reference issues
30
+ -i, --issue-prefixes Comma separated prefixes of an issue
31
+ --issue-prefixes-case-sensitive Treat issue prefixes as case sensitive
32
+ -n, --note-keywords Comma separated keywords for important notes
33
+ -f, --field-pattern Regex to match other fields
34
+ --revert-pattern Regex to match revert pattern
35
+ --revert-correspondence Comma separated fields used to define what the commit reverts
36
+ -v, --verbose Verbose output
37
+ `, {
38
+ importMeta: import.meta,
39
+ flags: {
40
+ separator: {
41
+ shortFlag: 's',
42
+ type: 'string',
43
+ default: DEFAULT_SEPARATOR
44
+ },
45
+ headerPattern: {
46
+ shortFlag: 'p',
47
+ type: 'string'
48
+ },
49
+ headerCorrespondence: {
50
+ shortFlag: 'c',
51
+ type: 'string'
52
+ },
53
+ referenceActions: {
54
+ shortFlag: 'r',
55
+ type: 'string'
56
+ },
57
+ issuePrefixes: {
58
+ shortFlag: 'i',
59
+ type: 'string'
60
+ },
61
+ issuePrefixesCaseSensitive: {
62
+ type: 'boolean'
63
+ },
64
+ noteKeywords: {
65
+ shortFlag: 'n',
66
+ type: 'string'
67
+ },
68
+ fieldPattern: {
69
+ shortFlag: 'f',
70
+ type: 'string'
71
+ },
72
+ revertPattern: {
73
+ type: 'string'
74
+ },
75
+ revertCorrespondence: {
76
+ type: 'string'
77
+ },
78
+ verbose: {
79
+ shortFlag: 'v',
80
+ type: 'boolean'
81
+ }
82
+ }
83
+ });
84
+ const { separator } = cli.flags;
85
+ const options = parseOptions(cli.flags);
86
+ let inputStream;
87
+ try {
88
+ if (cli.input.length) {
89
+ inputStream = readRawCommitsFromFiles(cli.input, separator);
90
+ }
91
+ else if (process.stdin.isTTY) {
92
+ inputStream = readRawCommitsFromLine(separator);
93
+ }
94
+ else {
95
+ inputStream = readRawCommitsFromStdin(separator);
96
+ }
97
+ await pipeline(inputStream, parseCommits(options), stringify, process.stdout);
98
+ }
99
+ catch (err) {
100
+ console.error(err);
101
+ process.exit(1);
102
+ }
103
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvY2xpL2luZGV4LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFDQSxPQUFPLEVBQUUsUUFBUSxFQUFFLE1BQU0saUJBQWlCLENBQUE7QUFDMUMsT0FBTyxJQUFJLE1BQU0sTUFBTSxDQUFBO0FBQ3ZCLE9BQU8sRUFBRSxZQUFZLEVBQUUsTUFBTSxhQUFhLENBQUE7QUFDMUMsT0FBTyxFQUFFLFlBQVksRUFBRSxNQUFNLGNBQWMsQ0FBQTtBQUMzQyxPQUFPLEVBQ0wsdUJBQXVCLEVBQ3ZCLHNCQUFzQixFQUN0Qix1QkFBdUIsRUFDdkIsU0FBUyxFQUNWLE1BQU0sWUFBWSxDQUFBO0FBRW5CLE1BQU0saUJBQWlCLEdBQUcsUUFBUSxDQUFBO0FBQ2xDLE1BQU0sR0FBRyxHQUFHLElBQUksQ0FBQzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Q0E2QmhCLEVBQUU7SUFDRCxVQUFVLEVBQUUsTUFBTSxDQUFDLElBQUk7SUFDdkIsS0FBSyxFQUFFO1FBQ0wsU0FBUyxFQUFFO1lBQ1QsU0FBUyxFQUFFLEdBQUc7WUFDZCxJQUFJLEVBQUUsUUFBUTtZQUNkLE9BQU8sRUFBRSxpQkFBaUI7U0FDM0I7UUFDRCxhQUFhLEVBQUU7WUFDYixTQUFTLEVBQUUsR0FBRztZQUNkLElBQUksRUFBRSxRQUFRO1NBQ2Y7UUFDRCxvQkFBb0IsRUFBRTtZQUNwQixTQUFTLEVBQUUsR0FBRztZQUNkLElBQUksRUFBRSxRQUFRO1NBQ2Y7UUFDRCxnQkFBZ0IsRUFBRTtZQUNoQixTQUFTLEVBQUUsR0FBRztZQUNkLElBQUksRUFBRSxRQUFRO1NBQ2Y7UUFDRCxhQUFhLEVBQUU7WUFDYixTQUFTLEVBQUUsR0FBRztZQUNkLElBQUksRUFBRSxRQUFRO1NBQ2Y7UUFDRCwwQkFBMEIsRUFBRTtZQUMxQixJQUFJLEVBQUUsU0FBUztTQUNoQjtRQUNELFlBQVksRUFBRTtZQUNaLFNBQVMsRUFBRSxHQUFHO1lBQ2QsSUFBSSxFQUFFLFFBQVE7U0FDZjtRQUNELFlBQVksRUFBRTtZQUNaLFNBQVMsRUFBRSxHQUFHO1lBQ2QsSUFBSSxFQUFFLFFBQVE7U0FDZjtRQUNELGFBQWEsRUFBRTtZQUNiLElBQUksRUFBRSxRQUFRO1NBQ2Y7UUFDRCxvQkFBb0IsRUFBRTtZQUNwQixJQUFJLEVBQUUsUUFBUTtTQUNmO1FBQ0QsT0FBTyxFQUFFO1lBQ1AsU0FBUyxFQUFFLEdBQUc7WUFDZCxJQUFJLEVBQUUsU0FBUztTQUNoQjtLQUNGO0NBQ0YsQ0FBQyxDQUFBO0FBQ0YsTUFBTSxFQUFFLFNBQVMsRUFBRSxHQUFHLEdBQUcsQ0FBQyxLQUFLLENBQUE7QUFDL0IsTUFBTSxPQUFPLEdBQUcsWUFBWSxDQUFDLEdBQUcsQ0FBQyxLQUFLLENBQUMsQ0FBQTtBQUN2QyxJQUFJLFdBQWtDLENBQUE7QUFFdEMsSUFBSTtJQUNGLElBQUksR0FBRyxDQUFDLEtBQUssQ0FBQyxNQUFNLEVBQUU7UUFDcEIsV0FBVyxHQUFHLHVCQUF1QixDQUFDLEdBQUcsQ0FBQyxLQUFLLEVBQUUsU0FBUyxDQUFDLENBQUE7S0FDNUQ7U0FDQyxJQUFJLE9BQU8sQ0FBQyxLQUFLLENBQUMsS0FBSyxFQUFFO1FBQ3ZCLFdBQVcsR0FBRyxzQkFBc0IsQ0FBQyxTQUFTLENBQUMsQ0FBQTtLQUNoRDtTQUFNO1FBQ0wsV0FBVyxHQUFHLHVCQUF1QixDQUFDLFNBQVMsQ0FBQyxDQUFBO0tBQ2pEO0lBRUgsTUFBTSxRQUFRLENBQ1osV0FBVyxFQUNYLFlBQVksQ0FBQyxPQUFPLENBQUMsRUFDckIsU0FBUyxFQUNULE9BQU8sQ0FBQyxNQUFNLENBQ2YsQ0FBQTtDQUNGO0FBQUMsT0FBTyxHQUFHLEVBQUU7SUFDWixPQUFPLENBQUMsS0FBSyxDQUFDLEdBQUcsQ0FBQyxDQUFBO0lBQ2xCLE9BQU8sQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDLENBQUE7Q0FDaEIifQ==
@@ -0,0 +1,3 @@
1
+ import type { ParserStreamOptions } from '../types.js';
2
+ export declare function parseOptions(options: Record<string, unknown>): ParserStreamOptions;
3
+ //# sourceMappingURL=options.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../../src/cli/options.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAA;AAMtD,wBAAgB,YAAY,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,mBAAmB,CA4ClF"}
@@ -0,0 +1,40 @@
1
+ function trim(str) {
2
+ return str.trim();
3
+ }
4
+ export function parseOptions(options) {
5
+ if (typeof options.headerPattern === 'string') {
6
+ options.headerPattern = new RegExp(options.headerPattern);
7
+ }
8
+ if (typeof options.headerCorrespondence === 'string') {
9
+ options.headerCorrespondence = options.headerCorrespondence.split(',').map(trim);
10
+ }
11
+ if (typeof options.referenceActions === 'string') {
12
+ options.referenceActions = options.referenceActions.split(',').map(trim);
13
+ }
14
+ if (typeof options.issuePrefixes === 'string') {
15
+ options.issuePrefixes = options.issuePrefixes.split(',').map(trim);
16
+ }
17
+ if (typeof options.noteKeywords === 'string') {
18
+ options.noteKeywords = options.noteKeywords.split(',').map(trim);
19
+ }
20
+ if (typeof options.fieldPattern === 'string') {
21
+ options.fieldPattern = new RegExp(options.fieldPattern);
22
+ }
23
+ if (typeof options.revertPattern === 'string') {
24
+ options.revertPattern = new RegExp(options.revertPattern);
25
+ }
26
+ if (typeof options.revertCorrespondence === 'string') {
27
+ options.revertCorrespondence = options.revertCorrespondence.split(',').map(trim);
28
+ }
29
+ if (typeof options.mergePattern === 'string') {
30
+ options.mergePattern = new RegExp(options.mergePattern);
31
+ }
32
+ if (options.verbose) {
33
+ options.warn = console.warn.bind(console);
34
+ }
35
+ else {
36
+ options.warn = true;
37
+ }
38
+ return options;
39
+ }
40
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoib3B0aW9ucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9jbGkvb3B0aW9ucy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFFQSxTQUFTLElBQUksQ0FBQyxHQUFXO0lBQ3ZCLE9BQU8sR0FBRyxDQUFDLElBQUksRUFBRSxDQUFBO0FBQ25CLENBQUM7QUFFRCxNQUFNLFVBQVUsWUFBWSxDQUFDLE9BQWdDO0lBQzNELElBQUksT0FBTyxPQUFPLENBQUMsYUFBYSxLQUFLLFFBQVEsRUFBRTtRQUM3QyxPQUFPLENBQUMsYUFBYSxHQUFHLElBQUksTUFBTSxDQUFDLE9BQU8sQ0FBQyxhQUFhLENBQUMsQ0FBQTtLQUMxRDtJQUVELElBQUksT0FBTyxPQUFPLENBQUMsb0JBQW9CLEtBQUssUUFBUSxFQUFFO1FBQ3BELE9BQU8sQ0FBQyxvQkFBb0IsR0FBRyxPQUFPLENBQUMsb0JBQW9CLENBQUMsS0FBSyxDQUFDLEdBQUcsQ0FBQyxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsQ0FBQTtLQUNqRjtJQUVELElBQUksT0FBTyxPQUFPLENBQUMsZ0JBQWdCLEtBQUssUUFBUSxFQUFFO1FBQ2hELE9BQU8sQ0FBQyxnQkFBZ0IsR0FBRyxPQUFPLENBQUMsZ0JBQWdCLENBQUMsS0FBSyxDQUFDLEdBQUcsQ0FBQyxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsQ0FBQTtLQUN6RTtJQUVELElBQUksT0FBTyxPQUFPLENBQUMsYUFBYSxLQUFLLFFBQVEsRUFBRTtRQUM3QyxPQUFPLENBQUMsYUFBYSxHQUFHLE9BQU8sQ0FBQyxhQUFhLENBQUMsS0FBSyxDQUFDLEdBQUcsQ0FBQyxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsQ0FBQTtLQUNuRTtJQUVELElBQUksT0FBTyxPQUFPLENBQUMsWUFBWSxLQUFLLFFBQVEsRUFBRTtRQUM1QyxPQUFPLENBQUMsWUFBWSxHQUFHLE9BQU8sQ0FBQyxZQUFZLENBQUMsS0FBSyxDQUFDLEdBQUcsQ0FBQyxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsQ0FBQTtLQUNqRTtJQUVELElBQUksT0FBTyxPQUFPLENBQUMsWUFBWSxLQUFLLFFBQVEsRUFBRTtRQUM1QyxPQUFPLENBQUMsWUFBWSxHQUFHLElBQUksTUFBTSxDQUFDLE9BQU8sQ0FBQyxZQUFZLENBQUMsQ0FBQTtLQUN4RDtJQUVELElBQUksT0FBTyxPQUFPLENBQUMsYUFBYSxLQUFLLFFBQVEsRUFBRTtRQUM3QyxPQUFPLENBQUMsYUFBYSxHQUFHLElBQUksTUFBTSxDQUFDLE9BQU8sQ0FBQyxhQUFhLENBQUMsQ0FBQTtLQUMxRDtJQUVELElBQUksT0FBTyxPQUFPLENBQUMsb0JBQW9CLEtBQUssUUFBUSxFQUFFO1FBQ3BELE9BQU8sQ0FBQyxvQkFBb0IsR0FBRyxPQUFPLENBQUMsb0JBQW9CLENBQUMsS0FBSyxDQUFDLEdBQUcsQ0FBQyxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsQ0FBQTtLQUNqRjtJQUVELElBQUksT0FBTyxPQUFPLENBQUMsWUFBWSxLQUFLLFFBQVEsRUFBRTtRQUM1QyxPQUFPLENBQUMsWUFBWSxHQUFHLElBQUksTUFBTSxDQUFDLE9BQU8sQ0FBQyxZQUFZLENBQUMsQ0FBQTtLQUN4RDtJQUVELElBQUksT0FBTyxDQUFDLE9BQU8sRUFBRTtRQUNuQixPQUFPLENBQUMsSUFBSSxHQUFHLE9BQU8sQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxDQUFBO0tBQzFDO1NBQU07UUFDTCxPQUFPLENBQUMsSUFBSSxHQUFHLElBQUksQ0FBQTtLQUNwQjtJQUVELE9BQU8sT0FBTyxDQUFBO0FBQ2hCLENBQUMifQ==
@@ -0,0 +1,8 @@
1
+ /// <reference types="node" resolution-mode="require"/>
2
+ import type { Readable } from 'stream';
3
+ export declare function splitStream(stream: Readable, separator: string): AsyncGenerator<string, void, undefined>;
4
+ export declare function readRawCommitsFromFiles(files: string[], separator: string): AsyncGenerator<string, void, undefined>;
5
+ export declare function readRawCommitsFromLine(separator: string): AsyncGenerator<string, void, unknown>;
6
+ export declare function readRawCommitsFromStdin(separator: string): AsyncGenerator<string, void, undefined>;
7
+ export declare function stringify(commits: AsyncIterable<Record<string, unknown>>): AsyncGenerator<string, void, unknown>;
8
+ //# sourceMappingURL=utils.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/cli/utils.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAA;AAItC,wBAAuB,WAAW,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,2CAmBrE;AAED,wBAAuB,uBAAuB,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,SAAS,EAAE,MAAM,2CAQhF;AAED,wBAAuB,sBAAsB,CAAC,SAAS,EAAE,MAAM,yCAmB9D;AAED,wBAAgB,uBAAuB,CAAC,SAAS,EAAE,MAAM,2CAExD;AAMD,wBAAuB,SAAS,CAAC,OAAO,EAAE,aAAa,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,yCAe/E"}
@@ -0,0 +1,64 @@
1
+ import fs from 'fs';
2
+ import readline from 'readline';
3
+ export async function* splitStream(stream, separator) {
4
+ let chunk;
5
+ let payload;
6
+ let buffer = '';
7
+ for await (chunk of stream) {
8
+ buffer += chunk.toString();
9
+ if (buffer.includes(separator)) {
10
+ payload = buffer.split(separator);
11
+ buffer = payload.pop() || '';
12
+ yield* payload;
13
+ }
14
+ }
15
+ if (buffer) {
16
+ yield buffer;
17
+ }
18
+ }
19
+ export async function* readRawCommitsFromFiles(files, separator) {
20
+ for (const file of files) {
21
+ try {
22
+ yield* splitStream(fs.createReadStream(file), separator);
23
+ }
24
+ catch (err) {
25
+ console.warn(`Failed to read file ${file}:\n ${err}`);
26
+ }
27
+ }
28
+ }
29
+ export async function* readRawCommitsFromLine(separator) {
30
+ const rl = readline.createInterface({
31
+ input: process.stdin,
32
+ output: process.stdout,
33
+ terminal: true
34
+ });
35
+ let line = '';
36
+ let commit = '';
37
+ for await (line of rl) {
38
+ commit += `${line}\n`;
39
+ if (!commit.includes(separator)) {
40
+ return;
41
+ }
42
+ yield commit;
43
+ commit = '';
44
+ }
45
+ }
46
+ export function readRawCommitsFromStdin(separator) {
47
+ return splitStream(process.stdin, separator);
48
+ }
49
+ const JSON_STREAM_OPEN = '[\n';
50
+ const JSON_STREAM_SEPARATOR = '\n,\n';
51
+ const JSON_STREAM_CLOSE = '\n]\n';
52
+ export async function* stringify(commits) {
53
+ let jsonStreamOpened = false;
54
+ yield JSON_STREAM_OPEN;
55
+ for await (const commit of commits) {
56
+ if (jsonStreamOpened) {
57
+ yield JSON_STREAM_SEPARATOR;
58
+ }
59
+ yield JSON.stringify(commit);
60
+ jsonStreamOpened = true;
61
+ }
62
+ yield JSON_STREAM_CLOSE;
63
+ }
64
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidXRpbHMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvY2xpL3V0aWxzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUNBLE9BQU8sRUFBRSxNQUFNLElBQUksQ0FBQTtBQUNuQixPQUFPLFFBQVEsTUFBTSxVQUFVLENBQUE7QUFFL0IsTUFBTSxDQUFDLEtBQUssU0FBUyxDQUFDLENBQUMsV0FBVyxDQUFDLE1BQWdCLEVBQUUsU0FBaUI7SUFDcEUsSUFBSSxLQUFhLENBQUE7SUFDakIsSUFBSSxPQUFpQixDQUFBO0lBQ3JCLElBQUksTUFBTSxHQUFHLEVBQUUsQ0FBQTtJQUVmLElBQUksS0FBSyxFQUFFLEtBQUssSUFBSSxNQUFNLEVBQUU7UUFDMUIsTUFBTSxJQUFJLEtBQUssQ0FBQyxRQUFRLEVBQUUsQ0FBQTtRQUUxQixJQUFJLE1BQU0sQ0FBQyxRQUFRLENBQUMsU0FBUyxDQUFDLEVBQUU7WUFDOUIsT0FBTyxHQUFHLE1BQU0sQ0FBQyxLQUFLLENBQUMsU0FBUyxDQUFDLENBQUE7WUFDakMsTUFBTSxHQUFHLE9BQU8sQ0FBQyxHQUFHLEVBQUUsSUFBSSxFQUFFLENBQUE7WUFFNUIsS0FBSyxDQUFDLENBQUMsT0FBTyxDQUFBO1NBQ2Y7S0FDRjtJQUVELElBQUksTUFBTSxFQUFFO1FBQ1YsTUFBTSxNQUFNLENBQUE7S0FDYjtBQUNILENBQUM7QUFFRCxNQUFNLENBQUMsS0FBSyxTQUFTLENBQUMsQ0FBQyx1QkFBdUIsQ0FBQyxLQUFlLEVBQUUsU0FBaUI7SUFDL0UsS0FBSyxNQUFNLElBQUksSUFBSSxLQUFLLEVBQUU7UUFDeEIsSUFBSTtZQUNGLEtBQUssQ0FBQyxDQUFDLFdBQVcsQ0FBQyxFQUFFLENBQUMsZ0JBQWdCLENBQUMsSUFBSSxDQUFDLEVBQUUsU0FBUyxDQUFDLENBQUE7U0FDekQ7UUFBQyxPQUFPLEdBQUcsRUFBRTtZQUNaLE9BQU8sQ0FBQyxJQUFJLENBQUMsdUJBQXVCLElBQUksUUFBUSxHQUFhLEVBQUUsQ0FBQyxDQUFBO1NBQ2pFO0tBQ0Y7QUFDSCxDQUFDO0FBRUQsTUFBTSxDQUFDLEtBQUssU0FBUyxDQUFDLENBQUMsc0JBQXNCLENBQUMsU0FBaUI7SUFDN0QsTUFBTSxFQUFFLEdBQUcsUUFBUSxDQUFDLGVBQWUsQ0FBQztRQUNsQyxLQUFLLEVBQUUsT0FBTyxDQUFDLEtBQUs7UUFDcEIsTUFBTSxFQUFFLE9BQU8sQ0FBQyxNQUFNO1FBQ3RCLFFBQVEsRUFBRSxJQUFJO0tBQ2YsQ0FBQyxDQUFBO0lBQ0YsSUFBSSxJQUFJLEdBQUcsRUFBRSxDQUFBO0lBQ2IsSUFBSSxNQUFNLEdBQUcsRUFBRSxDQUFBO0lBRWYsSUFBSSxLQUFLLEVBQUUsSUFBSSxJQUFJLEVBQUUsRUFBRTtRQUNyQixNQUFNLElBQUksR0FBRyxJQUFJLElBQUksQ0FBQTtRQUVyQixJQUFJLENBQUMsTUFBTSxDQUFDLFFBQVEsQ0FBQyxTQUFTLENBQUMsRUFBRTtZQUMvQixPQUFNO1NBQ1A7UUFFRCxNQUFNLE1BQU0sQ0FBQTtRQUNaLE1BQU0sR0FBRyxFQUFFLENBQUE7S0FDWjtBQUNILENBQUM7QUFFRCxNQUFNLFVBQVUsdUJBQXVCLENBQUMsU0FBaUI7SUFDdkQsT0FBTyxXQUFXLENBQUMsT0FBTyxDQUFDLEtBQUssRUFBRSxTQUFTLENBQUMsQ0FBQTtBQUM5QyxDQUFDO0FBRUQsTUFBTSxnQkFBZ0IsR0FBRyxLQUFLLENBQUE7QUFDOUIsTUFBTSxxQkFBcUIsR0FBRyxPQUFPLENBQUE7QUFDckMsTUFBTSxpQkFBaUIsR0FBRyxPQUFPLENBQUE7QUFFakMsTUFBTSxDQUFDLEtBQUssU0FBUyxDQUFDLENBQUMsU0FBUyxDQUFDLE9BQStDO0lBQzlFLElBQUksZ0JBQWdCLEdBQUcsS0FBSyxDQUFBO0lBRTVCLE1BQU0sZ0JBQWdCLENBQUE7SUFFdEIsSUFBSSxLQUFLLEVBQUUsTUFBTSxNQUFNLElBQUksT0FBTyxFQUFFO1FBQ2xDLElBQUksZ0JBQWdCLEVBQUU7WUFDcEIsTUFBTSxxQkFBcUIsQ0FBQTtTQUM1QjtRQUVELE1BQU0sSUFBSSxDQUFDLFNBQVMsQ0FBQyxNQUFNLENBQUMsQ0FBQTtRQUM1QixnQkFBZ0IsR0FBRyxJQUFJLENBQUE7S0FDeEI7SUFFRCxNQUFNLGlCQUFpQixDQUFBO0FBQ3pCLENBQUMifQ==
@@ -0,0 +1,4 @@
1
+ export * from './types.js';
2
+ export * from './CommitParser.js';
3
+ export * from './stream.js';
4
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAA;AAC1B,cAAc,mBAAmB,CAAA;AACjC,cAAc,aAAa,CAAA"}
package/dist/index.js ADDED
@@ -0,0 +1,4 @@
1
+ export * from './types.js';
2
+ export * from './CommitParser.js';
3
+ export * from './stream.js';
4
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsY0FBYyxZQUFZLENBQUE7QUFDMUIsY0FBYyxtQkFBbUIsQ0FBQTtBQUNqQyxjQUFjLGFBQWEsQ0FBQSJ9
@@ -0,0 +1,3 @@
1
+ import type { ParserOptions } from './types.js';
2
+ export declare const defaultOptions: ParserOptions;
3
+ //# sourceMappingURL=options.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../src/options.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,YAAY,CAAA;AAE/C,eAAO,MAAM,cAAc,EAAE,aAuB5B,CAAA"}
@@ -0,0 +1,25 @@
1
+ export const defaultOptions = {
2
+ noteKeywords: ['BREAKING CHANGE', 'BREAKING-CHANGE'],
3
+ issuePrefixes: ['#'],
4
+ referenceActions: [
5
+ 'close',
6
+ 'closes',
7
+ 'closed',
8
+ 'fix',
9
+ 'fixes',
10
+ 'fixed',
11
+ 'resolve',
12
+ 'resolves',
13
+ 'resolved'
14
+ ],
15
+ headerPattern: /^(\w*)(?:\(([\w$@.\-*/ ]*)\))?: (.*)$/,
16
+ headerCorrespondence: [
17
+ 'type',
18
+ 'scope',
19
+ 'subject'
20
+ ],
21
+ revertPattern: /^Revert\s"([\s\S]*)"\s*This reverts commit (\w*)\./,
22
+ revertCorrespondence: ['header', 'hash'],
23
+ fieldPattern: /^-(.*?)-$/
24
+ };
25
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoib3B0aW9ucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy9vcHRpb25zLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUVBLE1BQU0sQ0FBQyxNQUFNLGNBQWMsR0FBa0I7SUFDM0MsWUFBWSxFQUFFLENBQUMsaUJBQWlCLEVBQUUsaUJBQWlCLENBQUM7SUFDcEQsYUFBYSxFQUFFLENBQUMsR0FBRyxDQUFDO0lBQ3BCLGdCQUFnQixFQUFFO1FBQ2hCLE9BQU87UUFDUCxRQUFRO1FBQ1IsUUFBUTtRQUNSLEtBQUs7UUFDTCxPQUFPO1FBQ1AsT0FBTztRQUNQLFNBQVM7UUFDVCxVQUFVO1FBQ1YsVUFBVTtLQUNYO0lBQ0QsYUFBYSxFQUFFLHVDQUF1QztJQUN0RCxvQkFBb0IsRUFBRTtRQUNwQixNQUFNO1FBQ04sT0FBTztRQUNQLFNBQVM7S0FDVjtJQUNELGFBQWEsRUFBRSxvREFBb0Q7SUFDbkUsb0JBQW9CLEVBQUUsQ0FBQyxRQUFRLEVBQUUsTUFBTSxDQUFDO0lBQ3hDLFlBQVksRUFBRSxXQUFXO0NBQzFCLENBQUEifQ==
@@ -0,0 +1,8 @@
1
+ import type { ParserOptions, ParserRegexes } from './types.js';
2
+ /**
3
+ * Make the regexes used to parse a commit.
4
+ * @param options
5
+ * @returns Regexes.
6
+ */
7
+ export declare function getParserRegexes(options?: Pick<ParserOptions, 'noteKeywords' | 'notesPattern' | 'issuePrefixes' | 'issuePrefixesCaseSensitive' | 'referenceActions'>): ParserRegexes;
8
+ //# sourceMappingURL=regex.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"regex.d.ts","sourceRoot":"","sources":["../src/regex.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EACb,aAAa,EACd,MAAM,YAAY,CAAA;AAsDnB;;;;GAIG;AACH,wBAAgB,gBAAgB,CAC9B,OAAO,GAAE,IAAI,CAAC,aAAa,EAAE,cAAc,GAAG,cAAc,GAAG,eAAe,GAAG,4BAA4B,GAAG,kBAAkB,CAAM,GACvI,aAAa,CAYf"}