@git.zone/cli 9.2.2 → 10.0.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 (96) hide show
  1. package/assets/templates/asset_binary_installer/install.sh +109 -34
  2. package/assets/templates/asset_binary_release_gitea/.gitea/workflows/release.yml +17 -4
  3. package/assets/templates/ci_rust/.gitea/workflows/rust_nottags.yaml +29 -0
  4. package/assets/templates/ci_rust/.gitea/workflows/rust_tags.yaml +32 -0
  5. package/assets/templates/gitignore/_gitignore +1 -1
  6. package/assets/templates/gitignore_rust/_gitignore +31 -0
  7. package/assets/templates/license_mit/license +4 -1
  8. package/assets/templates/rust/.smartscaf.yml +16 -0
  9. package/assets/templates/rust/_Cargo.toml +12 -0
  10. package/assets/templates/rust/_crate_Cargo.toml +10 -0
  11. package/assets/templates/rust/_crate_lib.rs +19 -0
  12. package/assets/templates/rust/_smartconfig.json +27 -0
  13. package/assets/templates/rust/readme.md +23 -0
  14. package/dist_ts/00_commitinfo_data.js +2 -2
  15. package/dist_ts/classes.gitzoneconfig.d.ts +3 -1
  16. package/dist_ts/classes.gitzoneconfig.js +9 -1
  17. package/dist_ts/helpers.managedassets.d.ts +1 -1
  18. package/dist_ts/helpers.managedassets.js +58 -14
  19. package/dist_ts/helpers.releasetargets.d.ts +6 -0
  20. package/dist_ts/helpers.releasetargets.js +13 -0
  21. package/dist_ts/helpers.smartconfigmigrations.js +42 -1
  22. package/dist_ts/helpers.toolconfig.d.ts +50 -0
  23. package/dist_ts/helpers.toolconfig.js +212 -0
  24. package/dist_ts/helpers.tssea.d.ts +9 -2
  25. package/dist_ts/helpers.tssea.js +47 -17
  26. package/dist_ts/helpers.tstest.d.ts +27 -8
  27. package/dist_ts/helpers.tstest.js +64 -26
  28. package/dist_ts/helpers.versionsource.d.ts +37 -0
  29. package/dist_ts/helpers.versionsource.js +112 -0
  30. package/dist_ts/helpers.workflow.d.ts +45 -1
  31. package/dist_ts/helpers.workflow.js +120 -5
  32. package/dist_ts/mod_commit/mod.helpers.d.ts +0 -24
  33. package/dist_ts/mod_commit/mod.helpers.js +1 -94
  34. package/dist_ts/mod_config/index.js +131 -18
  35. package/dist_ts/mod_format/formatters/assets.formatter.js +29 -27
  36. package/dist_ts/mod_format/formatters/gitignore.formatter.d.ts +4 -2
  37. package/dist_ts/mod_format/formatters/gitignore.formatter.js +10 -7
  38. package/dist_ts/mod_format/formatters/license.formatter.d.ts +8 -0
  39. package/dist_ts/mod_format/formatters/license.formatter.js +25 -2
  40. package/dist_ts/mod_format/formatters/packagejson.formatter.js +14 -3
  41. package/dist_ts/mod_format/formatters/rustfmt.formatter.d.ts +19 -0
  42. package/dist_ts/mod_format/formatters/rustfmt.formatter.js +97 -0
  43. package/dist_ts/mod_format/formatters/smartconfig.formatter.js +5 -2
  44. package/dist_ts/mod_format/index.js +3 -1
  45. package/dist_ts/mod_format/interfaces.format.js +2 -1
  46. package/dist_ts/mod_release/classes.releasejournal.d.ts +38 -2
  47. package/dist_ts/mod_release/classes.releasejournal.js +238 -66
  48. package/dist_ts/mod_release/helpers.cargorelease.d.ts +52 -0
  49. package/dist_ts/mod_release/helpers.cargorelease.js +195 -0
  50. package/dist_ts/mod_release/helpers.npmpackages.d.ts +18 -0
  51. package/dist_ts/mod_release/helpers.npmpackages.js +40 -2
  52. package/dist_ts/mod_release/helpers.releasecheck.d.ts +73 -0
  53. package/dist_ts/mod_release/helpers.releasecheck.js +269 -0
  54. package/dist_ts/mod_release/helpers.releasepreparation.d.ts +22 -8
  55. package/dist_ts/mod_release/helpers.releasepreparation.js +74 -26
  56. package/dist_ts/mod_release/helpers.releasepublication.d.ts +21 -1
  57. package/dist_ts/mod_release/helpers.releasepublication.js +249 -4
  58. package/dist_ts/mod_release/helpers.releaseversionsource.d.ts +10 -0
  59. package/dist_ts/mod_release/helpers.releaseversionsource.js +18 -0
  60. package/dist_ts/mod_release/helpers.rsrepoengine.d.ts +192 -0
  61. package/dist_ts/mod_release/helpers.rsrepoengine.js +457 -0
  62. package/dist_ts/mod_release/index.d.ts +3 -0
  63. package/dist_ts/mod_release/index.js +177 -65
  64. package/dist_ts/mod_template/index.js +6 -2
  65. package/package.json +1 -1
  66. package/readme.md +237 -21
  67. package/ts/00_commitinfo_data.ts +1 -1
  68. package/ts/classes.gitzoneconfig.ts +10 -1
  69. package/ts/helpers.managedassets.ts +64 -14
  70. package/ts/helpers.releasetargets.ts +13 -0
  71. package/ts/helpers.smartconfigmigrations.ts +48 -0
  72. package/ts/helpers.toolconfig.ts +280 -0
  73. package/ts/helpers.tssea.ts +59 -16
  74. package/ts/helpers.tstest.ts +105 -35
  75. package/ts/helpers.versionsource.ts +169 -0
  76. package/ts/helpers.workflow.ts +197 -5
  77. package/ts/mod_commit/mod.helpers.ts +0 -119
  78. package/ts/mod_config/index.ts +169 -19
  79. package/ts/mod_format/formatters/assets.formatter.ts +28 -27
  80. package/ts/mod_format/formatters/gitignore.formatter.ts +10 -6
  81. package/ts/mod_format/formatters/license.formatter.ts +26 -1
  82. package/ts/mod_format/formatters/packagejson.formatter.ts +14 -2
  83. package/ts/mod_format/formatters/rustfmt.formatter.ts +107 -0
  84. package/ts/mod_format/formatters/smartconfig.formatter.ts +8 -1
  85. package/ts/mod_format/index.ts +2 -0
  86. package/ts/mod_format/interfaces.format.ts +1 -0
  87. package/ts/mod_release/classes.releasejournal.ts +312 -39
  88. package/ts/mod_release/helpers.cargorelease.ts +289 -0
  89. package/ts/mod_release/helpers.npmpackages.ts +76 -1
  90. package/ts/mod_release/helpers.releasecheck.ts +409 -0
  91. package/ts/mod_release/helpers.releasepreparation.ts +116 -36
  92. package/ts/mod_release/helpers.releasepublication.ts +462 -1
  93. package/ts/mod_release/helpers.releaseversionsource.ts +29 -0
  94. package/ts/mod_release/helpers.rsrepoengine.ts +790 -0
  95. package/ts/mod_release/index.ts +277 -84
  96. package/ts/mod_template/index.ts +5 -1
