keep-a-changelog 0.10.4 → 2.0.0-beta
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/CHANGELOG.md +5 -196
- package/LICENSE +1 -1
- package/README.md +93 -63
- package/esm/bin.js +113 -0
- package/esm/deps/deno_land/std_0.113.0/_util/assert.js +13 -0
- package/esm/deps/deno_land/std_0.113.0/_util/os.js +15 -0
- package/esm/deps/deno_land/std_0.113.0/flags/mod.js +255 -0
- package/esm/deps/deno_land/std_0.113.0/path/_constants.js +45 -0
- package/esm/deps/deno_land/std_0.113.0/path/_interface.js +3 -0
- package/esm/deps/deno_land/std_0.113.0/path/_util.js +114 -0
- package/esm/deps/deno_land/std_0.113.0/path/common.js +36 -0
- package/esm/deps/deno_land/std_0.113.0/path/glob.js +361 -0
- package/esm/deps/deno_land/std_0.113.0/path/mod.js +14 -0
- package/esm/deps/deno_land/std_0.113.0/path/posix.js +493 -0
- package/esm/deps/deno_land/std_0.113.0/path/separator.js +5 -0
- package/esm/deps/deno_land/std_0.113.0/path/win32.js +963 -0
- package/esm/deps/deno_land/std_0.51.0/fs/eol.js +29 -0
- package/esm/deps/deno_land/x/ini_v2.1.0/ini.js +226 -0
- package/esm/deps/deno_land/x/ini_v2.1.0/mod.js +1 -0
- package/esm/deps/deno_land/x/semver_v1.4.0/mod.js +1527 -0
- package/esm/mod.js +5 -0
- package/esm/package.json +3 -0
- package/esm/src/Change.js +48 -0
- package/esm/src/Changelog.js +137 -0
- package/esm/src/Release.js +204 -0
- package/esm/src/deps.js +1 -0
- package/esm/src/parser.js +149 -0
- package/esm/test/changelog.custom.type.md +24 -0
- package/esm/test/changelog.expected.md +169 -0
- package/esm/test/changelog.md +197 -0
- package/esm/test/empty.expected.md +6 -0
- package/package.json +26 -24
- package/types/bin.d.ts +2 -0
- package/types/deps/deno_land/std_0.113.0/_util/assert.d.ts +5 -0
- package/types/deps/deno_land/std_0.113.0/_util/os.d.ts +3 -0
- package/types/deps/deno_land/std_0.113.0/flags/mod.d.ts +50 -0
- package/types/deps/deno_land/std_0.113.0/path/_constants.d.ts +39 -0
- package/types/deps/deno_land/std_0.113.0/path/_interface.d.ts +26 -0
- package/types/deps/deno_land/std_0.113.0/path/_util.d.ts +8 -0
- package/types/deps/deno_land/std_0.113.0/path/common.d.ts +13 -0
- package/types/deps/deno_land/std_0.113.0/path/glob.d.ts +78 -0
- package/types/deps/deno_land/std_0.113.0/path/mod.d.ts +9 -0
- package/types/deps/deno_land/std_0.113.0/path/posix.d.ts +80 -0
- package/types/deps/deno_land/std_0.113.0/path/separator.d.ts +2 -0
- package/types/deps/deno_land/std_0.113.0/path/win32.d.ts +87 -0
- package/types/deps/deno_land/std_0.115.1/fmt/colors.d.ts +270 -0
- package/types/deps/deno_land/std_0.115.1/testing/_diff.d.ts +23 -0
- package/types/deps/deno_land/std_0.115.1/testing/asserts.d.ts +151 -0
- package/types/deps/deno_land/std_0.51.0/fs/eol.d.ts +12 -0
- package/types/deps/deno_land/x/ini_v2.1.0/ini.d.ts +53 -0
- package/types/deps/deno_land/x/ini_v2.1.0/mod.d.ts +1 -0
- package/types/deps/deno_land/x/semver_v1.4.0/mod.d.ts +116 -0
- package/types/mod.d.ts +5 -0
- package/types/src/Change.d.ts +8 -0
- package/types/src/Changelog.d.ts +18 -0
- package/types/src/Release.d.ts +25 -0
- package/types/src/deps.d.ts +1 -0
- package/types/src/parser.d.ts +11 -0
- package/types/test/Change.test.d.ts +1 -0
- package/types/test/fixture/CustomRelease.d.ts +7 -0
- package/types/test/parser.test.d.ts +1 -0
- package/types/test/test.d.ts +1 -0
- package/umd/bin.js +143 -0
- package/umd/deps/deno_land/std_0.113.0/_util/assert.js +27 -0
- package/umd/deps/deno_land/std_0.113.0/_util/os.js +46 -0
- package/umd/deps/deno_land/std_0.113.0/flags/mod.js +268 -0
- package/umd/deps/deno_land/std_0.113.0/path/_constants.js +57 -0
- package/umd/deps/deno_land/std_0.113.0/path/_interface.js +13 -0
- package/umd/deps/deno_land/std_0.113.0/path/_util.js +133 -0
- package/umd/deps/deno_land/std_0.113.0/path/common.js +49 -0
- package/umd/deps/deno_land/std_0.113.0/path/glob.js +396 -0
- package/umd/deps/deno_land/std_0.113.0/path/mod.js +50 -0
- package/umd/deps/deno_land/std_0.113.0/path/posix.js +537 -0
- package/umd/deps/deno_land/std_0.113.0/path/separator.js +17 -0
- package/umd/deps/deno_land/std_0.113.0/path/win32.js +1007 -0
- package/umd/deps/deno_land/std_0.51.0/fs/eol.js +43 -0
- package/umd/deps/deno_land/x/ini_v2.1.0/ini.js +261 -0
- package/umd/deps/deno_land/x/ini_v2.1.0/mod.js +22 -0
- package/umd/deps/deno_land/x/semver_v1.4.0/mod.js +1577 -0
- package/umd/mod.js +23 -0
- package/umd/package.json +3 -0
- package/umd/src/Change.js +60 -0
- package/umd/src/Changelog.js +149 -0
- package/umd/src/Release.js +219 -0
- package/umd/src/deps.js +18 -0
- package/umd/src/parser.js +164 -0
- package/umd/test/changelog.custom.type.md +24 -0
- package/umd/test/changelog.expected.md +169 -0
- package/umd/test/changelog.md +197 -0
- package/umd/test/empty.expected.md +6 -0
- package/bin.js +0 -128
- package/src/Change.js +0 -40
- package/src/Changelog.js +0 -121
- package/src/Release.js +0 -220
- package/src/index.js +0 -6
- package/src/parser.js +0 -182
|
@@ -0,0 +1,169 @@
|
|
|
1
|
+
# Changelog - demo
|
|
2
|
+
|
|
3
|
+
All notable changes to this project will be documented in this file.
|
|
4
|
+
|
|
5
|
+
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
|
|
6
|
+
and this project adheres to
|
|
7
|
+
[Semantic Versioning](http://semver.org/spec/v2.0.0.html).
|
|
8
|
+
|
|
9
|
+
## [Unreleased]
|
|
10
|
+
### Added
|
|
11
|
+
- Test
|
|
12
|
+
|
|
13
|
+
## [2.0.0] - Unreleased
|
|
14
|
+
### Added
|
|
15
|
+
- None
|
|
16
|
+
- Test with issue link [#1]
|
|
17
|
+
- Test with issue link [#4] in the middle of the text
|
|
18
|
+
- [#3] Test with issue link in the beginning of the text
|
|
19
|
+
- Test with issue dot [#2], [#10].
|
|
20
|
+
- Test with no issue link #123b
|
|
21
|
+
- Test with `package#2.0`
|
|
22
|
+
|
|
23
|
+
## [1.0.0] - 2017-06-20
|
|
24
|
+
### Added
|
|
25
|
+
- New visual identity by @tylerfortune8.
|
|
26
|
+
- Version navigation.
|
|
27
|
+
- Links to latest released version in previous versions.
|
|
28
|
+
- "Why keep a changelog?" section.
|
|
29
|
+
- "Who needs a changelog?" section.
|
|
30
|
+
- "How do I make a changelog?" section.
|
|
31
|
+
- "Frequently Asked Questions" section.
|
|
32
|
+
- New "Guiding Principles" sub-section to "How do I make a changelog?".
|
|
33
|
+
- Simplified and Traditional Chinese translations from @tianshuo.
|
|
34
|
+
- German translation from @mpbzh & @Art4.
|
|
35
|
+
- Italian translation from @azkidenz.
|
|
36
|
+
- Swedish translation from @magol.
|
|
37
|
+
- Turkish translation from @karalamalar.
|
|
38
|
+
- French translation from @zapashcanon.
|
|
39
|
+
- Brazilian Portugese translation from @aisamu.
|
|
40
|
+
- Polish translation from @amielucha.
|
|
41
|
+
- Russian translation from @aishek.
|
|
42
|
+
- Czech translation from @h4vry.
|
|
43
|
+
- Slovak translation from @jkostolansky.
|
|
44
|
+
|
|
45
|
+
### Changed
|
|
46
|
+
- Start using "changelog" over "change log" since it's the common usage.
|
|
47
|
+
- Start versioning based on the current English version at 0.3.0 to help
|
|
48
|
+
translation authors keep things up-to-date.
|
|
49
|
+
- Rewrite "What makes unicorns cry?" section.
|
|
50
|
+
- Rewrite "Ignoring Deprecations" sub-section to clarify the ideal scenario.
|
|
51
|
+
- Improve "Commit log diffs" sub-section to further argument against them.
|
|
52
|
+
- Merge "Why can’t people just use a git log diff?" with "Commit log diffs"
|
|
53
|
+
- Fix typos in Simplified Chinese and Traditional Chinese translations.
|
|
54
|
+
- Fix typos in Brazilian Portugese translation.
|
|
55
|
+
- Fix typos in Turkish translation.
|
|
56
|
+
- Fix typos in Czech translation.
|
|
57
|
+
- Fix typos in Swedish translation.
|
|
58
|
+
- Improve phrasing in French translation.
|
|
59
|
+
- Fix phrasing and spelling in German translation.
|
|
60
|
+
|
|
61
|
+
### Removed
|
|
62
|
+
- Section about "changelog" vs "CHANGELOG".
|
|
63
|
+
|
|
64
|
+
## [0.3.0] - 2015-12-03
|
|
65
|
+
### Added
|
|
66
|
+
- RU translation from @aishek.
|
|
67
|
+
- pt-BR translation from @tallesl.
|
|
68
|
+
- es-ES translation from @ZeliosAriex.
|
|
69
|
+
|
|
70
|
+
## [0.2.0] - 2015-10-06
|
|
71
|
+
### Changed
|
|
72
|
+
- Remove exclusionary mentions of "open source" since this project can benefit
|
|
73
|
+
both "open" and "closed" source projects equally.
|
|
74
|
+
|
|
75
|
+
## [0.1.0] - 2015-10-06
|
|
76
|
+
### Added
|
|
77
|
+
- Answer "Should you ever rewrite a change log?".
|
|
78
|
+
|
|
79
|
+
### Changed
|
|
80
|
+
- Improve argument against commit logs.
|
|
81
|
+
- Start following [SemVer](http://semver.org) properly.
|
|
82
|
+
|
|
83
|
+
## [0.0.8] - 2015-02-17
|
|
84
|
+
### Changed
|
|
85
|
+
- Update year to match in every README example.
|
|
86
|
+
- Reluctantly stop making fun of Brits only, since most of the world writes
|
|
87
|
+
dates in a strange way.
|
|
88
|
+
|
|
89
|
+
### Fixed
|
|
90
|
+
- Fix typos in recent README changes.
|
|
91
|
+
- Update outdated unreleased diff link.
|
|
92
|
+
|
|
93
|
+
## [0.0.7] - 2015-02-16
|
|
94
|
+
### Added
|
|
95
|
+
- Link, and make it obvious that date format is ISO 8601.
|
|
96
|
+
|
|
97
|
+
### Changed
|
|
98
|
+
- Clarified the section on "Is there a standard change log format?".
|
|
99
|
+
|
|
100
|
+
### Fixed
|
|
101
|
+
- Fix Markdown links to tag comparison URL with footnote-style links.
|
|
102
|
+
|
|
103
|
+
## [0.0.6] - 2014-12-12
|
|
104
|
+
### Added
|
|
105
|
+
- README section on "yanked" releases.
|
|
106
|
+
|
|
107
|
+
## [0.0.5] - 2014-08-09
|
|
108
|
+
### Added
|
|
109
|
+
- Markdown links to version tags on release headings.
|
|
110
|
+
- Unreleased section to gather unreleased changes and encourage note keeping
|
|
111
|
+
prior to releases.
|
|
112
|
+
|
|
113
|
+
## [0.0.4] - 2014-08-09
|
|
114
|
+
### Added
|
|
115
|
+
- Better explanation of the difference between the file ("CHANGELOG") and its
|
|
116
|
+
function "the change log".
|
|
117
|
+
|
|
118
|
+
### Changed
|
|
119
|
+
- Refer to a "change log" instead of a "CHANGELOG" throughout the site to
|
|
120
|
+
differentiate between the file and the purpose of the file — the logging of
|
|
121
|
+
changes.
|
|
122
|
+
|
|
123
|
+
### Removed
|
|
124
|
+
- Remove empty sections from CHANGELOG, they occupy too much space and create
|
|
125
|
+
too much noise in the file. People will have to assume that the missing
|
|
126
|
+
sections were intentionally left out because they contained no notable
|
|
127
|
+
changes.
|
|
128
|
+
|
|
129
|
+
## [0.0.3] - 2014-08-09
|
|
130
|
+
### Added
|
|
131
|
+
- "Why should I care?" section mentioning The Changelog podcast.
|
|
132
|
+
|
|
133
|
+
## [0.0.2] - 2014-07-10
|
|
134
|
+
### Added
|
|
135
|
+
- Explanation of the recommended reverse chronological release ordering.
|
|
136
|
+
|
|
137
|
+
## [0.0.1] - 2014-05-31
|
|
138
|
+
### Added
|
|
139
|
+
- This CHANGELOG file to hopefully serve as an evolving example of a
|
|
140
|
+
standardized open source project CHANGELOG.
|
|
141
|
+
- CNAME file to enable GitHub Pages custom domain
|
|
142
|
+
- README now contains answers to common questions about CHANGELOGs
|
|
143
|
+
- Good examples and basic guidelines, including proper date formatting.
|
|
144
|
+
- Counter-examples: "What makes unicorns cry?"
|
|
145
|
+
|
|
146
|
+
[#1]: https://github.com/olivierlacan/keep-a-changelog/issues/1
|
|
147
|
+
[#2]: https://github.com/olivierlacan/keep-a-changelog/issues/2
|
|
148
|
+
[#3]: https://github.com/olivierlacan/keep-a-changelog/issues/3
|
|
149
|
+
[#4]: https://github.com/olivierlacan/keep-a-changelog/issues/4
|
|
150
|
+
[#10]: https://github.com/olivierlacan/keep-a-changelog/issues/10
|
|
151
|
+
|
|
152
|
+
[Unreleased]: https://github.com/olivierlacan/keep-a-changelog/compare/v1.0.0...HEAD
|
|
153
|
+
[2.0.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v1.0.0...HEAD
|
|
154
|
+
[1.0.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.3.0...v1.0.0
|
|
155
|
+
[0.3.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.2.0...v0.3.0
|
|
156
|
+
[0.2.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.1.0...v0.2.0
|
|
157
|
+
[0.1.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.8...v0.1.0
|
|
158
|
+
[0.0.8]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.7...v0.0.8
|
|
159
|
+
[0.0.7]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.6...v0.0.7
|
|
160
|
+
[0.0.6]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.5...v0.0.6
|
|
161
|
+
[0.0.5]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.4...v0.0.5
|
|
162
|
+
[0.0.4]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.3...v0.0.4
|
|
163
|
+
[0.0.3]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.2...v0.0.3
|
|
164
|
+
[0.0.2]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.1...v0.0.2
|
|
165
|
+
[0.0.1]: https://github.com/olivierlacan/keep-a-changelog/releases/tag/v0.0.1
|
|
166
|
+
|
|
167
|
+
---
|
|
168
|
+
|
|
169
|
+
This is a footer
|
|
@@ -0,0 +1,197 @@
|
|
|
1
|
+
# Changelog - demo
|
|
2
|
+
|
|
3
|
+
All notable changes to this project will be documented in this file.
|
|
4
|
+
|
|
5
|
+
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
|
|
6
|
+
and this project adheres to
|
|
7
|
+
[Semantic Versioning](http://semver.org/spec/v2.0.0.html).
|
|
8
|
+
|
|
9
|
+
## [Unreleased]
|
|
10
|
+
|
|
11
|
+
### Added
|
|
12
|
+
|
|
13
|
+
- Test
|
|
14
|
+
|
|
15
|
+
## [2.0.0] - unreleased
|
|
16
|
+
|
|
17
|
+
### Added
|
|
18
|
+
|
|
19
|
+
- None
|
|
20
|
+
- Test with issue link [#1]
|
|
21
|
+
- Test with issue link #4 in the middle of the text
|
|
22
|
+
- #3 Test with issue link in the beginning of the text
|
|
23
|
+
- Test with issue dot #2, #10.
|
|
24
|
+
- Test with no issue link #123b
|
|
25
|
+
- Test with `package#2.0`
|
|
26
|
+
|
|
27
|
+
## [1.0.0] - 2017-06-20
|
|
28
|
+
|
|
29
|
+
### Added
|
|
30
|
+
|
|
31
|
+
- New visual identity by @tylerfortune8.
|
|
32
|
+
- Version navigation.
|
|
33
|
+
- Links to latest released version in previous versions.
|
|
34
|
+
- "Why keep a changelog?" section.
|
|
35
|
+
- "Who needs a changelog?" section.
|
|
36
|
+
- "How do I make a changelog?" section.
|
|
37
|
+
- "Frequently Asked Questions" section.
|
|
38
|
+
- New "Guiding Principles" sub-section to "How do I make a changelog?".
|
|
39
|
+
- Simplified and Traditional Chinese translations from @tianshuo.
|
|
40
|
+
- German translation from @mpbzh & @Art4.
|
|
41
|
+
- Italian translation from @azkidenz.
|
|
42
|
+
- Swedish translation from @magol.
|
|
43
|
+
- Turkish translation from @karalamalar.
|
|
44
|
+
- French translation from @zapashcanon.
|
|
45
|
+
- Brazilian Portugese translation from @aisamu.
|
|
46
|
+
- Polish translation from @amielucha.
|
|
47
|
+
- Russian translation from @aishek.
|
|
48
|
+
- Czech translation from @h4vry.
|
|
49
|
+
- Slovak translation from @jkostolansky.
|
|
50
|
+
|
|
51
|
+
### Changed
|
|
52
|
+
|
|
53
|
+
- Start using "changelog" over "change log" since it's the common usage.
|
|
54
|
+
- Start versioning based on the current English version at 0.3.0 to help
|
|
55
|
+
translation authors keep things up-to-date.
|
|
56
|
+
- Rewrite "What makes unicorns cry?" section.
|
|
57
|
+
- Rewrite "Ignoring Deprecations" sub-section to clarify the ideal scenario.
|
|
58
|
+
- Improve "Commit log diffs" sub-section to further argument against them.
|
|
59
|
+
- Merge "Why can’t people just use a git log diff?" with "Commit log diffs"
|
|
60
|
+
- Fix typos in Simplified Chinese and Traditional Chinese translations.
|
|
61
|
+
- Fix typos in Brazilian Portugese translation.
|
|
62
|
+
- Fix typos in Turkish translation.
|
|
63
|
+
- Fix typos in Czech translation.
|
|
64
|
+
- Fix typos in Swedish translation.
|
|
65
|
+
- Improve phrasing in French translation.
|
|
66
|
+
- Fix phrasing and spelling in German translation.
|
|
67
|
+
|
|
68
|
+
### Removed
|
|
69
|
+
|
|
70
|
+
- Section about "changelog" vs "CHANGELOG".
|
|
71
|
+
|
|
72
|
+
## [0.3.0] - 2015-12-03
|
|
73
|
+
|
|
74
|
+
### Added
|
|
75
|
+
|
|
76
|
+
- RU translation from @aishek.
|
|
77
|
+
- pt-BR translation from @tallesl.
|
|
78
|
+
- es-ES translation from @ZeliosAriex.
|
|
79
|
+
|
|
80
|
+
## [0.2.0] - 2015-10-06
|
|
81
|
+
|
|
82
|
+
### Changed
|
|
83
|
+
|
|
84
|
+
- Remove exclusionary mentions of "open source" since this project can benefit
|
|
85
|
+
both "open" and "closed" source projects equally.
|
|
86
|
+
|
|
87
|
+
## [0.1.0] - 2015-10-06
|
|
88
|
+
|
|
89
|
+
### Added
|
|
90
|
+
|
|
91
|
+
- Answer "Should you ever rewrite a change log?".
|
|
92
|
+
|
|
93
|
+
### Changed
|
|
94
|
+
|
|
95
|
+
- Improve argument against commit logs.
|
|
96
|
+
- Start following [SemVer](http://semver.org) properly.
|
|
97
|
+
|
|
98
|
+
## [0.0.8] - 2015-02-17
|
|
99
|
+
|
|
100
|
+
### Changed
|
|
101
|
+
|
|
102
|
+
- Update year to match in every README example.
|
|
103
|
+
- Reluctantly stop making fun of Brits only, since most of the world writes
|
|
104
|
+
dates in a strange way.
|
|
105
|
+
|
|
106
|
+
### Fixed
|
|
107
|
+
|
|
108
|
+
- Fix typos in recent README changes.
|
|
109
|
+
- Update outdated unreleased diff link.
|
|
110
|
+
|
|
111
|
+
## [0.0.7] - 2015-02-16
|
|
112
|
+
|
|
113
|
+
### Added
|
|
114
|
+
|
|
115
|
+
- Link, and make it obvious that date format is ISO 8601.
|
|
116
|
+
|
|
117
|
+
### Changed
|
|
118
|
+
|
|
119
|
+
- Clarified the section on "Is there a standard change log format?".
|
|
120
|
+
|
|
121
|
+
### Fixed
|
|
122
|
+
|
|
123
|
+
- Fix Markdown links to tag comparison URL with footnote-style links.
|
|
124
|
+
|
|
125
|
+
## [0.0.6] - 2014-12-12
|
|
126
|
+
|
|
127
|
+
### Added
|
|
128
|
+
|
|
129
|
+
- README section on "yanked" releases.
|
|
130
|
+
|
|
131
|
+
## [0.0.5] - 2014-08-09
|
|
132
|
+
|
|
133
|
+
### Added
|
|
134
|
+
|
|
135
|
+
- Markdown links to version tags on release headings.
|
|
136
|
+
- Unreleased section to gather unreleased changes and encourage note keeping
|
|
137
|
+
prior to releases.
|
|
138
|
+
|
|
139
|
+
## [0.0.4] - 2014-08-09
|
|
140
|
+
|
|
141
|
+
### Added
|
|
142
|
+
|
|
143
|
+
- Better explanation of the difference between the file ("CHANGELOG") and its
|
|
144
|
+
function "the change log".
|
|
145
|
+
|
|
146
|
+
### Changed
|
|
147
|
+
|
|
148
|
+
- Refer to a "change log" instead of a "CHANGELOG" throughout the site to
|
|
149
|
+
differentiate between the file and the purpose of the file — the logging of
|
|
150
|
+
changes.
|
|
151
|
+
|
|
152
|
+
### Removed
|
|
153
|
+
|
|
154
|
+
- Remove empty sections from CHANGELOG, they occupy too much space and create
|
|
155
|
+
too much noise in the file. People will have to assume that the missing
|
|
156
|
+
sections were intentionally left out because they contained no notable
|
|
157
|
+
changes.
|
|
158
|
+
|
|
159
|
+
## [0.0.3] - 2014-08-09
|
|
160
|
+
|
|
161
|
+
### Added
|
|
162
|
+
|
|
163
|
+
- "Why should I care?" section mentioning The Changelog podcast.
|
|
164
|
+
|
|
165
|
+
## [0.0.2] - 2014-07-10
|
|
166
|
+
|
|
167
|
+
### Added
|
|
168
|
+
|
|
169
|
+
- Explanation of the recommended reverse chronological release ordering.
|
|
170
|
+
|
|
171
|
+
## 0.0.1 - 2014-05-31
|
|
172
|
+
|
|
173
|
+
### Added
|
|
174
|
+
|
|
175
|
+
- This CHANGELOG file to hopefully serve as an evolving example of a
|
|
176
|
+
standardized open source project CHANGELOG.
|
|
177
|
+
- CNAME file to enable GitHub Pages custom domain
|
|
178
|
+
- README now contains answers to common questions about CHANGELOGs
|
|
179
|
+
- Good examples and basic guidelines, including proper date formatting.
|
|
180
|
+
- Counter-examples: "What makes unicorns cry?"
|
|
181
|
+
|
|
182
|
+
[Unreleased]: https://github.com/olivierlacan/keep-a-changelog/compare/v1.0.0...HEAD
|
|
183
|
+
[1.0.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.3.0...v1.0.0
|
|
184
|
+
[0.3.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.2.0...v0.3.0
|
|
185
|
+
[0.2.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.1.0...v0.2.0
|
|
186
|
+
[0.1.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.8...v0.1.0
|
|
187
|
+
[0.0.8]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.7...v0.0.8
|
|
188
|
+
[0.0.7]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.6...v0.0.7
|
|
189
|
+
[0.0.6]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.5...v0.0.6
|
|
190
|
+
[0.0.5]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.4...v0.0.5
|
|
191
|
+
[0.0.4]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.3...v0.0.4
|
|
192
|
+
[0.0.3]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.2...v0.0.3
|
|
193
|
+
[0.0.2]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.1...v0.0.2
|
|
194
|
+
|
|
195
|
+
---
|
|
196
|
+
|
|
197
|
+
This is a footer
|
package/package.json
CHANGED
|
@@ -1,41 +1,43 @@
|
|
|
1
1
|
{
|
|
2
|
+
"module": "./esm/mod.js",
|
|
3
|
+
"main": "./umd/mod.js",
|
|
4
|
+
"types": "./types/mod.d.ts",
|
|
5
|
+
"bin": {
|
|
6
|
+
"changelog": "./esm/bin.js"
|
|
7
|
+
},
|
|
2
8
|
"name": "keep-a-changelog",
|
|
9
|
+
"version": "2.0.0-beta",
|
|
3
10
|
"description": "Node package to parse and generate changelogs following the [keepachangelog](http://keepachangelog.com/en/1.0.0/) format.",
|
|
4
11
|
"homepage": "https://github.com/oscarotero/keep-a-changelog#readme",
|
|
5
|
-
"
|
|
6
|
-
"main": "src/index.js",
|
|
7
|
-
"bin": {
|
|
8
|
-
"changelog": "bin.js"
|
|
9
|
-
},
|
|
10
|
-
"directories": {
|
|
11
|
-
"test": "test"
|
|
12
|
-
},
|
|
13
|
-
"repository": {
|
|
14
|
-
"type": "git",
|
|
15
|
-
"url": "git+https://github.com/oscarotero/keep-a-changelog.git"
|
|
16
|
-
},
|
|
12
|
+
"license": "MIT",
|
|
17
13
|
"keywords": [
|
|
18
14
|
"changelog",
|
|
19
15
|
"keepachangelog",
|
|
20
16
|
"parser"
|
|
21
17
|
],
|
|
22
18
|
"author": "Oscar Otero <oom@oscarotero.com>",
|
|
23
|
-
"
|
|
19
|
+
"repository": {
|
|
20
|
+
"type": "git",
|
|
21
|
+
"url": "git+https://github.com/oscarotero/keep-a-changelog.git"
|
|
22
|
+
},
|
|
24
23
|
"bugs": {
|
|
25
24
|
"url": "https://github.com/oscarotero/keep-a-changelog/issues"
|
|
26
25
|
},
|
|
26
|
+
"exports": {
|
|
27
|
+
".": {
|
|
28
|
+
"import": "./esm/mod.js",
|
|
29
|
+
"require": "./umd/mod.js",
|
|
30
|
+
"types": "./types/mod.d.ts"
|
|
31
|
+
}
|
|
32
|
+
},
|
|
33
|
+
"scripts": {
|
|
34
|
+
"test": "node test_runner.js"
|
|
35
|
+
},
|
|
27
36
|
"dependencies": {
|
|
28
|
-
"
|
|
29
|
-
"semver": "^7.3.2",
|
|
30
|
-
"yargs-parser": "^18.1.3"
|
|
37
|
+
"deno.ns": "0.7.3"
|
|
31
38
|
},
|
|
32
39
|
"devDependencies": {
|
|
33
|
-
"
|
|
34
|
-
"
|
|
35
|
-
},
|
|
36
|
-
"scripts": {
|
|
37
|
-
"prettier": "prettier src/*.js test/**/*.js bin.js --single-quote --tab-width 4 --print-width 100 --write",
|
|
38
|
-
"test": "mocha test",
|
|
39
|
-
"changelog": "node example.js"
|
|
40
|
+
"@types/node": "16.11.1",
|
|
41
|
+
"chalk": "4.1.2"
|
|
40
42
|
}
|
|
41
|
-
}
|
|
43
|
+
}
|
package/types/bin.d.ts
ADDED
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
export interface Args {
|
|
2
|
+
/** Contains all the arguments that didn't have an option associated with
|
|
3
|
+
* them. */
|
|
4
|
+
_: Array<string | number>;
|
|
5
|
+
[key: string]: any;
|
|
6
|
+
}
|
|
7
|
+
export interface ArgParsingOptions {
|
|
8
|
+
/** When `true`, populate the result `_` with everything before the `--` and
|
|
9
|
+
* the result `['--']` with everything after the `--`. Here's an example:
|
|
10
|
+
*
|
|
11
|
+
* ```ts
|
|
12
|
+
* // $ deno run example.ts -- a arg1
|
|
13
|
+
* import { parse } from "./mod.ts";
|
|
14
|
+
* console.dir(parse(Deno.args, { "--": false }));
|
|
15
|
+
* // output: { _: [ "a", "arg1" ] }
|
|
16
|
+
* console.dir(parse(Deno.args, { "--": true }));
|
|
17
|
+
* // output: { _: [], --: [ "a", "arg1" ] }
|
|
18
|
+
* ```
|
|
19
|
+
*
|
|
20
|
+
* Defaults to `false`.
|
|
21
|
+
*/
|
|
22
|
+
"--"?: boolean;
|
|
23
|
+
/** An object mapping string names to strings or arrays of string argument
|
|
24
|
+
* names to use as aliases */
|
|
25
|
+
alias?: Record<string, string | string[]>;
|
|
26
|
+
/** A boolean, string or array of strings to always treat as booleans. If
|
|
27
|
+
* `true` will treat all double hyphenated arguments without equal signs as
|
|
28
|
+
* `boolean` (e.g. affects `--foo`, not `-f` or `--foo=bar`) */
|
|
29
|
+
boolean?: boolean | string | string[];
|
|
30
|
+
/** An object mapping string argument names to default values. */
|
|
31
|
+
default?: Record<string, unknown>;
|
|
32
|
+
/** When `true`, populate the result `_` with everything after the first
|
|
33
|
+
* non-option. */
|
|
34
|
+
stopEarly?: boolean;
|
|
35
|
+
/** A string or array of strings argument names to always treat as strings. */
|
|
36
|
+
string?: string | string[];
|
|
37
|
+
/** A function which is invoked with a command line parameter not defined in
|
|
38
|
+
* the `options` configuration object. If the function returns `false`, the
|
|
39
|
+
* unknown option is not added to `parsedArgs`. */
|
|
40
|
+
unknown?: (arg: string, key?: string, value?: unknown) => unknown;
|
|
41
|
+
}
|
|
42
|
+
/** Take a set of command line arguments, with an optional set of options, and
|
|
43
|
+
* return an object representation of those argument.
|
|
44
|
+
*
|
|
45
|
+
* ```ts
|
|
46
|
+
* import { parse } from "./mod.ts";
|
|
47
|
+
* const parsedArgs = parse(Deno.args);
|
|
48
|
+
* ```
|
|
49
|
+
*/
|
|
50
|
+
export declare function parse(args: string[], { "--": doubleDash, alias, boolean, default: defaults, stopEarly, string, unknown, }?: ArgParsingOptions): Args;
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
export declare const CHAR_UPPERCASE_A = 65;
|
|
2
|
+
export declare const CHAR_LOWERCASE_A = 97;
|
|
3
|
+
export declare const CHAR_UPPERCASE_Z = 90;
|
|
4
|
+
export declare const CHAR_LOWERCASE_Z = 122;
|
|
5
|
+
export declare const CHAR_DOT = 46;
|
|
6
|
+
export declare const CHAR_FORWARD_SLASH = 47;
|
|
7
|
+
export declare const CHAR_BACKWARD_SLASH = 92;
|
|
8
|
+
export declare const CHAR_VERTICAL_LINE = 124;
|
|
9
|
+
export declare const CHAR_COLON = 58;
|
|
10
|
+
export declare const CHAR_QUESTION_MARK = 63;
|
|
11
|
+
export declare const CHAR_UNDERSCORE = 95;
|
|
12
|
+
export declare const CHAR_LINE_FEED = 10;
|
|
13
|
+
export declare const CHAR_CARRIAGE_RETURN = 13;
|
|
14
|
+
export declare const CHAR_TAB = 9;
|
|
15
|
+
export declare const CHAR_FORM_FEED = 12;
|
|
16
|
+
export declare const CHAR_EXCLAMATION_MARK = 33;
|
|
17
|
+
export declare const CHAR_HASH = 35;
|
|
18
|
+
export declare const CHAR_SPACE = 32;
|
|
19
|
+
export declare const CHAR_NO_BREAK_SPACE = 160;
|
|
20
|
+
export declare const CHAR_ZERO_WIDTH_NOBREAK_SPACE = 65279;
|
|
21
|
+
export declare const CHAR_LEFT_SQUARE_BRACKET = 91;
|
|
22
|
+
export declare const CHAR_RIGHT_SQUARE_BRACKET = 93;
|
|
23
|
+
export declare const CHAR_LEFT_ANGLE_BRACKET = 60;
|
|
24
|
+
export declare const CHAR_RIGHT_ANGLE_BRACKET = 62;
|
|
25
|
+
export declare const CHAR_LEFT_CURLY_BRACKET = 123;
|
|
26
|
+
export declare const CHAR_RIGHT_CURLY_BRACKET = 125;
|
|
27
|
+
export declare const CHAR_HYPHEN_MINUS = 45;
|
|
28
|
+
export declare const CHAR_PLUS = 43;
|
|
29
|
+
export declare const CHAR_DOUBLE_QUOTE = 34;
|
|
30
|
+
export declare const CHAR_SINGLE_QUOTE = 39;
|
|
31
|
+
export declare const CHAR_PERCENT = 37;
|
|
32
|
+
export declare const CHAR_SEMICOLON = 59;
|
|
33
|
+
export declare const CHAR_CIRCUMFLEX_ACCENT = 94;
|
|
34
|
+
export declare const CHAR_GRAVE_ACCENT = 96;
|
|
35
|
+
export declare const CHAR_AT = 64;
|
|
36
|
+
export declare const CHAR_AMPERSAND = 38;
|
|
37
|
+
export declare const CHAR_EQUAL = 61;
|
|
38
|
+
export declare const CHAR_0 = 48;
|
|
39
|
+
export declare const CHAR_9 = 57;
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* A parsed path object generated by path.parse() or consumed by path.format().
|
|
3
|
+
*/
|
|
4
|
+
export interface ParsedPath {
|
|
5
|
+
/**
|
|
6
|
+
* The root of the path such as '/' or 'c:\'
|
|
7
|
+
*/
|
|
8
|
+
root: string;
|
|
9
|
+
/**
|
|
10
|
+
* The full directory path such as '/home/user/dir' or 'c:\path\dir'
|
|
11
|
+
*/
|
|
12
|
+
dir: string;
|
|
13
|
+
/**
|
|
14
|
+
* The file name including extension (if any) such as 'index.html'
|
|
15
|
+
*/
|
|
16
|
+
base: string;
|
|
17
|
+
/**
|
|
18
|
+
* The file extension (if any) such as '.html'
|
|
19
|
+
*/
|
|
20
|
+
ext: string;
|
|
21
|
+
/**
|
|
22
|
+
* The file name without extension (if any) such as 'index'
|
|
23
|
+
*/
|
|
24
|
+
name: string;
|
|
25
|
+
}
|
|
26
|
+
export declare type FormatInputPathObject = Partial<ParsedPath>;
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import type { FormatInputPathObject } from "./_interface.js";
|
|
2
|
+
export declare function assertPath(path: string): void;
|
|
3
|
+
export declare function isPosixPathSeparator(code: number): boolean;
|
|
4
|
+
export declare function isPathSeparator(code: number): boolean;
|
|
5
|
+
export declare function isWindowsDeviceRoot(code: number): boolean;
|
|
6
|
+
export declare function normalizeString(path: string, allowAboveRoot: boolean, separator: string, isPathSeparator: (code: number) => boolean): string;
|
|
7
|
+
export declare function _format(sep: string, pathObject: FormatInputPathObject): string;
|
|
8
|
+
export declare function encodeWhitespace(string: string): string;
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
/** Determines the common path from a set of paths, using an optional separator,
|
|
2
|
+
* which defaults to the OS default separator.
|
|
3
|
+
*
|
|
4
|
+
* ```ts
|
|
5
|
+
* import { common } from "https://deno.land/std@$STD_VERSION/path/mod.ts";
|
|
6
|
+
* const p = common([
|
|
7
|
+
* "./deno/std/path/mod.ts",
|
|
8
|
+
* "./deno/std/fs/mod.ts",
|
|
9
|
+
* ]);
|
|
10
|
+
* console.log(p); // "./deno/std/"
|
|
11
|
+
* ```
|
|
12
|
+
*/
|
|
13
|
+
export declare function common(paths: string[], sep?: string): string;
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
import type { OSType } from "../_util/os.js";
|
|
2
|
+
export interface GlobOptions {
|
|
3
|
+
/** Extended glob syntax.
|
|
4
|
+
* See https://www.linuxjournal.com/content/bash-extended-globbing. Defaults
|
|
5
|
+
* to true. */
|
|
6
|
+
extended?: boolean;
|
|
7
|
+
/** Globstar syntax.
|
|
8
|
+
* See https://www.linuxjournal.com/content/globstar-new-bash-globbing-option.
|
|
9
|
+
* If false, `**` is treated like `*`. Defaults to true. */
|
|
10
|
+
globstar?: boolean;
|
|
11
|
+
/** Whether globstar should be case insensitive. */
|
|
12
|
+
caseInsensitive?: boolean;
|
|
13
|
+
/** Operating system. Defaults to the native OS. */
|
|
14
|
+
os?: OSType;
|
|
15
|
+
}
|
|
16
|
+
export declare type GlobToRegExpOptions = GlobOptions;
|
|
17
|
+
/** Convert a glob string to a regular expression.
|
|
18
|
+
*
|
|
19
|
+
* Tries to match bash glob expansion as closely as possible.
|
|
20
|
+
*
|
|
21
|
+
* Basic glob syntax:
|
|
22
|
+
* - `*` - Matches everything without leaving the path segment.
|
|
23
|
+
* - `?` - Matches any single character.
|
|
24
|
+
* - `{foo,bar}` - Matches `foo` or `bar`.
|
|
25
|
+
* - `[abcd]` - Matches `a`, `b`, `c` or `d`.
|
|
26
|
+
* - `[a-d]` - Matches `a`, `b`, `c` or `d`.
|
|
27
|
+
* - `[!abcd]` - Matches any single character besides `a`, `b`, `c` or `d`.
|
|
28
|
+
* - `[[:<class>:]]` - Matches any character belonging to `<class>`.
|
|
29
|
+
* - `[[:alnum:]]` - Matches any digit or letter.
|
|
30
|
+
* - `[[:digit:]abc]` - Matches any digit, `a`, `b` or `c`.
|
|
31
|
+
* - See https://facelessuser.github.io/wcmatch/glob/#posix-character-classes
|
|
32
|
+
* for a complete list of supported character classes.
|
|
33
|
+
* - `\` - Escapes the next character for an `os` other than `"windows"`.
|
|
34
|
+
* - \` - Escapes the next character for `os` set to `"windows"`.
|
|
35
|
+
* - `/` - Path separator.
|
|
36
|
+
* - `\` - Additional path separator only for `os` set to `"windows"`.
|
|
37
|
+
*
|
|
38
|
+
* Extended syntax:
|
|
39
|
+
* - Requires `{ extended: true }`.
|
|
40
|
+
* - `?(foo|bar)` - Matches 0 or 1 instance of `{foo,bar}`.
|
|
41
|
+
* - `@(foo|bar)` - Matches 1 instance of `{foo,bar}`. They behave the same.
|
|
42
|
+
* - `*(foo|bar)` - Matches _n_ instances of `{foo,bar}`.
|
|
43
|
+
* - `+(foo|bar)` - Matches _n > 0_ instances of `{foo,bar}`.
|
|
44
|
+
* - `!(foo|bar)` - Matches anything other than `{foo,bar}`.
|
|
45
|
+
* - See https://www.linuxjournal.com/content/bash-extended-globbing.
|
|
46
|
+
*
|
|
47
|
+
* Globstar syntax:
|
|
48
|
+
* - Requires `{ globstar: true }`.
|
|
49
|
+
* - `**` - Matches any number of any path segments.
|
|
50
|
+
* - Must comprise its entire path segment in the provided glob.
|
|
51
|
+
* - See https://www.linuxjournal.com/content/globstar-new-bash-globbing-option.
|
|
52
|
+
*
|
|
53
|
+
* Note the following properties:
|
|
54
|
+
* - The generated `RegExp` is anchored at both start and end.
|
|
55
|
+
* - Repeating and trailing separators are tolerated. Trailing separators in the
|
|
56
|
+
* provided glob have no meaning and are discarded.
|
|
57
|
+
* - Absolute globs will only match absolute paths, etc.
|
|
58
|
+
* - Empty globs will match nothing.
|
|
59
|
+
* - Any special glob syntax must be contained to one path segment. For example,
|
|
60
|
+
* `?(foo|bar/baz)` is invalid. The separator will take precedence and the
|
|
61
|
+
* first segment ends with an unclosed group.
|
|
62
|
+
* - If a path segment ends with unclosed groups or a dangling escape prefix, a
|
|
63
|
+
* parse error has occurred. Every character for that segment is taken
|
|
64
|
+
* literally in this event.
|
|
65
|
+
*
|
|
66
|
+
* Limitations:
|
|
67
|
+
* - A negative group like `!(foo|bar)` will wrongly be converted to a negative
|
|
68
|
+
* look-ahead followed by a wildcard. This means that `!(foo).js` will wrongly
|
|
69
|
+
* fail to match `foobar.js`, even though `foobar` is not `foo`. Effectively,
|
|
70
|
+
* `!(foo|bar)` is treated like `!(@(foo|bar)*)`. This will work correctly if
|
|
71
|
+
* the group occurs not nested at the end of the segment. */
|
|
72
|
+
export declare function globToRegExp(glob: string, { extended, globstar: globstarOption, os, caseInsensitive, }?: GlobToRegExpOptions): RegExp;
|
|
73
|
+
/** Test whether the given string is a glob */
|
|
74
|
+
export declare function isGlob(str: string): boolean;
|
|
75
|
+
/** Like normalize(), but doesn't collapse "**\/.." when `globstar` is true. */
|
|
76
|
+
export declare function normalizeGlob(glob: string, { globstar }?: GlobOptions): string;
|
|
77
|
+
/** Like join(), but doesn't collapse "**\/.." when `globstar` is true. */
|
|
78
|
+
export declare function joinGlobs(globs: string[], { extended, globstar }?: GlobOptions): string;
|