Skip to content

Commit 1af4026

Browse files
ci010ci010
committed
feat: Add the fabric semver as package
1 parent 59f5761 commit 1af4026

File tree

11 files changed

+801
-16
lines changed

11 files changed

+801
-16
lines changed

‎README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ Go [our document website](https://docs.xmcl.app/en/core) to find more detail usa
4747
| @xmcl/resourcepack | Parse resource pack | [![npm version](https://img.shields.io/npm/v/@xmcl/resourcepack.svg)](https://www.npmjs.com/package/@xmcl/resourcepack) | [packages/resourcepack ](/packages/resourcepack) | Node/Browser |
4848
| @xmcl/task | Util package to create task | [![npm version](https://img.shields.io/npm/v/@xmcl/task.svg)](https://www.npmjs.com/package/@xmcl/task) | [packages/task ](/packages/task) | Node/Browser |
4949
| @xmcl/system | A fs middleware for browser/node | [![npm version](https://img.shields.io/npm/v/@xmcl/system.svg)](https://www.npmjs.com/package/@xmcl/system) | [packages/system ](/packages/system) | Node/Browser |
50+
| @xmcl/semver | The special semver format using by fabricmc. | [![npm version](https://img.shields.io/npm/v/@xmcl/semver.svg)](https://www.npmjs.com/package/@xmcl/semver) | [packages/semver ](/packages/semver) | Node/Browser |
5051
| @xmcl/unzip | yauzl unzip wrapper | [![npm version](https://img.shields.io/npm/v/@xmcl/unzip.svg)](https://www.npmjs.com/package/@xmcl/unzip) | [packages/unzip ](/packages/unzip) | Node |
5152
| @xmcl/file-transfer | High performance undici file download implementation | [![npm version](https://img.shields.io/npm/v/@xmcl/file-transfer.svg)](https://www.npmjs.com/package/@xmcl/file-transfer) | [packages/file-transfer ](/packages/file-transfer) | Node |
5253
| @xmcl/nat-api | Port mapping with UPnP and NAT-PMP | [![npm version](https://img.shields.io/npm/v/@xmcl/nat-api.svg)](https://www.npmjs.com/package/@xmcl/nat-api) | [packages/nat-api ](/packages/nat-api) | Node |

‎packages/semver/.npmignore‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
*.test.d.ts
2+
*.test.js
3+
*.test.js.map
4+
*.test.ts
5+
test.d.ts
6+
test.js
7+
test.js.map
8+
test.ts
9+
*.ts
10+
!*.d.ts
11+
*.log
12+
tsconfig.json

‎packages/semver/LICENSE‎

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "{}"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright {yyyy} {name of copyright owner}
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎packages/semver/README.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Fabric Semetic Version Module
2+
3+
[![npm version](https://img.shields.io/npm/v/@xmcl/semver.svg)](https://www.npmjs.com/package/@xmcl/semver)
4+
[![Downloads](https://img.shields.io/npm/dm/@xmcl/semver.svg)](https://npmjs.com/@xmcl/semver)
5+
[![Install size](https://packagephobia.now.sh/badge?p=@xmcl/semver)](https://packagephobia.now.sh/result?p=@xmcl/semver)
6+
[![npm](https://img.shields.io/npm/l/@xmcl/minecraft-launcher-core.svg)](https://github.com/voxelum/minecraft-launcher-core-node/blob/master/LICENSE)
7+
[![Build Status](https://github.com/voxelum/minecraft-launcher-core-node/workflows/Build/badge.svg)](https://github.com/Voxelum/minecraft-launcher-core-node/actions?query=workflow%3ABuild)
8+
9+
Port the fabric special [sementic version algorithm](https://github.com/FabricMC/fabric-loader/tree/master/src/main/java/net/fabricmc/loader/impl/util/version) to typescript.
10+
11+
12+
```ts
13+
import { parseVersionRange, FabricSemanticVersion } from "@xmcl/semver";
14+
15+
const versionRangeString = ">=1.0+fabric+minecraft"; // this is invalid as a normal semver but valid here
16+
const versionRange = parseVersionRange(versionRangeString);
17+
18+
const versionString = "1.21"; // a Minecraft version
19+
const semver = parseSemanticVersion(versionString);
20+
21+
const isVersionInRange = versionRange.test(semver); // is version in this version range
22+
```
23+
24+

‎packages/semver/index.ts‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
/**
2+
* @module @xmcl/semver
3+
*/
4+
export * from './semver'
5+
export * from './range'

‎packages/semver/operators.ts‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
/*
2+
* Copyright 2016 FabricMC
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
import { FabricSemanticVersion as SemanticVersion } from './semver'
17+
18+
export enum VersionComparisonOperator {
19+
GREATER_EQUAL = '>=',
20+
LESS_EQUAL = '<=',
21+
GREATER = '>',
22+
LESS = '<',
23+
EQUAL = '=',
24+
SAME_TO_NEXT_MINOR = '~',
25+
SAME_TO_NEXT_MAJOR = '^',
26+
}
27+
28+
const operatorFunctions = {
29+
[VersionComparisonOperator.GREATER_EQUAL]: (a: SemanticVersion, b: SemanticVersion) => a.compareTo(b) >= 0,
30+
[VersionComparisonOperator.LESS_EQUAL]: (a: SemanticVersion, b: SemanticVersion) => a.compareTo(b) <= 0,
31+
[VersionComparisonOperator.GREATER]: (a: SemanticVersion, b: SemanticVersion) => a.compareTo(b) > 0,
32+
[VersionComparisonOperator.LESS]: (a: SemanticVersion, b: SemanticVersion) => a.compareTo(b) < 0,
33+
[VersionComparisonOperator.EQUAL]: (a: SemanticVersion, b: SemanticVersion) => a.compareTo(b) === 0,
34+
[VersionComparisonOperator.SAME_TO_NEXT_MINOR]: (a: SemanticVersion, b: SemanticVersion) =>
35+
a.compareTo(b) >= 0 &&
36+
a.getVersionComponent(0) === b.getVersionComponent(0) &&
37+
a.getVersionComponent(1) === b.getVersionComponent(1),
38+
[VersionComparisonOperator.SAME_TO_NEXT_MAJOR]: (a: SemanticVersion, b: SemanticVersion) =>
39+
a.compareTo(b) >= 0 && a.getVersionComponent(0) === b.getVersionComponent(0),
40+
}
41+
42+
const operatorMinMax = {
43+
[VersionComparisonOperator.SAME_TO_NEXT_MINOR]: (version: SemanticVersion) => ({
44+
min: version,
45+
max: { getVersionComponent: (i: number) => (i === 1 ? version.getVersionComponent(1) + 1 : version.getVersionComponent(i)) },
46+
}),
47+
[VersionComparisonOperator.SAME_TO_NEXT_MAJOR]: (version: SemanticVersion) => ({
48+
min: version,
49+
max: { getVersionComponent: (i: number) => (i === 0 ? version.getVersionComponent(0) + 1 : version.getVersionComponent(i)) },
50+
}),
51+
default: (version: SemanticVersion) => ({ min: version, max: version }),
52+
}
53+
54+
export function testVersion(operator: VersionComparisonOperator, a: SemanticVersion, b: SemanticVersion): boolean {
55+
if (isSemanticVersion(a) && isSemanticVersion(b)) {
56+
return operatorFunctions[operator](a, b)
57+
} else {
58+
return a.getFriendlyString() === b.getFriendlyString()
59+
}
60+
}
61+
62+
export function getMinMaxVersion(operator: VersionComparisonOperator, version: SemanticVersion) {
63+
// @ts-ignore
64+
return operatorMinMax[operator]?.(version) ?? operatorMinMax.default(version)
65+
}
66+
67+
function isSemanticVersion(version: SemanticVersion): version is SemanticVersion {
68+
return 'compareTo' in version && 'getVersionComponent' in version
69+
}

‎packages/semver/package.json‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
{
2+
"name": "@xmcl/semver",
3+
"version": "0.0.1",
4+
"main": "./index.ts",
5+
"author": {
6+
"name": "[email protected]"
7+
},
8+
"description": "The special semver format using by fabricmc.",
9+
"scripts": {
10+
"build:type": "tsc",
11+
"build:cjs": "esbuild --target=es2020 --platform=neutral --sourcemap --format=cjs --bundle --outfile=dist/index.js index.ts",
12+
"build:esm": "esbuild --target=es2020 --platform=neutral --sourcemap --format=esm --bundle --outfile=dist/index.mjs index.ts"
13+
},
14+
"publishConfig": {
15+
"main": "./dist/index.js",
16+
"module": "./dist/index.mjs",
17+
"access": "public"
18+
},
19+
"license": "MIT",
20+
"repository": {
21+
"type": "git",
22+
"url": "git+https://github.com/Voxelum/minecraft-launcher-core-node.git"
23+
},
24+
"devDependencies": {
25+
"@types/node": "~18.15.11",
26+
"@xmcl/oxlint-config": "workspace:^*",
27+
"esbuild": "^0.17.16",
28+
"oxlint": "^0.15.5",
29+
"typescript": "^5.3.3"
30+
}
31+
}

0 commit comments

Comments
 (0)