keep-a-changelog 3.0.3 → 3.0.5
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.
- package/{types/bin.d.ts → bin.d.ts} +0 -1
- package/bin.js +201 -205
- package/mod.d.ts +5 -0
- package/mod.js +1 -0
- package/package.json +40 -47
- package/src/Change.d.ts +8 -0
- package/src/Change.js +29 -30
- package/src/Changelog.d.ts +24 -0
- package/src/Changelog.js +113 -114
- package/src/Release.d.ts +29 -0
- package/src/Release.js +205 -189
- package/src/deps.js +1 -0
- package/src/parser.d.ts +13 -0
- package/src/parser.js +216 -165
- package/src/settings.d.ts +15 -0
- package/src/settings.js +57 -57
- package/CHANGELOG.md +0 -187
- package/types/mod.d.ts +0 -5
- package/types/src/Change.d.ts +0 -8
- package/types/src/Changelog.d.ts +0 -25
- package/types/src/Release.d.ts +0 -29
- package/types/src/parser.d.ts +0 -16
- package/types/src/settings.d.ts +0 -17
- /package/{types/src → src}/deps.d.ts +0 -0
package/src/Change.js
CHANGED
|
@@ -1,33 +1,32 @@
|
|
|
1
1
|
export default class Change {
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
}
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
t.push("");
|
|
29
|
-
t = t.concat(this.description.split("\n").map((line) => ` ${line}`.trimEnd()));
|
|
30
|
-
}
|
|
31
|
-
return t.join("\n").trim();
|
|
2
|
+
title;
|
|
3
|
+
description;
|
|
4
|
+
issues = [];
|
|
5
|
+
static extractIssues(text, issues) {
|
|
6
|
+
return text.replace(/(^|[^\\])\[#(\d+)\](?=[^\(]|$)/g, (_, start, index)=>{
|
|
7
|
+
if (!issues.includes(index)) {
|
|
8
|
+
issues.push(index);
|
|
9
|
+
}
|
|
10
|
+
return `${start}[#${index}]`;
|
|
11
|
+
}).replace(/(^|[\s,])#(\d+)(?=[\s,\.]|$)/g, (_, start, index)=>{
|
|
12
|
+
if (!issues.includes(index)) {
|
|
13
|
+
issues.push(index);
|
|
14
|
+
}
|
|
15
|
+
return `${start}[#${index}]`;
|
|
16
|
+
});
|
|
17
|
+
}
|
|
18
|
+
constructor(title, description = ""){
|
|
19
|
+
this.title = Change.extractIssues(title, this.issues);
|
|
20
|
+
this.description = Change.extractIssues(description, this.issues);
|
|
21
|
+
}
|
|
22
|
+
toString(bulletStyle = "-") {
|
|
23
|
+
let t = this.title.split("\n").map((line)=>` ${line}`.trimEnd());
|
|
24
|
+
t[0] = bulletStyle + t[0].substr(1);
|
|
25
|
+
if (this.description) {
|
|
26
|
+
t.push("");
|
|
27
|
+
t = t.concat(this.description.split("\n").map((line)=>` ${line}`.trimEnd()));
|
|
32
28
|
}
|
|
29
|
+
return t.join("\n").trim();
|
|
30
|
+
}
|
|
33
31
|
}
|
|
32
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbImZpbGU6Ly8vVXNlcnMvb3NjYXJvdGVyby93d3cva2VlcC1hLWNoYW5nZWxvZy9zcmMvQ2hhbmdlLnRzIl0sInNvdXJjZXNDb250ZW50IjpbImV4cG9ydCBkZWZhdWx0IGNsYXNzIENoYW5nZSB7XG4gIHRpdGxlOiBzdHJpbmc7XG4gIGRlc2NyaXB0aW9uOiBzdHJpbmc7XG4gIGlzc3Vlczogc3RyaW5nW10gPSBbXTtcblxuICBzdGF0aWMgZXh0cmFjdElzc3Vlcyh0ZXh0OiBzdHJpbmcsIGlzc3Vlczogc3RyaW5nW10pOiBzdHJpbmcge1xuICAgIHJldHVybiB0ZXh0XG4gICAgICAucmVwbGFjZSgvKF58W15cXFxcXSlcXFsjKFxcZCspXFxdKD89W15cXChdfCQpL2csIChfLCBzdGFydCwgaW5kZXgpID0+IHtcbiAgICAgICAgaWYgKCFpc3N1ZXMuaW5jbHVkZXMoaW5kZXgpKSB7XG4gICAgICAgICAgaXNzdWVzLnB1c2goaW5kZXgpO1xuICAgICAgICB9XG5cbiAgICAgICAgcmV0dXJuIGAke3N0YXJ0fVsjJHtpbmRleH1dYDtcbiAgICAgIH0pXG4gICAgICAucmVwbGFjZSgvKF58W1xccyxdKSMoXFxkKykoPz1bXFxzLFxcLl18JCkvZywgKF8sIHN0YXJ0LCBpbmRleCkgPT4ge1xuICAgICAgICBpZiAoIWlzc3Vlcy5pbmNsdWRlcyhpbmRleCkpIHtcbiAgICAgICAgICBpc3N1ZXMucHVzaChpbmRleCk7XG4gICAgICAgIH1cblxuICAgICAgICByZXR1cm4gYCR7c3RhcnR9WyMke2luZGV4fV1gO1xuICAgICAgfSk7XG4gIH1cblxuICBjb25zdHJ1Y3Rvcih0aXRsZTogc3RyaW5nLCBkZXNjcmlwdGlvbiA9IFwiXCIpIHtcbiAgICB0aGlzLnRpdGxlID0gQ2hhbmdlLmV4dHJhY3RJc3N1ZXModGl0bGUsIHRoaXMuaXNzdWVzKTtcbiAgICB0aGlzLmRlc2NyaXB0aW9uID0gQ2hhbmdlLmV4dHJhY3RJc3N1ZXMoZGVzY3JpcHRpb24sIHRoaXMuaXNzdWVzKTtcbiAgfVxuXG4gIHRvU3RyaW5nKGJ1bGxldFN0eWxlID0gXCItXCIpOiBzdHJpbmcge1xuICAgIGxldCB0ID0gdGhpcy50aXRsZS5zcGxpdChcIlxcblwiKS5tYXAoKGxpbmUpID0+IGAgICR7bGluZX1gLnRyaW1FbmQoKSk7XG4gICAgdFswXSA9IGJ1bGxldFN0eWxlICsgdFswXS5zdWJzdHIoMSk7XG5cbiAgICBpZiAodGhpcy5kZXNjcmlwdGlvbikge1xuICAgICAgdC5wdXNoKFwiXCIpO1xuXG4gICAgICB0ID0gdC5jb25jYXQoXG4gICAgICAgIHRoaXMuZGVzY3JpcHRpb24uc3BsaXQoXCJcXG5cIikubWFwKChsaW5lKSA9PiBgICAke2xpbmV9YC50cmltRW5kKCkpLFxuICAgICAgKTtcbiAgICB9XG5cbiAgICByZXR1cm4gdC5qb2luKFwiXFxuXCIpLnRyaW0oKTtcbiAgfVxufVxuIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLGVBQWUsTUFBTTtFQUNuQixNQUFjO0VBQ2QsWUFBb0I7RUFDcEIsU0FBbUIsRUFBRSxDQUFDO0VBRXRCLE9BQU8sY0FBYyxJQUFZLEVBQUUsTUFBZ0IsRUFBVTtJQUMzRCxPQUFPLEtBQ0osT0FBTyxDQUFDLG1DQUFtQyxDQUFDLEdBQUcsT0FBTztNQUNyRCxJQUFJLENBQUMsT0FBTyxRQUFRLENBQUMsUUFBUTtRQUMzQixPQUFPLElBQUksQ0FBQztNQUNkO01BRUEsT0FBTyxHQUFHLE1BQU0sRUFBRSxFQUFFLE1BQU0sQ0FBQyxDQUFDO0lBQzlCLEdBQ0MsT0FBTyxDQUFDLGlDQUFpQyxDQUFDLEdBQUcsT0FBTztNQUNuRCxJQUFJLENBQUMsT0FBTyxRQUFRLENBQUMsUUFBUTtRQUMzQixPQUFPLElBQUksQ0FBQztNQUNkO01BRUEsT0FBTyxHQUFHLE1BQU0sRUFBRSxFQUFFLE1BQU0sQ0FBQyxDQUFDO0lBQzlCO0VBQ0o7RUFFQSxZQUFZLEtBQWEsRUFBRSxjQUFjLEVBQUUsQ0FBRTtJQUMzQyxJQUFJLENBQUMsS0FBSyxHQUFHLE9BQU8sYUFBYSxDQUFDLE9BQU8sSUFBSSxDQUFDLE1BQU07SUFDcEQsSUFBSSxDQUFDLFdBQVcsR0FBRyxPQUFPLGFBQWEsQ0FBQyxhQUFhLElBQUksQ0FBQyxNQUFNO0VBQ2xFO0VBRUEsU0FBUyxjQUFjLEdBQUcsRUFBVTtJQUNsQyxJQUFJLElBQUksSUFBSSxDQUFDLEtBQUssQ0FBQyxLQUFLLENBQUMsTUFBTSxHQUFHLENBQUMsQ0FBQyxPQUFTLENBQUMsRUFBRSxFQUFFLE1BQU0sQ0FBQyxPQUFPO0lBQ2hFLENBQUMsQ0FBQyxFQUFFLEdBQUcsY0FBYyxDQUFDLENBQUMsRUFBRSxDQUFDLE1BQU0sQ0FBQztJQUVqQyxJQUFJLElBQUksQ0FBQyxXQUFXLEVBQUU7TUFDcEIsRUFBRSxJQUFJLENBQUM7TUFFUCxJQUFJLEVBQUUsTUFBTSxDQUNWLElBQUksQ0FBQyxXQUFXLENBQUMsS0FBSyxDQUFDLE1BQU0sR0FBRyxDQUFDLENBQUMsT0FBUyxDQUFDLEVBQUUsRUFBRSxNQUFNLENBQUMsT0FBTztJQUVsRTtJQUVBLE9BQU8sRUFBRSxJQUFJLENBQUMsTUFBTSxJQUFJO0VBQzFCO0FBQ0YifQ==
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import type Release from "./Release.js";
|
|
2
|
+
import type { SemVer } from "./deps.js";
|
|
3
|
+
export default class Changelog {
|
|
4
|
+
flag?: string;
|
|
5
|
+
title: string;
|
|
6
|
+
description: string;
|
|
7
|
+
head: string;
|
|
8
|
+
footer?: string;
|
|
9
|
+
url?: string;
|
|
10
|
+
releases: Release[];
|
|
11
|
+
tagNameBuilder?: (release: Release) => string;
|
|
12
|
+
/** @deprecated: Use tagLinkBuilder() instead */ compareLinkBuilder?: (previous: Release, release: Release) => string;
|
|
13
|
+
tagLinkBuilder?: (url: string, tag: string, previous?: string, head?: string) => string;
|
|
14
|
+
format: "compact" | "markdownlint";
|
|
15
|
+
bulletStyle: "-" | "*" | "+";
|
|
16
|
+
autoSortReleases: boolean;
|
|
17
|
+
constructor(title: string, description?: string);
|
|
18
|
+
addRelease(release: Release): this;
|
|
19
|
+
findRelease(version?: SemVer | string): Release | undefined;
|
|
20
|
+
sortReleases(): void;
|
|
21
|
+
compareLink(previous: Release, release: Release): string;
|
|
22
|
+
tagName(release: Release): string;
|
|
23
|
+
toString(): string;
|
|
24
|
+
}
|
package/src/Changelog.js
CHANGED
|
@@ -1,130 +1,129 @@
|
|
|
1
1
|
import { equals, parse } from "./deps.js";
|
|
2
2
|
export default class Changelog {
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
3
|
+
flag;
|
|
4
|
+
title;
|
|
5
|
+
description;
|
|
6
|
+
head = "HEAD";
|
|
7
|
+
footer;
|
|
8
|
+
url;
|
|
9
|
+
releases = [];
|
|
10
|
+
tagNameBuilder;
|
|
11
|
+
/** @deprecated: Use tagLinkBuilder() instead */ compareLinkBuilder;
|
|
12
|
+
tagLinkBuilder;
|
|
13
|
+
format = "compact";
|
|
14
|
+
bulletStyle = "-";
|
|
15
|
+
autoSortReleases = true;
|
|
16
|
+
constructor(title, description = ""){
|
|
17
|
+
this.title = title;
|
|
18
|
+
this.description = description;
|
|
19
|
+
}
|
|
20
|
+
addRelease(release) {
|
|
21
|
+
this.releases.push(release);
|
|
22
|
+
if (this.autoSortReleases) {
|
|
23
|
+
this.sortReleases();
|
|
20
24
|
}
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
return this;
|
|
25
|
+
release.changelog = this;
|
|
26
|
+
return this;
|
|
27
|
+
}
|
|
28
|
+
findRelease(version) {
|
|
29
|
+
if (!version) {
|
|
30
|
+
return this.releases.find((release)=>!release.version);
|
|
28
31
|
}
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
32
|
+
const parsed = typeof version === "string" ? parse(version) : version;
|
|
33
|
+
return this.releases.find((release)=>release.parsedVersion && equals(release.parsedVersion, parsed));
|
|
34
|
+
}
|
|
35
|
+
sortReleases() {
|
|
36
|
+
this.releases.sort((a, b)=>a.compare(b));
|
|
37
|
+
}
|
|
38
|
+
compareLink(previous, release) {
|
|
39
|
+
if (this.compareLinkBuilder) {
|
|
40
|
+
return this.compareLinkBuilder(previous, release);
|
|
35
41
|
}
|
|
36
|
-
|
|
37
|
-
|
|
42
|
+
if (this.tagLinkBuilder) {
|
|
43
|
+
const url = this.url;
|
|
44
|
+
if (!previous) {
|
|
45
|
+
return this.tagLinkBuilder(this.url, this.tagName(release), undefined, this.head);
|
|
46
|
+
}
|
|
47
|
+
if (!release.date || !release.version) {
|
|
48
|
+
return this.tagLinkBuilder(url, this.head, this.tagName(previous), this.head);
|
|
49
|
+
}
|
|
50
|
+
return this.tagLinkBuilder(url, this.tagName(release), this.tagName(previous), this.head);
|
|
38
51
|
}
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
return this.compareLinkBuilder(previous, release);
|
|
42
|
-
}
|
|
43
|
-
if (this.tagLinkBuilder) {
|
|
44
|
-
const url = this.url;
|
|
45
|
-
if (!previous) {
|
|
46
|
-
return this.tagLinkBuilder(this.url, this.tagName(release), undefined, this.head);
|
|
47
|
-
}
|
|
48
|
-
if (!release.date || !release.version) {
|
|
49
|
-
return this.tagLinkBuilder(url, this.head, this.tagName(previous), this.head);
|
|
50
|
-
}
|
|
51
|
-
return this.tagLinkBuilder(url, this.tagName(release), this.tagName(previous), this.head);
|
|
52
|
-
}
|
|
53
|
-
if (!previous) {
|
|
54
|
-
return `${this.url}/releases/tag/${this.tagName(release)}`;
|
|
55
|
-
}
|
|
56
|
-
if (!release.date || !release.version) {
|
|
57
|
-
return `${this.url}/compare/${this.tagName(previous)}...${this.head}`;
|
|
58
|
-
}
|
|
59
|
-
return `${this.url}/compare/${this.tagName(previous)}...${this.tagName(release)}`;
|
|
52
|
+
if (!previous) {
|
|
53
|
+
return `${this.url}/releases/tag/${this.tagName(release)}`;
|
|
60
54
|
}
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
return this.tagNameBuilder(release);
|
|
64
|
-
}
|
|
65
|
-
return `v${release.version}`;
|
|
55
|
+
if (!release.date || !release.version) {
|
|
56
|
+
return `${this.url}/compare/${this.tagName(previous)}...${this.head}`;
|
|
66
57
|
}
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
58
|
+
return `${this.url}/compare/${this.tagName(previous)}...${this.tagName(release)}`;
|
|
59
|
+
}
|
|
60
|
+
tagName(release) {
|
|
61
|
+
if (this.tagNameBuilder) {
|
|
62
|
+
return this.tagNameBuilder(release);
|
|
63
|
+
}
|
|
64
|
+
return `v${release.version}`;
|
|
65
|
+
}
|
|
66
|
+
toString() {
|
|
67
|
+
const t = [];
|
|
68
|
+
if (this.flag) {
|
|
69
|
+
t.push(`<!-- ${this.flag} -->`);
|
|
70
|
+
t.push("");
|
|
71
|
+
}
|
|
72
|
+
t.push(`# ${this.title}`);
|
|
73
|
+
if (this.format === "markdownlint") {
|
|
74
|
+
t.push("");
|
|
75
|
+
}
|
|
76
|
+
const links = [];
|
|
77
|
+
const compareLinks = [];
|
|
78
|
+
const description = this.description.trim() || `All notable changes to this project will be documented in this file.
|
|
81
79
|
|
|
82
80
|
The format is based on [Keep a Changelog](https://keepachangelog.com/)
|
|
83
81
|
and this project adheres to [Semantic Versioning](https://semver.org/).`;
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
}
|
|
94
|
-
});
|
|
95
|
-
const compareLink = release.getCompareLink(this);
|
|
96
|
-
if (compareLink) {
|
|
97
|
-
compareLinks.push(compareLink);
|
|
98
|
-
}
|
|
99
|
-
});
|
|
100
|
-
if (links.length) {
|
|
101
|
-
t.push("");
|
|
102
|
-
links.sort(compare);
|
|
103
|
-
links.forEach((link) => t.push(link));
|
|
104
|
-
}
|
|
105
|
-
if (compareLinks.length) {
|
|
106
|
-
t.push("");
|
|
107
|
-
compareLinks.forEach((link) => t.push(link));
|
|
108
|
-
}
|
|
109
|
-
t.push("");
|
|
110
|
-
if (this.footer) {
|
|
111
|
-
t.push("---");
|
|
112
|
-
t.push("");
|
|
113
|
-
t.push(this.footer);
|
|
114
|
-
t.push("");
|
|
82
|
+
if (description) {
|
|
83
|
+
t.push(description);
|
|
84
|
+
}
|
|
85
|
+
this.releases.forEach((release)=>{
|
|
86
|
+
t.push("");
|
|
87
|
+
t.push(release.toString(this));
|
|
88
|
+
release.getLinks(this).forEach((link)=>{
|
|
89
|
+
if (!links.includes(link)) {
|
|
90
|
+
links.push(link);
|
|
115
91
|
}
|
|
116
|
-
|
|
92
|
+
});
|
|
93
|
+
const compareLink = release.getCompareLink(this);
|
|
94
|
+
if (compareLink) {
|
|
95
|
+
compareLinks.push(compareLink);
|
|
96
|
+
}
|
|
97
|
+
});
|
|
98
|
+
if (links.length) {
|
|
99
|
+
t.push("");
|
|
100
|
+
links.sort(compare);
|
|
101
|
+
links.forEach((link)=>t.push(link));
|
|
117
102
|
}
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
return 0;
|
|
103
|
+
if (compareLinks.length) {
|
|
104
|
+
t.push("");
|
|
105
|
+
compareLinks.forEach((link)=>t.push(link));
|
|
122
106
|
}
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
107
|
+
t.push("");
|
|
108
|
+
if (this.footer) {
|
|
109
|
+
t.push("---");
|
|
110
|
+
t.push("");
|
|
111
|
+
t.push(this.footer);
|
|
112
|
+
t.push("");
|
|
128
113
|
}
|
|
129
|
-
return
|
|
114
|
+
return t.join("\n");
|
|
115
|
+
}
|
|
116
|
+
}
|
|
117
|
+
function compare(a, b) {
|
|
118
|
+
if (a === b) {
|
|
119
|
+
return 0;
|
|
120
|
+
}
|
|
121
|
+
const reg = /^\[#(\d+)\]:/;
|
|
122
|
+
const aNumber = a.match(reg);
|
|
123
|
+
const bNumber = b.match(reg);
|
|
124
|
+
if (aNumber && bNumber) {
|
|
125
|
+
return parseInt(aNumber[1]) - parseInt(bNumber[1]);
|
|
126
|
+
}
|
|
127
|
+
return a < b ? -1 : 1;
|
|
130
128
|
}
|
|
129
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"sources":["file:///Users/oscarotero/www/keep-a-changelog/src/Changelog.ts"],"sourcesContent":["import { equals, parse } from \"./deps.js\";\nimport type Release from \"./Release.js\";\nimport type { SemVer } from \"./deps.js\";\n\nexport default class Changelog {\n  flag?: string;\n  title: string;\n  description: string;\n  head = \"HEAD\";\n  footer?: string;\n  url?: string;\n  releases: Release[] = [];\n  tagNameBuilder?: (release: Release) => string;\n  /** @deprecated: Use tagLinkBuilder() instead */\n  compareLinkBuilder?: (previous: Release, release: Release) => string;\n  tagLinkBuilder?: (\n    url: string,\n    tag: string,\n    previous?: string,\n    head?: string,\n  ) => string;\n  format: \"compact\" | \"markdownlint\" = \"compact\";\n  bulletStyle: \"-\" | \"*\" | \"+\" = \"-\";\n  autoSortReleases = true;\n\n  constructor(title: string, description = \"\") {\n    this.title = title;\n    this.description = description;\n  }\n\n  addRelease(release: Release): this {\n    this.releases.push(release);\n    if (this.autoSortReleases) {\n      this.sortReleases();\n    }\n    release.changelog = this;\n\n    return this;\n  }\n\n  findRelease(version?: SemVer | string): Release | undefined {\n    if (!version) {\n      return this.releases.find((release) => !release.version);\n    }\n    const parsed = typeof version === \"string\" ? parse(version) : version;\n\n    return this.releases.find((release) =>\n      release.parsedVersion && equals(release.parsedVersion, parsed)\n    );\n  }\n\n  sortReleases(): void {\n    this.releases.sort((a, b) => a.compare(b));\n  }\n\n  compareLink(previous: Release, release: Release): string {\n    if (this.compareLinkBuilder) {\n      return this.compareLinkBuilder(previous, release);\n    }\n\n    if (this.tagLinkBuilder) {\n      const url = this.url!;\n\n      if (!previous) {\n        return this.tagLinkBuilder(\n          this.url!,\n          this.tagName(release),\n          undefined,\n          this.head,\n        );\n      }\n\n      if (!release.date || !release.version) {\n        return this.tagLinkBuilder(\n          url,\n          this.head,\n          this.tagName(previous),\n          this.head,\n        );\n      }\n\n      return this.tagLinkBuilder(\n        url,\n        this.tagName(release),\n        this.tagName(previous),\n        this.head,\n      );\n    }\n\n    if (!previous) {\n      return `${this.url}/releases/tag/${this.tagName(release)}`;\n    }\n\n    if (!release.date || !release.version) {\n      return `${this.url}/compare/${this.tagName(previous)}...${this.head}`;\n    }\n\n    return `${this.url}/compare/${this.tagName(previous)}...${\n      this.tagName(release)\n    }`;\n  }\n\n  tagName(release: Release): string {\n    if (this.tagNameBuilder) {\n      return this.tagNameBuilder(release);\n    }\n\n    return `v${release.version}`;\n  }\n\n  toString(): string {\n    const t = [];\n\n    if (this.flag) {\n      t.push(`<!-- ${this.flag} -->`);\n      t.push(\"\");\n    }\n\n    t.push(`# ${this.title}`);\n\n    if (this.format === \"markdownlint\") {\n      t.push(\"\");\n    }\n\n    const links: string[] = [];\n    const compareLinks: string[] = [];\n\n    const description = this.description.trim() ||\n      `All notable changes to this project will be documented in this file.\n\nThe format is based on [Keep a Changelog](https://keepachangelog.com/)\nand this project adheres to [Semantic Versioning](https://semver.org/).`;\n\n    if (description) {\n      t.push(description);\n    }\n\n    this.releases.forEach((release) => {\n      t.push(\"\");\n      t.push(release.toString(this));\n\n      release.getLinks(this).forEach((link) => {\n        if (!links.includes(link)) {\n          links.push(link);\n        }\n      });\n\n      const compareLink = release.getCompareLink(this);\n\n      if (compareLink) {\n        compareLinks.push(compareLink);\n      }\n    });\n\n    if (links.length) {\n      t.push(\"\");\n      links.sort(compare);\n      links.forEach((link) => t.push(link));\n    }\n\n    if (compareLinks.length) {\n      t.push(\"\");\n\n      compareLinks.forEach((link) => t.push(link));\n    }\n\n    t.push(\"\");\n\n    if (this.footer) {\n      t.push(\"---\");\n      t.push(\"\");\n      t.push(this.footer);\n      t.push(\"\");\n    }\n\n    return t.join(\"\\n\");\n  }\n}\n\nfunction compare(a: string, b: string) {\n  if (a === b) {\n    return 0;\n  }\n  const reg = /^\\[#(\\d+)\\]:/;\n  const aNumber = a.match(reg);\n  const bNumber = b.match(reg);\n\n  if (aNumber && bNumber) {\n    return parseInt(aNumber[1]) - parseInt(bNumber[1]);\n  }\n\n  return a < b ? -1 : 1;\n}\n"],"names":[],"mappings":"AAAA,SAAS,MAAM,EAAE,KAAK,QAAQ,YAAY;AAI1C,eAAe,MAAM;EACnB,KAAc;EACd,MAAc;EACd,YAAoB;EACpB,OAAO,OAAO;EACd,OAAgB;EAChB,IAAa;EACb,WAAsB,EAAE,CAAC;EACzB,eAA8C;EAC9C,8CAA8C,GAC9C,mBAAqE;EACrE,eAKY;EACZ,SAAqC,UAAU;EAC/C,cAA+B,IAAI;EACnC,mBAAmB,KAAK;EAExB,YAAY,KAAa,EAAE,cAAc,EAAE,CAAE;IAC3C,IAAI,CAAC,KAAK,GAAG;IACb,IAAI,CAAC,WAAW,GAAG;EACrB;EAEA,WAAW,OAAgB,EAAQ;IACjC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;IACnB,IAAI,IAAI,CAAC,gBAAgB,EAAE;MACzB,IAAI,CAAC,YAAY;IACnB;IACA,QAAQ,SAAS,GAAG,IAAI;IAExB,OAAO,IAAI;EACb;EAEA,YAAY,OAAyB,EAAuB;IAC1D,IAAI,CAAC,SAAS;MACZ,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,UAAY,CAAC,QAAQ,OAAO;IACzD;IACA,MAAM,SAAS,OAAO,YAAY,WAAW,MAAM,WAAW;IAE9D,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,UACzB,QAAQ,aAAa,IAAI,OAAO,QAAQ,aAAa,EAAE;EAE3D;EAEA,eAAqB;IACnB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,GAAG,IAAM,EAAE,OAAO,CAAC;EACzC;EAEA,YAAY,QAAiB,EAAE,OAAgB,EAAU;IACvD,IAAI,IAAI,CAAC,kBAAkB,EAAE;MAC3B,OAAO,IAAI,CAAC,kBAAkB,CAAC,UAAU;IAC3C;IAEA,IAAI,IAAI,CAAC,cAAc,EAAE;MACvB,MAAM,MAAM,IAAI,CAAC,GAAG;MAEpB,IAAI,CAAC,UAAU;QACb,OAAO,IAAI,CAAC,cAAc,CACxB,IAAI,CAAC,GAAG,EACR,IAAI,CAAC,OAAO,CAAC,UACb,WACA,IAAI,CAAC,IAAI;MAEb;MAEA,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,OAAO,EAAE;QACrC,OAAO,IAAI,CAAC,cAAc,CACxB,KACA,IAAI,CAAC,IAAI,EACT,IAAI,CAAC,OAAO,CAAC,WACb,IAAI,CAAC,IAAI;MAEb;MAEA,OAAO,IAAI,CAAC,cAAc,CACxB,KACA,IAAI,CAAC,OAAO,CAAC,UACb,IAAI,CAAC,OAAO,CAAC,WACb,IAAI,CAAC,IAAI;IAEb;IAEA,IAAI,CAAC,UAAU;MACb,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,cAAc,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU;IAC5D;IAEA,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,OAAO,EAAE;MACrC,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU,GAAG,EAAE,IAAI,CAAC,IAAI,EAAE;IACvE;IAEA,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU,GAAG,EACtD,IAAI,CAAC,OAAO,CAAC,UACb;EACJ;EAEA,QAAQ,OAAgB,EAAU;IAChC,IAAI,IAAI,CAAC,cAAc,EAAE;MACvB,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B;IAEA,OAAO,CAAC,CAAC,EAAE,QAAQ,OAAO,EAAE;EAC9B;EAEA,WAAmB;IACjB,MAAM,IAAI,EAAE;IAEZ,IAAI,IAAI,CAAC,IAAI,EAAE;MACb,EAAE,IAAI,CAAC,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;MAC9B,EAAE,IAAI,CAAC;IACT;IAEA,EAAE,IAAI,CAAC,CAAC,EAAE,EAAE,IAAI,CAAC,KAAK,EAAE;IAExB,IAAI,IAAI,CAAC,MAAM,KAAK,gBAAgB;MAClC,EAAE,IAAI,CAAC;IACT;IAEA,MAAM,QAAkB,EAAE;IAC1B,MAAM,eAAyB,EAAE;IAEjC,MAAM,cAAc,IAAI,CAAC,WAAW,CAAC,IAAI,MACvC,CAAC;;;uEAGgE,CAAC;IAEpE,IAAI,aAAa;MACf,EAAE,IAAI,CAAC;IACT;IAEA,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;MACrB,EAAE,IAAI,CAAC;MACP,EAAE,IAAI,CAAC,QAAQ,QAAQ,CAAC,IAAI;MAE5B,QAAQ,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAC9B,IAAI,CAAC,MAAM,QAAQ,CAAC,OAAO;UACzB,MAAM,IAAI,CAAC;QACb;MACF;MAEA,MAAM,cAAc,QAAQ,cAAc,CAAC,IAAI;MAE/C,IAAI,aAAa;QACf,aAAa,IAAI,CAAC;MACpB;IACF;IAEA,IAAI,MAAM,MAAM,EAAE;MAChB,EAAE,IAAI,CAAC;MACP,MAAM,IAAI,CAAC;MACX,MAAM,OAAO,CAAC,CAAC,OAAS,EAAE,IAAI,CAAC;IACjC;IAEA,IAAI,aAAa,MAAM,EAAE;MACvB,EAAE,IAAI,CAAC;MAEP,aAAa,OAAO,CAAC,CAAC,OAAS,EAAE,IAAI,CAAC;IACxC;IAEA,EAAE,IAAI,CAAC;IAEP,IAAI,IAAI,CAAC,MAAM,EAAE;MACf,EAAE,IAAI,CAAC;MACP,EAAE,IAAI,CAAC;MACP,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM;MAClB,EAAE,IAAI,CAAC;IACT;IAEA,OAAO,EAAE,IAAI,CAAC;EAChB;AACF;AAEA,SAAS,QAAQ,CAAS,EAAE,CAAS;EACnC,IAAI,MAAM,GAAG;IACX,OAAO;EACT;EACA,MAAM,MAAM;EACZ,MAAM,UAAU,EAAE,KAAK,CAAC;EACxB,MAAM,UAAU,EAAE,KAAK,CAAC;EAExB,IAAI,WAAW,SAAS;IACtB,OAAO,SAAS,OAAO,CAAC,EAAE,IAAI,SAAS,OAAO,CAAC,EAAE;EACnD;EAEA,OAAO,IAAI,IAAI,CAAC,IAAI;AACtB"}
|
package/src/Release.d.ts
ADDED
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import Change from "./Change.js";
|
|
2
|
+
import type Changelog from "./Changelog.js";
|
|
3
|
+
import type { SemVer } from "./deps.js";
|
|
4
|
+
export default class Release {
|
|
5
|
+
changelog?: Changelog;
|
|
6
|
+
parsedVersion?: SemVer;
|
|
7
|
+
date?: Date;
|
|
8
|
+
yanked: boolean;
|
|
9
|
+
description: string;
|
|
10
|
+
changes: Map<string, Change[]>;
|
|
11
|
+
constructor(version?: string | SemVer, date?: string | Date, description?: string);
|
|
12
|
+
get version(): string | undefined;
|
|
13
|
+
compare(release: Release): number;
|
|
14
|
+
combineChanges(changes: Map<string, Change[]>): this;
|
|
15
|
+
isEmpty(): boolean;
|
|
16
|
+
setVersion(version?: string | SemVer): void;
|
|
17
|
+
setDate(date?: Date | string): void;
|
|
18
|
+
setYanked(yanked?: boolean): this;
|
|
19
|
+
addChange(type: string, change: Change | string): this;
|
|
20
|
+
added(change: Change | string): this;
|
|
21
|
+
changed(change: Change | string): this;
|
|
22
|
+
deprecated(change: Change | string): this;
|
|
23
|
+
removed(change: Change | string): this;
|
|
24
|
+
fixed(change: Change | string): this;
|
|
25
|
+
security(change: Change | string): this;
|
|
26
|
+
toString(changelog?: Changelog): string;
|
|
27
|
+
getCompareLink(changelog?: Changelog): string | undefined;
|
|
28
|
+
getLinks(changelog: Changelog): string[];
|
|
29
|
+
}
|