keep-a-changelog 2.3.0 → 2.5.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.
Files changed (213) hide show
  1. package/CHANGELOG.md +33 -4
  2. package/README.md +23 -8
  3. package/esm/_dnt.shims.js +0 -1
  4. package/esm/bin.js +19 -20
  5. package/esm/deps/deno.land/std@0.205.0/semver/_shared.d.ts +42 -0
  6. package/esm/deps/deno.land/std@0.205.0/semver/_shared.js +230 -0
  7. package/esm/deps/deno.land/std@0.205.0/semver/cmp.d.ts +9 -0
  8. package/esm/deps/deno.land/std@0.205.0/semver/cmp.js +35 -0
  9. package/esm/deps/deno.land/std@0.205.0/semver/comparator_format.d.ts +8 -0
  10. package/esm/deps/deno.land/std@0.205.0/semver/comparator_format.js +11 -0
  11. package/esm/deps/deno.land/std@0.205.0/semver/comparator_intersects.d.ts +8 -0
  12. package/esm/deps/deno.land/std@0.205.0/semver/comparator_intersects.js +45 -0
  13. package/esm/deps/deno.land/std@0.205.0/semver/comparator_max.d.ts +9 -0
  14. package/esm/deps/deno.land/std@0.205.0/semver/comparator_max.js +45 -0
  15. package/esm/deps/deno.land/std@0.205.0/semver/comparator_min.d.ts +8 -0
  16. package/esm/deps/deno.land/std@0.205.0/semver/comparator_min.js +32 -0
  17. package/esm/deps/deno.land/std@0.205.0/semver/compare.d.ts +10 -0
  18. package/esm/deps/deno.land/std@0.205.0/semver/compare.js +18 -0
  19. package/esm/deps/deno.land/std@0.205.0/semver/compare_build.d.ts +13 -0
  20. package/esm/deps/deno.land/std@0.205.0/semver/compare_build.js +23 -0
  21. package/esm/deps/deno.land/std@0.205.0/semver/constants.d.ts +42 -0
  22. package/esm/deps/deno.land/std@0.205.0/semver/constants.js +75 -0
  23. package/esm/deps/deno.land/std@0.205.0/semver/difference.d.ts +4 -0
  24. package/esm/deps/deno.land/std@0.205.0/semver/difference.js +26 -0
  25. package/esm/deps/deno.land/std@0.205.0/semver/eq.d.ts +4 -0
  26. package/esm/deps/deno.land/std@0.205.0/semver/eq.js +7 -0
  27. package/esm/deps/deno.land/std@0.205.0/semver/format.d.ts +12 -0
  28. package/esm/deps/deno.land/std@0.205.0/semver/format.js +54 -0
  29. package/esm/deps/deno.land/std@0.205.0/semver/gt.d.ts +3 -0
  30. package/esm/deps/deno.land/std@0.205.0/semver/gt.js +5 -0
  31. package/esm/deps/deno.land/std@0.205.0/semver/gte.d.ts +3 -0
  32. package/esm/deps/deno.land/std@0.205.0/semver/gte.js +5 -0
  33. package/esm/deps/deno.land/std@0.205.0/semver/gtr.d.ts +3 -0
  34. package/esm/deps/deno.land/std@0.205.0/semver/gtr.js +5 -0
  35. package/esm/deps/deno.land/std@0.205.0/semver/increment.d.ts +28 -0
  36. package/esm/deps/deno.land/std@0.205.0/semver/increment.js +207 -0
  37. package/esm/deps/deno.land/std@0.205.0/semver/is_semver.d.ts +17 -0
  38. package/esm/deps/deno.land/std@0.205.0/semver/is_semver.js +41 -0
  39. package/esm/deps/deno.land/std@0.205.0/semver/is_semver_comparator.d.ts +12 -0
  40. package/esm/deps/deno.land/std@0.205.0/semver/is_semver_comparator.js +31 -0
  41. package/esm/deps/deno.land/std@0.205.0/semver/is_semver_range.d.ts +12 -0
  42. package/esm/deps/deno.land/std@0.205.0/semver/is_semver_range.js +22 -0
  43. package/esm/deps/deno.land/std@0.205.0/semver/lt.d.ts +3 -0
  44. package/esm/deps/deno.land/std@0.205.0/semver/lt.js +5 -0
  45. package/esm/deps/deno.land/std@0.205.0/semver/lte.d.ts +3 -0
  46. package/esm/deps/deno.land/std@0.205.0/semver/lte.js +5 -0
  47. package/esm/deps/deno.land/std@0.205.0/semver/ltr.d.ts +3 -0
  48. package/esm/deps/deno.land/std@0.205.0/semver/ltr.js +5 -0
  49. package/esm/deps/deno.land/std@0.205.0/semver/max_satisfying.d.ts +9 -0
  50. package/esm/deps/deno.land/std@0.205.0/semver/max_satisfying.js +14 -0
  51. package/esm/deps/deno.land/std@0.205.0/semver/min_satisfying.d.ts +9 -0
  52. package/esm/deps/deno.land/std@0.205.0/semver/min_satisfying.js +14 -0
  53. package/esm/deps/deno.land/{std@0.173.0 → std@0.205.0}/semver/mod.d.ts +88 -176
  54. package/esm/deps/deno.land/std@0.205.0/semver/mod.js +313 -0
  55. package/esm/deps/deno.land/std@0.205.0/semver/neq.d.ts +3 -0
  56. package/esm/deps/deno.land/std@0.205.0/semver/neq.js +5 -0
  57. package/esm/deps/deno.land/std@0.205.0/semver/outside.d.ts +11 -0
  58. package/esm/deps/deno.land/std@0.205.0/semver/outside.js +67 -0
  59. package/esm/deps/deno.land/std@0.205.0/semver/parse.d.ts +8 -0
  60. package/esm/deps/deno.land/std@0.205.0/semver/parse.js +66 -0
  61. package/esm/deps/deno.land/std@0.205.0/semver/parse_comparator.d.ts +7 -0
  62. package/esm/deps/deno.land/std@0.205.0/semver/parse_comparator.js +28 -0
  63. package/esm/deps/deno.land/std@0.205.0/semver/parse_range.d.ts +7 -0
  64. package/esm/deps/deno.land/std@0.205.0/semver/parse_range.js +292 -0
  65. package/esm/deps/deno.land/std@0.205.0/semver/range_format.d.ts +8 -0
  66. package/esm/deps/deno.land/std@0.205.0/semver/range_format.js +11 -0
  67. package/esm/deps/deno.land/std@0.205.0/semver/range_intersects.d.ts +8 -0
  68. package/esm/deps/deno.land/std@0.205.0/semver/range_intersects.js +35 -0
  69. package/esm/deps/deno.land/std@0.205.0/semver/range_max.d.ts +7 -0
  70. package/esm/deps/deno.land/std@0.205.0/semver/range_max.js +15 -0
  71. package/esm/deps/deno.land/std@0.205.0/semver/range_min.d.ts +7 -0
  72. package/esm/deps/deno.land/std@0.205.0/semver/range_min.js +14 -0
  73. package/esm/deps/deno.land/std@0.205.0/semver/rcompare.d.ts +8 -0
  74. package/esm/deps/deno.land/std@0.205.0/semver/rcompare.js +10 -0
  75. package/esm/deps/deno.land/std@0.205.0/semver/rsort.d.ts +3 -0
  76. package/esm/deps/deno.land/std@0.205.0/semver/rsort.js +5 -0
  77. package/esm/deps/deno.land/std@0.205.0/semver/sort.d.ts +3 -0
  78. package/esm/deps/deno.land/std@0.205.0/semver/sort.js +5 -0
  79. package/esm/deps/deno.land/std@0.205.0/semver/test_comparator.d.ts +8 -0
  80. package/esm/deps/deno.land/std@0.205.0/semver/test_comparator.js +10 -0
  81. package/esm/deps/deno.land/std@0.205.0/semver/test_range.d.ts +8 -0
  82. package/esm/deps/deno.land/std@0.205.0/semver/test_range.js +16 -0
  83. package/esm/deps/deno.land/std@0.205.0/semver/types.d.ts +44 -0
  84. package/esm/deps/deno.land/std@0.205.0/semver/types.js +2 -0
  85. package/esm/src/Changelog.d.ts +6 -2
  86. package/esm/src/Changelog.js +42 -4
  87. package/esm/src/Release.d.ts +5 -4
  88. package/esm/src/Release.js +21 -22
  89. package/esm/src/deps.d.ts +2 -1
  90. package/esm/src/deps.js +1 -1
  91. package/esm/src/settings.d.ts +17 -0
  92. package/esm/src/settings.js +47 -0
  93. package/esm/test/changelog.custom.type.md +2 -3
  94. package/esm/test/changelog.expected.linted.md +3 -4
  95. package/esm/test/changelog.expected.md +3 -4
  96. package/esm/test/changelog.md +3 -4
  97. package/esm/test/empty.expected.md +2 -2
  98. package/package.json +2 -2
  99. package/script/_dnt.shims.js +0 -1
  100. package/script/bin.js +22 -20
  101. package/script/deps/deno.land/std@0.205.0/semver/_shared.d.ts +42 -0
  102. package/script/deps/deno.land/std@0.205.0/semver/_shared.js +248 -0
  103. package/script/deps/deno.land/std@0.205.0/semver/cmp.d.ts +9 -0
  104. package/script/deps/deno.land/std@0.205.0/semver/cmp.js +39 -0
  105. package/script/deps/deno.land/std@0.205.0/semver/comparator_format.d.ts +8 -0
  106. package/script/deps/deno.land/std@0.205.0/semver/comparator_format.js +15 -0
  107. package/script/deps/deno.land/std@0.205.0/semver/comparator_intersects.d.ts +8 -0
  108. package/script/deps/deno.land/std@0.205.0/semver/comparator_intersects.js +49 -0
  109. package/script/deps/deno.land/std@0.205.0/semver/comparator_max.d.ts +9 -0
  110. package/script/deps/deno.land/std@0.205.0/semver/comparator_max.js +49 -0
  111. package/script/deps/deno.land/std@0.205.0/semver/comparator_min.d.ts +8 -0
  112. package/script/deps/deno.land/std@0.205.0/semver/comparator_min.js +36 -0
  113. package/script/deps/deno.land/std@0.205.0/semver/compare.d.ts +10 -0
  114. package/script/deps/deno.land/std@0.205.0/semver/compare.js +22 -0
  115. package/script/deps/deno.land/std@0.205.0/semver/compare_build.d.ts +13 -0
  116. package/script/deps/deno.land/std@0.205.0/semver/compare_build.js +27 -0
  117. package/script/deps/deno.land/std@0.205.0/semver/constants.d.ts +42 -0
  118. package/script/deps/deno.land/std@0.205.0/semver/constants.js +78 -0
  119. package/script/deps/deno.land/std@0.205.0/semver/difference.d.ts +4 -0
  120. package/script/deps/deno.land/std@0.205.0/semver/difference.js +30 -0
  121. package/script/deps/deno.land/std@0.205.0/semver/eq.d.ts +4 -0
  122. package/script/deps/deno.land/std@0.205.0/semver/eq.js +11 -0
  123. package/script/deps/deno.land/std@0.205.0/semver/format.d.ts +12 -0
  124. package/script/deps/deno.land/std@0.205.0/semver/format.js +58 -0
  125. package/script/deps/deno.land/std@0.205.0/semver/gt.d.ts +3 -0
  126. package/script/deps/deno.land/std@0.205.0/semver/gt.js +9 -0
  127. package/script/deps/deno.land/std@0.205.0/semver/gte.d.ts +3 -0
  128. package/script/deps/deno.land/std@0.205.0/semver/gte.js +9 -0
  129. package/script/deps/deno.land/std@0.205.0/semver/gtr.d.ts +3 -0
  130. package/script/deps/deno.land/std@0.205.0/semver/gtr.js +9 -0
  131. package/script/deps/deno.land/std@0.205.0/semver/increment.d.ts +28 -0
  132. package/script/deps/deno.land/std@0.205.0/semver/increment.js +211 -0
  133. package/script/deps/deno.land/std@0.205.0/semver/is_semver.d.ts +17 -0
  134. package/script/deps/deno.land/std@0.205.0/semver/is_semver.js +45 -0
  135. package/script/deps/deno.land/std@0.205.0/semver/is_semver_comparator.d.ts +12 -0
  136. package/script/deps/deno.land/std@0.205.0/semver/is_semver_comparator.js +35 -0
  137. package/script/deps/deno.land/std@0.205.0/semver/is_semver_range.d.ts +12 -0
  138. package/script/deps/deno.land/std@0.205.0/semver/is_semver_range.js +26 -0
  139. package/script/deps/deno.land/std@0.205.0/semver/lt.d.ts +3 -0
  140. package/script/deps/deno.land/std@0.205.0/semver/lt.js +9 -0
  141. package/script/deps/deno.land/std@0.205.0/semver/lte.d.ts +3 -0
  142. package/script/deps/deno.land/std@0.205.0/semver/lte.js +9 -0
  143. package/script/deps/deno.land/std@0.205.0/semver/ltr.d.ts +3 -0
  144. package/script/deps/deno.land/std@0.205.0/semver/ltr.js +9 -0
  145. package/script/deps/deno.land/std@0.205.0/semver/max_satisfying.d.ts +9 -0
  146. package/script/deps/deno.land/std@0.205.0/semver/max_satisfying.js +18 -0
  147. package/script/deps/deno.land/std@0.205.0/semver/min_satisfying.d.ts +9 -0
  148. package/script/deps/deno.land/std@0.205.0/semver/min_satisfying.js +18 -0
  149. package/script/deps/deno.land/{std@0.173.0 → std@0.205.0}/semver/mod.d.ts +88 -176
  150. package/script/deps/deno.land/std@0.205.0/semver/mod.js +330 -0
  151. package/script/deps/deno.land/std@0.205.0/semver/neq.d.ts +3 -0
  152. package/script/deps/deno.land/std@0.205.0/semver/neq.js +9 -0
  153. package/script/deps/deno.land/std@0.205.0/semver/outside.d.ts +11 -0
  154. package/script/deps/deno.land/std@0.205.0/semver/outside.js +71 -0
  155. package/script/deps/deno.land/std@0.205.0/semver/parse.d.ts +8 -0
  156. package/script/deps/deno.land/std@0.205.0/semver/parse.js +70 -0
  157. package/script/deps/deno.land/std@0.205.0/semver/parse_comparator.d.ts +7 -0
  158. package/script/deps/deno.land/std@0.205.0/semver/parse_comparator.js +32 -0
  159. package/script/deps/deno.land/std@0.205.0/semver/parse_range.d.ts +7 -0
  160. package/script/deps/deno.land/std@0.205.0/semver/parse_range.js +296 -0
  161. package/script/deps/deno.land/std@0.205.0/semver/range_format.d.ts +8 -0
  162. package/script/deps/deno.land/std@0.205.0/semver/range_format.js +15 -0
  163. package/script/deps/deno.land/std@0.205.0/semver/range_intersects.d.ts +8 -0
  164. package/script/deps/deno.land/std@0.205.0/semver/range_intersects.js +39 -0
  165. package/script/deps/deno.land/std@0.205.0/semver/range_max.d.ts +7 -0
  166. package/script/deps/deno.land/std@0.205.0/semver/range_max.js +19 -0
  167. package/script/deps/deno.land/std@0.205.0/semver/range_min.d.ts +7 -0
  168. package/script/deps/deno.land/std@0.205.0/semver/range_min.js +18 -0
  169. package/script/deps/deno.land/std@0.205.0/semver/rcompare.d.ts +8 -0
  170. package/script/deps/deno.land/std@0.205.0/semver/rcompare.js +14 -0
  171. package/script/deps/deno.land/std@0.205.0/semver/rsort.d.ts +3 -0
  172. package/script/deps/deno.land/std@0.205.0/semver/rsort.js +9 -0
  173. package/script/deps/deno.land/std@0.205.0/semver/sort.d.ts +3 -0
  174. package/script/deps/deno.land/std@0.205.0/semver/sort.js +9 -0
  175. package/script/deps/deno.land/std@0.205.0/semver/test_comparator.d.ts +8 -0
  176. package/script/deps/deno.land/std@0.205.0/semver/test_comparator.js +14 -0
  177. package/script/deps/deno.land/std@0.205.0/semver/test_range.d.ts +8 -0
  178. package/script/deps/deno.land/std@0.205.0/semver/test_range.js +20 -0
  179. package/script/deps/deno.land/std@0.205.0/semver/types.d.ts +44 -0
  180. package/script/deps/deno.land/std@0.205.0/semver/types.js +3 -0
  181. package/script/src/Changelog.d.ts +6 -2
  182. package/script/src/Changelog.js +41 -3
  183. package/script/src/Release.d.ts +5 -4
  184. package/script/src/Release.js +20 -21
  185. package/script/src/deps.d.ts +2 -1
  186. package/script/src/deps.js +5 -6
  187. package/script/src/settings.d.ts +17 -0
  188. package/script/src/settings.js +51 -0
  189. package/script/test/changelog.custom.type.md +2 -3
  190. package/script/test/changelog.expected.linted.md +3 -4
  191. package/script/test/changelog.expected.md +3 -4
  192. package/script/test/changelog.md +3 -4
  193. package/script/test/empty.expected.md +2 -2
  194. package/esm/_dnt.test_shims.d.ts +0 -5
  195. package/esm/deps/deno.land/std@0.133.0/fmt/colors.d.ts +0 -270
  196. package/esm/deps/deno.land/std@0.133.0/testing/_diff.d.ts +0 -23
  197. package/esm/deps/deno.land/std@0.133.0/testing/asserts.d.ts +0 -167
  198. package/esm/deps/deno.land/std@0.173.0/semver/mod.js +0 -1420
  199. package/esm/test/Change.test.d.ts +0 -1
  200. package/esm/test/deps.d.ts +0 -1
  201. package/esm/test/fixture/CustomRelease.d.ts +0 -8
  202. package/esm/test/parser.test.d.ts +0 -1
  203. package/esm/test/test.d.ts +0 -1
  204. package/script/_dnt.test_shims.d.ts +0 -5
  205. package/script/deps/deno.land/std@0.133.0/fmt/colors.d.ts +0 -270
  206. package/script/deps/deno.land/std@0.133.0/testing/_diff.d.ts +0 -23
  207. package/script/deps/deno.land/std@0.133.0/testing/asserts.d.ts +0 -167
  208. package/script/deps/deno.land/std@0.173.0/semver/mod.js +0 -1458
  209. package/script/test/Change.test.d.ts +0 -1
  210. package/script/test/deps.d.ts +0 -1
  211. package/script/test/fixture/CustomRelease.d.ts +0 -8
  212. package/script/test/parser.test.d.ts +0 -1
  213. package/script/test/test.d.ts +0 -1