@@ -0,0 +1,289 @@
1
+ import * as plugins from "./mod.plugins.js";
2
+ import type { IResolvedReleaseCargoConfiguration } from "../helpers.workflow.js";
3
+ import {
4
+ releaseCrateArtifactFile,
5
+ type IReleaseCargoJournal,
6
+ type IReleaseCrateArtifact,
7
+ } from "./classes.releasejournal.js";
8
+ import {
9
+ RsrepoEngineClient,
10
+ rsrepoEngineCommands,
11
+ type IRsrepoEngineClient,
12
+ type IRsrepoPackedCrate,
13
+ type IRsrepoPlanResult,
14
+ } from "./helpers.rsrepoengine.js";
15
+ import { withIsolatedReleaseCheckout } from "./helpers.releasepreparation.js";
16
+
17
+ /**
18
+ * The project's rsrepo engine, refused unless it supports every command a
19
+ * Cargo release runs.
20
+ */
21
+ export const openCargoReleaseEngine = async (
22
+ smartshellArg: plugins.smartshell.Smartshell,
23
+ cwdArg: string,
24
+ ): Promise<IRsrepoEngineClient> => {
25
+ const engine = await RsrepoEngineClient.forProject(smartshellArg, cwdArg);
26
+ await engine.assertCapabilities(rsrepoEngineCommands);
27
+ return engine;
28
+ };
29
+
30
+ /** The workspace plan for the cargo target: its registries and member filter. */
31
+ export const readCargoReleasePlan = async (
32
+ engineArg: IRsrepoEngineClient,
33
+ cwdArg: string,
34
+ cargoArg: IResolvedReleaseCargoConfiguration,
35
+ ): Promise<IRsrepoPlanResult> =>
36
+ engineArg.plan({
37
+ cwd: cwdArg,
38
+ registries: cargoArg.registries,
39
+ ...(cargoArg.members ? { members: cargoArg.members } : {}),
40
+ });
41
+
42
+ /**
43
+ * Why the plan cannot be released, one line each; empty when it can. A
44
+ * release needs a committed Cargo.lock, one shared version, at least one
45
+ * selected crate, no blocking problem on a selected crate, and every
46
+ * selected crate's normal and build dependencies selected too, because a
47
+ * registry refuses a crate whose dependency version it does not have.
48
+ */
49
+ export const findCargoReleaseProblems = (
50
+ planArg: IRsrepoPlanResult,
51
+ cargoArg: IResolvedReleaseCargoConfiguration,
52
+ ): string[] => {
53
+ const problems: string[] = [];
54
+ if (!planArg.lockfile) {
55
+ problems.push(
56
+ "The Cargo workspace tracks no Cargo.lock; a cargo release publishes with --locked. Run `cargo generate-lockfile` and commit Cargo.lock.",
57
+ );
58
+ }
59
+ if (planArg.versionMode === "independent") {
60
+ problems.push(
61
+ "The Cargo workspace versions its crates independently; gitzone releases one shared [workspace.package] version.",
62
+ );
63
+ }
64
+ for (const member of cargoArg.members ?? []) {
65
+ if (!planArg.members.some((entry) => entry.name === member))
66
+ problems.push(
67
+ `release.targets.cargo.members names ${member}, which is not a workspace member.`,
68
+ );
69
+ }
70
+ const selected = planArg.members.filter((member) => member.selected);
71
+ if (selected.length === 0) {
72
+ problems.push(
73
+ `No workspace member is publishable to ${cargoArg.registries.join(", ")}${cargoArg.members ? " among release.targets.cargo.members" : ""}.`,
74
+ );
75
+ }
76
+ for (const member of selected) {
77
+ for (const problem of member.problems) {
78
+ if (problem.blocking) problems.push(`${member.name}: ${problem.message}`);
79
+ }
80
+ for (const dependency of member.internalDependencies) {
81
+ if (dependency.kind === "dev") continue;
82
+ if (!selected.some((entry) => entry.name === dependency.name)) {
83
+ problems.push(
84
+ `${member.name} depends on ${dependency.name}, which this release does not publish to ${cargoArg.registries.join(", ")}.`,
85
+ );
86
+ }
87
+ }
88
+ }
89
+ return problems;
90
+ };
91
+
92
+ export const assertCargoReleasePlan = (
93
+ planArg: IRsrepoPlanResult,
94
+ cargoArg: IResolvedReleaseCargoConfiguration,
95
+ ): void => {
96
+ const problems = findCargoReleaseProblems(planArg, cargoArg);
97
+ if (problems.length > 0) {
98
+ throw new Error(
99
+ `The cargo release cannot publish this workspace:\n- ${problems.join("\n- ")}`,
100
+ );
101
+ }
102
+ };
103
+
104
+ /** Why `gitzone release --plan` exits non-zero: the release would refuse this plan. */
105
+ export const describeCargoReleaseRefusal = (problemCountArg: number): string =>
106
+ `The release would be refused: ${problemCountArg} blocking cargo problem${problemCountArg === 1 ? "" : "s"}, listed above.`;
107
+
108
+ /** The plan lines `gitzone release --plan` and `release check` print. */
109
+ export const describeCargoReleasePlan = (
110
+ planArg: IRsrepoPlanResult,
111
+ cargoArg: IResolvedReleaseCargoConfiguration,
112
+ ): string[] => {
113
+ const lines = [
114
+ `cargo registries: ${cargoArg.registries.join(", ")}`,
115
+ `cargo workspace: ${planArg.workspaceRoot} (${planArg.versionMode} version${planArg.version ? ` ${planArg.version}` : "s"}, Cargo.lock ${planArg.lockfile ? "tracked" : "missing"})`,
116
+ `cargo publication order: ${planArg.order.length > 0 ? planArg.order.join(" -> ") : "none"}`,
117
+ `cargo index wait: ${cargoArg.verificationWindowMinutes} min per accepted crate`,
118
+ ];
119
+ for (const member of planArg.members) {
120
+ if (!member.selected) {
121
+ lines.push(
122
+ `cargo member ${member.name}: not published (${member.publish && member.publish.length === 0 ? "publish = false" : cargoArg.members && !cargoArg.members.includes(member.name) ? "not in release.targets.cargo.members" : `publish = [${(member.publish ?? []).join(", ")}]`})`,
123
+ );
124
+ }
125
+ for (const problem of member.problems) {
126
+ lines.push(
127
+ `cargo member ${member.name}: ${problem.blocking ? "blocking problem" : "problem"} ${problem.code}: ${problem.message}`,
128
+ );
129
+ }
130
+ }
131
+ for (const problem of findCargoReleaseProblems(planArg, cargoArg)) {
132
+ if (!planArg.members.some((member) => problem.startsWith(`${member.name}: `)))
133
+ lines.push(`cargo release problem: ${problem}`);
134
+ }
135
+ return lines;
136
+ };
137
+
138
+ /**
139
+ * A fresh release never publishes over an existing crate version: every
140
+ * selected crate's new version must be absent from every registry before
141
+ * anything is created.
142
+ */
143
+ export const assertCargoVersionsUnpublished = async (
144
+ engineArg: IRsrepoEngineClient,
145
+ planArg: IRsrepoPlanResult,
146
+ cargoArg: IResolvedReleaseCargoConfiguration,
147
+ versionArg: string,
148
+ ): Promise<void> => {
149
+ for (const name of planArg.order) {
150
+ for (const registry of cargoArg.registries) {
151
+ const probe = await engineArg.probe({
152
+ registry,
153
+ name,
154
+ version: versionArg,
155
+ cwd: planArg.workspaceRoot,
156
+ });
157
+ if (probe.present) {
158
+ throw new Error(
159
+ `${name}@${versionArg} is already in cargo registry ${registry}; a published crate version is immutable. Release a new version.`,
160
+ );
161
+ }
162
+ }
163
+ }
164
+ };
165
+
166
+ /** Prints what each packed crate carries. */
167
+ export const describePackedCrates = (
168
+ cratesArg: readonly IRsrepoPackedCrate[],
169
+ ): string[] =>
170
+ cratesArg.flatMap((crate) => [
171
+ `crate ${crate.name}@${crate.version}: ${crate.files.length} files, sha256 ${crate.sha256}`,
172
+ ...crate.files.map((file) => ` ${file}`),
173
+ ]);
174
+
175
+ const sha256File = async (
176
+ pathArg: string,
177
+ ): Promise<{ sha256: string; size: number }> => {
178
+ const bytes = await plugins.fs.readFile(pathArg);
179
+ return {
180
+ sha256: plugins.crypto.createHash("sha256").update(bytes).digest("hex"),
181
+ size: bytes.byteLength,
182
+ };
183
+ };
184
+
185
+ /**
186
+ * Packs the selected crates of the release checkout through the engine and
187
+ * stores each as `crate.<sha256(name)>.crate` in `artifactDirectoryArg`. The
188
+ * plan is read from the checkout, so it is the release commit's plan.
189
+ */
190
+ export const packReleaseCrates = async (optionsArg: {
191
+ engine: IRsrepoEngineClient;
192
+ checkoutCwd: string;
193
+ artifactDirectory: string;
194
+ cargo: IResolvedReleaseCargoConfiguration;
195
+ version: string;
196
+ }): Promise<{ journal: IReleaseCargoJournal; packed: IRsrepoPackedCrate[] }> => {
197
+ const plan = await readCargoReleasePlan(
198
+ optionsArg.engine,
199
+ optionsArg.checkoutCwd,
200
+ optionsArg.cargo,
201
+ );
202
+ assertCargoReleasePlan(plan, optionsArg.cargo);
203
+ if (plan.version !== optionsArg.version) {
204
+ throw new Error(
205
+ `The release checkout's Cargo workspace is at ${String(plan.version)}, not the release version ${optionsArg.version}.`,
206
+ );
207
+ }
208
+ const outDir = await plugins.fs.mkdtemp(
209
+ plugins.path.join(optionsArg.artifactDirectory, ".crates-"),
210
+ );
211
+ try {
212
+ const packed = await optionsArg.engine.package({
213
+ cwd: optionsArg.checkoutCwd,
214
+ outDir,
215
+ members: plan.order,
216
+ });
217
+ const crates: IReleaseCrateArtifact[] = [];
218
+ for (const crate of packed.crates) {
219
+ if (crate.version !== optionsArg.version)
220
+ throw new Error(
221
+ `rsrepo packed ${crate.name}@${crate.version}, not the release version ${optionsArg.version}.`,
222
+ );
223
+ const file = releaseCrateArtifactFile(crate.name);
224
+ const target = plugins.path.join(optionsArg.artifactDirectory, file);
225
+ await plugins.fs.rename(crate.file, target);
226
+ const identity = await sha256File(target);
227
+ if (identity.sha256 !== crate.sha256) {
228
+ throw new Error(
229
+ `rsrepo reported sha256 ${crate.sha256} for ${crate.name}, but the packed file hashes to ${identity.sha256}.`,
230
+ );
231
+ }
232
+ const member = plan.members.find((entry) => entry.name === crate.name)!;
233
+ crates.push({
234
+ kind: "cargo-crate",
235
+ file,
236
+ crateName: crate.name,
237
+ version: crate.version,
238
+ size: identity.size,
239
+ sha256: identity.sha256,
240
+ dependencies: member.internalDependencies
241
+ .filter((dependency) => dependency.kind !== "dev")
242
+ .map((dependency) => dependency.name)
243
+ .filter((name, index, names) => names.indexOf(name) === index),
244
+ });
245
+ }
246
+ return {
247
+ packed: packed.crates,
248
+ journal: {
249
+ engine: "rsrepo",
250
+ protocolVersion: 1,
251
+ crates,
252
+ registries: crates.flatMap((crate) =>
253
+ optionsArg.cargo.registries.map((registry) => ({
254
+ state: "pending" as const,
255
+ attempts: 0,
256
+ attempt: null,
257
+ error: null,
258
+ registry,
259
+ crate: crate.crateName,
260
+ })),
261
+ ),
262
+ },
263
+ };
264
+ } finally {
265
+ await plugins.fs.rm(outDir, { recursive: true, force: true });
266
+ }
267
+ };
268
+
269
+ /**
270
+ * `cargo publish` runs in a disposable checkout of the release commit, which
271
+ * fetches the locked Cargo dependencies and installs no npm packages.
272
+ */
273
+ export const createCargoPublishCheckout =
274
+ (
275
+ smartshellArg: plugins.smartshell.Smartshell,
276
+ repositoryCwdArg: string,
277
+ mainOidArg: string,
278
+ ) =>
279
+ <T>(useArg: (checkoutCwdArg: string) => Promise<T>): Promise<T> =>
280
+ withIsolatedReleaseCheckout(
281
+ {
282
+ smartshell: smartshellArg,
283
+ repositoryCwd: repositoryCwdArg,
284
+ mainOid: mainOidArg,
285
+ cargo: true,
286
+ npmInstall: false,
287
+ },
288
+ (checkoutArg) => useArg(checkoutArg.path),
289
+ );
@@ -1,5 +1,13 @@
1
1
  import * as plugins from "./mod.plugins.js";