@@ -0,0 +1,313 @@
1
+ // Copyright Isaac Z. Schlueter and Contributors. All rights reserved. ISC license.
2
+ // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
3
+ // This module is browser compatible.
4
+ /**
5
+ * The semantic version parser.
6
+ *
7
+ * Adapted directly from [semver](https://github.com/npm/node-semver).
8
+ *
9
+ * ## Versions
10
+ *
11
+ * A "version" is described by the `v2.0.0` specification found at
12
+ * <https://semver.org>.
13
+ *
14
+ * A leading `"="` or `"v"` character is stripped off and ignored.
15
+ *
16
+ * ## Format
17
+ *
18
+ * Semantic versions can be formatted as strings, by default they
19
+ * are formatted as `full`. Below is a diagram showing the various
20
+ * formatting options.
21
+ *
22
+ * ```
23
+ * ┌───── full
24
+ * ┌───┴───┐
25
+ * ├───────── release
26
+ * ┌───┴───┐ │
27
+ * ├───────────── primary
28
+ * ┌─┴─┐ │ │
29
+ * 1.2.3-pre.1+b.1
30
+ * │ │ │ └─┬─┘ └┬┘
31
+ * │ │ │ │ └── build
32
+ * │ │ │ └─────── pre
33
+ * │ │ └─────────── patch
34
+ * │ └───────────── minor
35
+ * └─────────────── major
36
+ * ```
37
+ *
38
+ * ## Ranges
39
+ *
40
+ * A `version range` is a set of `comparators` which specify versions that satisfy
41
+ * the range.
42
+ *
43
+ * A `comparator` is composed of an `operator` and a `version`. The set of
44
+ * primitive `operators` is:
45
+ *
46
+ * - `<` Less than
47
+ * - `<=` Less than or equal to
48
+ * - `>` Greater than
49
+ * - `>=` Greater than or equal to
50
+ * - `=` Equal. If no operator is specified, then equality is assumed, so this
51
+ * operator is optional, but MAY be included.
52
+ *
53
+ * For example, the comparator `>=1.2.7` would match the versions `1.2.7`, `1.2.8`,
54
+ * `2.5.3`, and `1.3.9`, but not the versions `1.2.6` or `1.1.0`.
55
+ *
56
+ * Comparators can be joined by whitespace to form a `comparator set`, which is
57
+ * satisfied by the **intersection** of all of the comparators it includes.
58
+ *
59
+ * A range is composed of one or more comparator sets, joined by `||`. A version
60
+ * matches a range if and only if every comparator in at least one of the
61
+ * `||`-separated comparator sets is satisfied by the version.
62
+ *
63
+ * For example, the range `>=1.2.7 <1.3.0` would match the versions `1.2.7`,
64
+ * `1.2.8`, and `1.2.99`, but not the versions `1.2.6`, `1.3.0`, or `1.1.0`.
65
+ *
66
+ * The range `1.2.7 || >=1.2.9 <2.0.0` would match the versions `1.2.7`, `1.2.9`,
67
+ * and `1.4.6`, but not the versions `1.2.8` or `2.0.0`.
68
+ *
69
+ * ### Prerelease Tags
70
+ *
71
+ * If a version has a prerelease tag (for example, `1.2.3-alpha.3`) then it will
72
+ * only be allowed to satisfy comparator sets if at least one comparator with the
73
+ * same `[major, minor, patch]` tuple also has a prerelease tag.
74
+ *
75
+ * For example, the range `>1.2.3-alpha.3` would be allowed to match the version
76
+ * `1.2.3-alpha.7`, but it would _not_ be satisfied by `3.4.5-alpha.9`, even though
77
+ * `3.4.5-alpha.9` is technically "greater than" `1.2.3-alpha.3` according to the
78
+ * SemVer sort rules. The version range only accepts prerelease tags on the `1.2.3`
79
+ * version. The version `3.4.5` _would_ satisfy the range, because it does not have
80
+ * a prerelease flag, and `3.4.5` is greater than `1.2.3-alpha.7`.
81
+ *
82
+ * The purpose for this behavior is twofold. First, prerelease versions frequently
83
+ * are updated very quickly, and contain many breaking changes that are (by the
84
+ * author"s design) not yet fit for public consumption. Therefore, by default, they
85
+ * are excluded from range matching semantics.
86
+ *
87
+ * Second, a user who has opted into using a prerelease version has clearly
88
+ * indicated the intent to use _that specific_ set of alpha/beta/rc versions. By
89
+ * including a prerelease tag in the range, the user is indicating that they are
90
+ * aware of the risk. However, it is still not appropriate to assume that they have
91
+ * opted into taking a similar risk on the _next_ set of prerelease versions.
92
+ *
93
+ * Note that this behavior can be suppressed (treating all prerelease versions as
94
+ * if they were normal versions, for the purpose of range matching) by setting the
95
+ * `includePrerelease` flag on the options object to any [functions](#functions)
96
+ * that do range matching.
97
+ *
98
+ * #### Prerelease Identifiers
99
+ *
100
+ * The method `.increment` takes an additional `identifier` string argument that
101
+ * will append the value of the string as a prerelease identifier:
102
+ *
103
+ * ```javascript
104
+ * semver.increment(parse("1.2.3"), "prerelease", "beta");
105
+ * // "1.2.4-beta.0"
106
+ * ```
107
+ *
108
+ * ### Build Metadata
109
+ *
110
+ * Build metadata is `.` delimited alpha-numeric string.
111
+ * When parsing a version it is retained on the `build: string[]` field
112
+ * of the semver instance. When incrementing there is an additional parameter that
113
+ * can set the build metadata on the semver instance.
114
+ *
115
+ * ### Advanced Range Syntax
116
+ *
117
+ * Advanced range syntax desugars to primitive comparators in deterministic ways.
118
+ *
119
+ * Advanced ranges may be combined in the same way as primitive comparators using
120
+ * white space or `||`.
121
+ *
122
+ * #### Hyphen Ranges `X.Y.Z - A.B.C`
123
+ *
124
+ * Specifies an inclusive set.
125
+ *
126
+ * - `1.2.3 - 2.3.4` := `>=1.2.3 <=2.3.4`
127
+ *
128
+ * If a partial version is provided as the first version in the inclusive range,
129
+ * then the missing pieces are replaced with zeroes.
130
+ *
131
+ * - `1.2 - 2.3.4` := `>=1.2.0 <=2.3.4`
132
+ *
133
+ * If a partial version is provided as the second version in the inclusive range,
134
+ * then all versions that start with the supplied parts of the tuple are accepted,
135
+ * but nothing that would be greater than the provided tuple parts.
136
+ *
137
+ * - `1.2.3 - 2.3` := `>=1.2.3 <2.4.0`
138
+ * - `1.2.3 - 2` := `>=1.2.3 <3.0.0`
139
+ *
140
+ * #### X-Ranges `1.2.x` `1.X` `1.2.*` `*`
141
+ *
142
+ * Any of `X`, `x`, or `*` may be used to "stand in" for one of the numeric values
143
+ * in the `[major, minor, patch]` tuple.
144
+ *
145
+ * - `*` := `>=0.0.0` (Any version satisfies)
146
+ * - `1.x` := `>=1.0.0 <2.0.0` (Matching major version)
147
+ * - `1.2.x` := `>=1.2.0 <1.3.0` (Matching major and minor versions)
148
+ *
149
+ * A partial version range is treated as an X-Range, so the special character is in
150
+ * fact optional.
151
+ *
152
+ * - `""` (empty string) := `*` := `>=0.0.0`
153
+ * - `1` := `1.x.x` := `>=1.0.0 <2.0.0`
154
+ * - `1.2` := `1.2.x` := `>=1.2.0 <1.3.0`
155
+ *
156
+ * #### Tilde Ranges `~1.2.3` `~1.2` `~1`
157
+ *
158
+ * Allows patch-level changes if a minor version is specified on the comparator.
159
+ * Allows minor-level changes if not.
160
+ *
161
+ * - `~1.2.3` := `>=1.2.3 <1.(2+1).0` := `>=1.2.3 <1.3.0`
162
+ * - `~1.2` := `>=1.2.0 <1.(2+1).0` := `>=1.2.0 <1.3.0` (Same as `1.2.x`)
163
+ * - `~1` := `>=1.0.0 <(1+1).0.0` := `>=1.0.0 <2.0.0` (Same as `1.x`)
164
+ * - `~0.2.3` := `>=0.2.3 <0.(2+1).0` := `>=0.2.3 <0.3.0`
165
+ * - `~0.2` := `>=0.2.0 <0.(2+1).0` := `>=0.2.0 <0.3.0` (Same as `0.2.x`)
166
+ * - `~0` := `>=0.0.0 <(0+1).0.0` := `>=0.0.0 <1.0.0` (Same as `0.x`)
167
+ * - `~1.2.3-beta.2` := `>=1.2.3-beta.2 <1.3.0` Note that prereleases in the
168
+ * `1.2.3` version will be allowed, if they are greater than or equal to
169
+ * `beta.2`. So, `1.2.3-beta.4` would be allowed, but `1.2.4-beta.2` would not,
170
+ * because it is a prerelease of a different `[major, minor, patch]` tuple.
171
+ *
172
+ * #### Caret Ranges `^1.2.3` `^0.2.5` `^0.0.4`
173
+ *
174
+ * Allows changes that do not modify the left-most non-zero element in the
175
+ * `[major, minor, patch]` tuple. In other words, this allows patch and minor
176
+ * updates for versions `1.0.0` and above, patch updates for versions
177
+ * `0.X >=0.1.0`, and _no_ updates for versions `0.0.X`.
178
+ *
179
+ * Many authors treat a `0.x` version as if the `x` were the major
180
+ * "breaking-change" indicator.
181
+ *
182
+ * Caret ranges are ideal when an author may make breaking changes between `0.2.4`
183
+ * and `0.3.0` releases, which is a common practice. However, it presumes that
184
+ * there will _not_ be breaking changes between `0.2.4` and `0.2.5`. It allows for
185
+ * changes that are presumed to be additive (but non-breaking), according to
186
+ * commonly observed practices.
187
+ *
188
+ * - `^1.2.3` := `>=1.2.3 <2.0.0`
189
+ * - `^0.2.3` := `>=0.2.3 <0.3.0`
190
+ * - `^0.0.3` := `>=0.0.3 <0.0.4`
191
+ * - `^1.2.3-beta.2` := `>=1.2.3-beta.2 <2.0.0` Note that prereleases in the
192
+ * `1.2.3` version will be allowed, if they are greater than or equal to
193
+ * `beta.2`. So, `1.2.3-beta.4` would be allowed, but `1.2.4-beta.2` would not,
194
+ * because it is a prerelease of a different `[major, minor, patch]` tuple.
195
+ * - `^0.0.3-beta` := `>=0.0.3-beta <0.0.4` Note that prereleases in the `0.0.3`
196
+ * version _only_ will be allowed, if they are greater than or equal to `beta`.
197
+ * So, `0.0.3-pr.2` would be allowed.
198
+ *
199
+ * When parsing caret ranges, a missing `patch` value desugars to the number `0`,
200
+ * but will allow flexibility within that value, even if the major and minor
201
+ * versions are both `0`.
202
+ *
203
+ * - `^1.2.x` := `>=1.2.0 <2.0.0`
204
+ * - `^0.0.x` := `>=0.0.0 <0.1.0`
205
+ * - `^0.0` := `>=0.0.0 <0.1.0`
206
+ *
207
+ * A missing `minor` and `patch` values will desugar to zero, but also allow
208
+ * flexibility within those values, even if the major version is zero.
209
+ *
210
+ * - `^1.x` := `>=1.0.0 <2.0.0`
211
+ * - `^0.x` := `>=0.0.0 <1.0.0`
212
+ *
213
+ * ### Range Grammar
214
+ *
215
+ * Putting all this together, here is a Backus-Naur grammar for ranges, for the
216
+ * benefit of parser authors:
217
+ *
218
+ * ```bnf
219
+ * range-set ::= range ( logical-or range ) *
220
+ * logical-or ::= ( " " ) * "||" ( " " ) *
221
+ * range ::= hyphen | simple ( " " simple ) * | ""
222
+ * hyphen ::= partial " - " partial
223
+ * simple ::= primitive | partial | tilde | caret
224
+ * primitive ::= ( "<" | ">" | ">=" | "<=" | "=" ) partial
225
+ * partial ::= xr ( "." xr ( "." xr qualifier ? )? )?
226
+ * xr ::= "x" | "X" | "*" | nr
227
+ * nr ::= "0" | ["1"-"9"] ( ["0"-"9"] ) *
228
+ * tilde ::= "~" partial
229
+ * caret ::= "^" partial
230
+ * qualifier ::= ( "-" pre )? ( "+" build )?
231
+ * pre ::= parts
232
+ * build ::= parts
233
+ * parts ::= part ( "." part ) *
234
+ * part ::= nr | [-0-9A-Za-z]+
235
+ * ```
236
+ *
237
+ * Note that, since ranges may be non-contiguous, a version might not be greater
238
+ * than a range, less than a range, _or_ satisfy a range! For example, the range
239
+ * `1.2 <1.2.9 || >2.0.0` would have a hole from `1.2.9` until `2.0.0`, so the
240
+ * version `1.2.10` would not be greater than the range (because `2.0.1` satisfies,
241
+ * which is higher), nor less than the range (since `1.2.8` satisfies, which is
242
+ * lower), and it also does not satisfy the range.
243
+ *
244
+ * If you want to know if a version satisfies or does not satisfy a range, use the
245
+ * {@linkcode satisfies} function.
246
+ *
247
+ * This module is browser compatible.
248
+ *
249
+ * @example
250
+ * ```ts
251
+ * import {
252
+ * parse,
253
+ * parseComparator,
254
+ * parseRange,
255
+ * gt,
256
+ * lt,
257
+ * format
258
+ * } from "https://deno.land/std@$STD_VERSION/semver/mod.ts";
259
+ *
260
+ * const semver = parse("1.2.3");
261
+ * const range = parseRange("1.x || >=2.5.0 || 5.0.0 - 7.2.3");
262
+ *
263
+ * const s0 = parse("1.2.3");
264
+ * const s1 = parse("9.8.7");
265
+ * gt(s0, s1); // false
266
+ * lt(s0, s1); // true
267
+ *
268
+ * format(semver) // "1.2.3"
269
+ * ```
270
+ *
271
+ * @module
272
+ */
273
+ export * from "./cmp.js";
274
+ export * from "./comparator_format.js";
275
+ export * from "./comparator_intersects.js";
276
+ export * from "./comparator_max.js";
277
+ export * from "./comparator_min.js";
278
+ export * from "./compare_build.js";
279
+ export * from "./compare.js";
280
+ export * from "./constants.js";
281
+ export * from "./difference.js";
282
+ export * from "./eq.js";
283
+ export * from "./format.js";
284
+ export * from "./gt.js";
285
+ export * from "./gte.js";
286
+ export * from "./gtr.js";
287
+ export * from "./test_comparator.js";
288
+ export * from "./test_range.js";
289
+ export * from "./increment.js";
290
+ export * from "./is_semver_comparator.js";
291
+ export * from "./is_semver_range.js";
292
+ export * from "./is_semver.js";
293
+ export * from "./lt.js";
294
+ export * from "./lte.js";
295
+ export * from "./ltr.js";
296
+ export * from "./max_satisfying.js";
297
+ export * from "./min_satisfying.js";
298
+ export * from "./neq.js";
299
+ export * from "./outside.js";
300
+ export * from "./parse_comparator.js";
301
+ export * from "./parse_range.js";
302
+ export * from "./parse.js";
303
+ export * from "./range_format.js";
304
+ export * from "./range_intersects.js";
305
+ export * from "./range_max.js";
306
+ export * from "./range_min.js";
307
+ export * from "./rcompare.js";
308
+ export * from "./rsort.js";
309
+ export * from "./sort.js";
310
+ export * from "./types.js";
311
+ export * from "./lte.js";
312
+ export * from "./lte.js";
313
+ export const SEMVER_SPEC_VERSION = "2.0.0";
@@ -0,0 +1,3 @@
1
+ import type { SemVer } from "./types.js";
2
+ /** Not equal comparison */
3
+ export declare function neq(s0: SemVer, s1: SemVer): boolean;
@@ -0,0 +1,5 @@
1
+ import { compare } from "./compare.js";
2
+ /** Not equal comparison */
3
+ export function neq(s0, s1) {
4
+ return compare(s0, s1) !== 0;
5
+ }
@@ -0,0 +1,11 @@
1
+ import type { SemVer, SemVerRange } from "./types.js";
2
+ /**
3
+ * Returns true if the version is outside the bounds of the range in either the
4
+ * high or low direction. The hilo argument must be either the string '>' or
5
+ * '<'. (This is the function called by {@linkcode gtr} and {@linkcode ltr}.)
6
+ * @param version The version to compare to the range
7
+ * @param range The range of possible versions
8
+ * @param hilo The operator for the comparison or both if undefined.
9
+ * @returns True if the version is outside of the range based on the operator
10
+ */
11
+ export declare function outside(version: SemVer, range: SemVerRange, hilo?: ">" | "<"): boolean;
@@ -0,0 +1,67 @@
1
+ // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
2
+ import { gt } from "./gt.js";
3
+ import { gte } from "./gte.js";
4
+ import { lte } from "./lte.js";
5
+ import { lt } from "./lt.js";
6
+ import { ALL, ANY } from "./constants.js";
7
+ import { testRange } from "./test_range.js";
8
+ /**
9
+ * Returns true if the version is outside the bounds of the range in either the
10
+ * high or low direction. The hilo argument must be either the string '>' or
11
+ * '<'. (This is the function called by {@linkcode gtr} and {@linkcode ltr}.)
12
+ * @param version The version to compare to the range
13
+ * @param range The range of possible versions
14
+ * @param hilo The operator for the comparison or both if undefined.
15
+ * @returns True if the version is outside of the range based on the operator
16
+ */
17
+ export function outside(version, range, hilo) {
18
+ if (!hilo) {
19
+ return outside(version, range, ">") ||
20
+ outside(version, range, "<");
21
+ }
22
+ const [gtfn, ltefn, ltfn, comp, ecomp] = (() => {
23
+ switch (hilo) {
24
+ case ">":
25
+ return [gt, lte, lt, ">", ">="];
26
+ case "<":
27
+ return [lt, gte, gt, "<", "<="];
28
+ }
29
+ })();
30
+ if (testRange(version, range)) {
31
+ return false;
32
+ }
33
+ for (const comparators of range.ranges) {
34
+ let high = undefined;
35
+ let low = undefined;
36
+ for (let comparator of comparators) {
37
+ if (comparator.semver === ANY) {
38
+ comparator = ALL;
39
+ }
40
+ high = high || comparator;
41
+ low = low || comparator;
42
+ if (gtfn(comparator.semver, high.semver)) {
43
+ high = comparator;
44
+ }
45
+ else if (ltfn(comparator.semver, low.semver)) {
46
+ low = comparator;
47
+ }
48
+ }
49
+ if (!high || !low)
50
+ return true;
51
+ // If the edge version comparator has a operator then our version
52
+ // isn't outside it
53
+ if (high.operator === comp || high.operator === ecomp) {
54
+ return false;
55
+ }
56
+ // If the lowest version comparator has an operator and our version
57
+ // is less than it then it isn't higher than the range
58
+ if ((!low.operator || low.operator === comp) &&
59
+ ltefn(version, low.semver)) {
60
+ return false;
61
+ }
62
+ else if (low.operator === ecomp && ltfn(version, low.semver)) {
63
+ return false;
64
+ }
65
+ }
66
+ return true;
67
+ }
@@ -0,0 +1,8 @@
1
+ import { SemVer } from "./types.js";
2
+ /**
3
+ * Attempt to parse a string as a semantic version, returning either a `SemVer`
4
+ * object or throws a TypeError.
5
+ * @param version The version string to parse
6
+ * @returns A valid SemVer
7
+ */
8
+ export declare function parse(version: string | SemVer): SemVer;
@@ -0,0 +1,66 @@
1
+ import { isValidNumber } from "./_shared.js";
2
+ import { isSemVer } from "./is_semver.js";
3
+ import { FULL, MAX_LENGTH, NUMERICIDENTIFIER, re, src } from "./_shared.js";
4
+ /**
5
+ * Attempt to parse a string as a semantic version, returning either a `SemVer`
6
+ * object or throws a TypeError.
7
+ * @param version The version string to parse
8
+ * @returns A valid SemVer
9
+ */
10
+ export function parse(version) {
11
+ if (typeof version === "object") {
12
+ if (isSemVer(version)) {
13
+ return version;
14
+ }
15
+ else {
16
+ throw new TypeError(`not a valid SemVer object`);
17
+ }
18
+ }
19
+ if (typeof version !== "string") {
20
+ throw new TypeError(`version must be a string`);
21
+ }
22
+ if (version.length > MAX_LENGTH) {
23
+ throw new TypeError(`version is longer than ${MAX_LENGTH} characters`);
24
+ }
25
+ version = version.trim();
26
+ const r = re[FULL];
27
+ const m = version.match(r);
28
+ if (!m) {
29
+ throw new TypeError(`Invalid Version: ${version}`);
30
+ }
31
+ // these are actually numbers
32
+ const major = parseInt(m[1]);
33
+ const minor = parseInt(m[2]);
34
+ const patch = parseInt(m[3]);
35
+ if (major > Number.MAX_SAFE_INTEGER || major < 0) {
36
+ throw new TypeError("Invalid major version");
37
+ }
38
+ if (minor > Number.MAX_SAFE_INTEGER || minor < 0) {
39
+ throw new TypeError("Invalid minor version");
40
+ }
41
+ if (patch > Number.MAX_SAFE_INTEGER || patch < 0) {
42
+ throw new TypeError("Invalid patch version");
43
+ }
44
+ // number-ify any prerelease numeric ids
45
+ const numericIdentifier = new RegExp(`^(${src[NUMERICIDENTIFIER]})$`);
46
+ const prerelease = (m[4] ?? "")
47
+ .split(".")
48
+ .filter((id) => id)
49
+ .map((id) => {
50
+ const num = parseInt(id);
51
+ if (id.match(numericIdentifier) && isValidNumber(num)) {
52
+ return num;
53
+ }
54
+ else {
55
+ return id;
56
+ }
57
+ });
58
+ const build = m[5]?.split(".")?.filter((m) => m) ?? [];
59
+ return {
60
+ major,
61
+ minor,
62
+ patch,
63
+ prerelease,
64
+ build,
65
+ };
66
+ }
@@ -0,0 +1,7 @@
1
+ import type { SemVerComparator } from "./types.js";
2
+ /**
3
+ * Parses a comparator string into a valid SemVerComparator.
4
+ * @param comparator
5
+ * @returns A valid SemVerComparator
6
+ */
7
+ export declare function parseComparator(comparator: string): SemVerComparator;
@@ -0,0 +1,28 @@
1
+ // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
2
+ import { parse } from "./parse.js";
3
+ import { COMPARATOR, re } from "./_shared.js";
4
+ import { comparatorMax } from "./comparator_max.js";
5
+ import { comparatorMin } from "./comparator_min.js";
6
+ import { ANY, NONE } from "./constants.js";
7
+ /**
8
+ * Parses a comparator string into a valid SemVerComparator.
9
+ * @param comparator
10
+ * @returns A valid SemVerComparator
11
+ */
12
+ export function parseComparator(comparator) {
13
+ const r = re[COMPARATOR];
14
+ const m = comparator.match(r);
15
+ if (!m) {
16
+ return NONE;
17
+ }
18
+ const operator = (m[1] ?? "");
19
+ const semver = m[2] ? parse(m[2]) : ANY;
20
+ const min = comparatorMin(semver, operator);
21
+ const max = comparatorMax(semver, operator);
22
+ return {
23
+ operator,
24
+ semver,
25
+ min,
26
+ max,
27
+ };
28
+ }
@@ -0,0 +1,7 @@
1
+ import type { SemVerRange } from "./types.js";
2
+ /**
3
+ * Parses a range string into a SemVerRange object or throws a TypeError.
4
+ * @param range The range string
5
+ * @returns A valid semantic version range
6
+ */
7
+ export declare function parseRange(range: string): SemVerRange;