2
- import { assertNpmPackageName } from "./helpers.npmartifact.js";
2
+ import {
3
+ assertNpmPackageName,
4
+ packNpmArtifact,
5
+ type IPnpmReleaseCapability,
6
+ } from "./helpers.npmartifact.js";
7
+ import {
8
+ releasePackageArtifactFile,
9
+ type IReleasePackage,
10
+ } from "./classes.releasejournal.js";
3
11
 
4
12
  /** A module a tspublish descriptor names, which the npm target publishes. */
5
13
  export interface IReleaseNpmModule {
@@ -140,3 +148,70 @@ export const planReleaseNpmPackages = async (
140
148
  plan,
141
149
  };
142
150
  };
151
+
152
+ export interface IReleaseNpmModulePackOptions {
153
+ smartshell: plugins.smartshell.Smartshell;
154
+ /**
155
+ * Absent canonical path outside every repository, where tspublish
156
+ * materializes the module packages; removed again after packing.
157
+ */
158
+ preparationDirectory: string;
159
+ /** The version every module must carry. */
160
+ version: string;
161
+ pnpmCapability?: IPnpmReleaseCapability;
162
+ }
163
+
164
+ /**
165
+ * tspublish materializes the already built modules outside every repository,
166
+ * so each package is packed from its own generated manifest and nothing else.
167
+ */
168
+ export const packReleaseNpmModules = async (
169
+ optionsArg: IReleaseNpmModulePackOptions,
170
+ sourceCwdArg: string,
171
+ planArg: plugins.tspublish.ITsPublishPlan,
172
+ artifactDirectoryArg: string,
173
+ ): Promise<IReleasePackage[]> => {
174
+ const preparationDirectory = optionsArg.preparationDirectory;
175
+ // The directory is removed afterwards, so it must be one this call creates.
176
+ const preparationDirectoryExists = await plugins.fs
177
+ .lstat(preparationDirectory)
178
+ .then(() => true)
179
+ .catch((error: NodeJS.ErrnoException) => {
180
+ if (error.code === "ENOENT") return false;
181
+ throw error;
182
+ });
183
+ if (preparationDirectoryExists) {
184
+ throw new Error(
185
+ "Packing the npm modules requires an absent preparation directory, because it removes that directory after packing.",
186
+ );
187
+ }
188
+ try {
189
+ const prepared = await new plugins.tspublish.TsPublish().prepare(
190
+ sourceCwdArg,
191
+ preparationDirectory,
192
+ );
193
+ if (
194
+ JSON.stringify(prepared.map(({ directory, ...module }) => module)) !==
195
+ JSON.stringify(planArg.modules)
196
+ ) {
197
+ throw new Error("tspublish package plan changed during preparation.");
198
+ }
199
+ const packages: IReleasePackage[] = [];
200
+ for (const module of prepared) {
201
+ const packed = await packNpmArtifact(
202
+ optionsArg.smartshell,
203
+ module.directory,
204
+ artifactDirectoryArg,
205
+ optionsArg.version,
206
+ optionsArg.pnpmCapability,
207
+ releasePackageArtifactFile(module.name),
208
+ );
209
+ if (packed.packageName !== module.name)
210
+ throw new Error("Prepared package identity changed during packing.");
211
+ packages.push({ folder: module.folder, artifact: packed });
212
+ }
213
+ return packages;
214
+ } finally {
215
+ await plugins.fs.rm(preparationDirectory, { recursive: true, force: true });
216
+ }
217
+ };