@git.zone/cli 9.2.2 → 11.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 (121) hide show
  1. package/.smartconfig.json +5 -3
  2. package/assets/templates/asset_binary_installer/install.sh +109 -34
  3. package/assets/templates/asset_binary_release_gitea/.gitea/workflows/release.yml +17 -4
  4. package/assets/templates/ci_rust/.gitea/workflows/rust_nottags.yaml +29 -0
  5. package/assets/templates/ci_rust/.gitea/workflows/rust_tags.yaml +32 -0
  6. package/assets/templates/cli/cli.ts.js +1 -1
  7. package/assets/templates/gitignore/_gitignore +1 -1
  8. package/assets/templates/gitignore_rust/_gitignore +31 -0
  9. package/assets/templates/license_mit/license +4 -1
  10. package/assets/templates/npm/.package.json +4 -6
  11. package/assets/templates/npm/test/test.ts +1 -1
  12. package/assets/templates/rust/.smartscaf.yml +16 -0
  13. package/assets/templates/rust/_Cargo.toml +12 -0
  14. package/assets/templates/rust/_crate_Cargo.toml +10 -0
  15. package/assets/templates/rust/_crate_lib.rs +19 -0
  16. package/assets/templates/rust/_smartconfig.json +27 -0
  17. package/assets/templates/rust/readme.md +23 -0
  18. package/assets/templates/service/.package.json +3 -6
  19. package/assets/templates/wcc/.package.json +3 -6
  20. package/assets/templates/wcc_update/html/index.html +2 -2
  21. package/assets/templates/website/.package.json +3 -6
  22. package/assets/templates/website/npmextra.json +3 -1
  23. package/assets/templates/website_update/html/index.html +4 -4
  24. package/dist_ts/00_commitinfo_data.js +2 -2
  25. package/dist_ts/classes.gitzoneconfig.d.ts +3 -1
  26. package/dist_ts/classes.gitzoneconfig.js +9 -1
  27. package/dist_ts/helpers.managedassets.d.ts +1 -1
  28. package/dist_ts/helpers.managedassets.js +58 -14
  29. package/dist_ts/helpers.packagefiles.js +2 -2
  30. package/dist_ts/helpers.releasetargets.d.ts +6 -0
  31. package/dist_ts/helpers.releasetargets.js +13 -0
  32. package/dist_ts/helpers.smartconfigmigrations.js +42 -1
  33. package/dist_ts/helpers.toolconfig.d.ts +50 -0
  34. package/dist_ts/helpers.toolconfig.js +212 -0
  35. package/dist_ts/helpers.tssea.d.ts +11 -4
  36. package/dist_ts/helpers.tssea.js +47 -17
  37. package/dist_ts/helpers.tstest.d.ts +27 -8
  38. package/dist_ts/helpers.tstest.js +64 -26
  39. package/dist_ts/helpers.versionsource.d.ts +37 -0
  40. package/dist_ts/helpers.versionsource.js +112 -0
  41. package/dist_ts/helpers.workflow.d.ts +45 -1
  42. package/dist_ts/helpers.workflow.js +120 -5
  43. package/dist_ts/mod_commit/mod.helpers.d.ts +0 -24
  44. package/dist_ts/mod_commit/mod.helpers.js +1 -94
  45. package/dist_ts/mod_commit/mod.plugins.d.ts +1 -1
  46. package/dist_ts/mod_commit/mod.plugins.js +2 -2
  47. package/dist_ts/mod_config/index.js +131 -18
  48. package/dist_ts/mod_format/formatters/assets.formatter.js +30 -28
  49. package/dist_ts/mod_format/formatters/gitignore.formatter.d.ts +4 -2
  50. package/dist_ts/mod_format/formatters/gitignore.formatter.js +10 -7
  51. package/dist_ts/mod_format/formatters/license.formatter.d.ts +8 -0
  52. package/dist_ts/mod_format/formatters/license.formatter.js +25 -2
  53. package/dist_ts/mod_format/formatters/packagejson.formatter.js +14 -3
  54. package/dist_ts/mod_format/formatters/rustfmt.formatter.d.ts +19 -0
  55. package/dist_ts/mod_format/formatters/rustfmt.formatter.js +97 -0
  56. package/dist_ts/mod_format/formatters/smartconfig.formatter.js +5 -2
  57. package/dist_ts/mod_format/formatters/templates.formatter.d.ts +3 -2
  58. package/dist_ts/mod_format/formatters/templates.formatter.js +61 -14
  59. package/dist_ts/mod_format/formatters/tsconfig.formatter.js +2 -2
  60. package/dist_ts/mod_format/index.js +3 -1
  61. package/dist_ts/mod_format/interfaces.format.js +2 -1
  62. package/dist_ts/mod_release/classes.releasejournal.d.ts +38 -2
  63. package/dist_ts/mod_release/classes.releasejournal.js +238 -66
  64. package/dist_ts/mod_release/helpers.cargorelease.d.ts +52 -0
  65. package/dist_ts/mod_release/helpers.cargorelease.js +195 -0
  66. package/dist_ts/mod_release/helpers.npmpackages.d.ts +18 -0
  67. package/dist_ts/mod_release/helpers.npmpackages.js +40 -2
  68. package/dist_ts/mod_release/helpers.releasecheck.d.ts +73 -0
  69. package/dist_ts/mod_release/helpers.releasecheck.js +269 -0
  70. package/dist_ts/mod_release/helpers.releasepreparation.d.ts +22 -8
  71. package/dist_ts/mod_release/helpers.releasepreparation.js +74 -26
  72. package/dist_ts/mod_release/helpers.releasepublication.d.ts +21 -1
  73. package/dist_ts/mod_release/helpers.releasepublication.js +249 -4
  74. package/dist_ts/mod_release/helpers.releaseversionsource.d.ts +10 -0
  75. package/dist_ts/mod_release/helpers.releaseversionsource.js +18 -0
  76. package/dist_ts/mod_release/helpers.rsrepoengine.d.ts +192 -0
  77. package/dist_ts/mod_release/helpers.rsrepoengine.js +457 -0
  78. package/dist_ts/mod_release/index.d.ts +3 -0
  79. package/dist_ts/mod_release/index.js +177 -65
  80. package/dist_ts/mod_template/index.js +6 -2
  81. package/dist_ts/mod_tools/index.js +3 -8
  82. package/dist_ts/plugins.d.ts +1 -1
  83. package/dist_ts/plugins.js +2 -2
  84. package/package.json +6 -11
  85. package/readme.md +244 -26
  86. package/ts/00_commitinfo_data.ts +1 -1
  87. package/ts/classes.gitzoneconfig.ts +10 -1
  88. package/ts/helpers.managedassets.ts +64 -14
  89. package/ts/helpers.packagefiles.ts +1 -1
  90. package/ts/helpers.releasetargets.ts +13 -0
  91. package/ts/helpers.smartconfigmigrations.ts +48 -0
  92. package/ts/helpers.toolconfig.ts +280 -0
  93. package/ts/helpers.tssea.ts +62 -19
  94. package/ts/helpers.tstest.ts +105 -35
  95. package/ts/helpers.versionsource.ts +169 -0
  96. package/ts/helpers.workflow.ts +197 -5
  97. package/ts/mod_commit/mod.helpers.ts +0 -119
  98. package/ts/mod_commit/mod.plugins.ts +1 -1
  99. package/ts/mod_config/index.ts +169 -19
  100. package/ts/mod_format/formatters/assets.formatter.ts +29 -28
  101. package/ts/mod_format/formatters/gitignore.formatter.ts +10 -6
  102. package/ts/mod_format/formatters/license.formatter.ts +26 -1
  103. package/ts/mod_format/formatters/packagejson.formatter.ts +14 -2
  104. package/ts/mod_format/formatters/rustfmt.formatter.ts +107 -0
  105. package/ts/mod_format/formatters/smartconfig.formatter.ts +8 -1
  106. package/ts/mod_format/formatters/templates.formatter.ts +80 -14
  107. package/ts/mod_format/formatters/tsconfig.formatter.ts +1 -1
  108. package/ts/mod_format/index.ts +2 -0
  109. package/ts/mod_format/interfaces.format.ts +1 -0
  110. package/ts/mod_release/classes.releasejournal.ts +312 -39
  111. package/ts/mod_release/helpers.cargorelease.ts +289 -0
  112. package/ts/mod_release/helpers.npmpackages.ts +76 -1
  113. package/ts/mod_release/helpers.releasecheck.ts +409 -0
  114. package/ts/mod_release/helpers.releasepreparation.ts +116 -36
  115. package/ts/mod_release/helpers.releasepublication.ts +462 -1
  116. package/ts/mod_release/helpers.releaseversionsource.ts +29 -0
  117. package/ts/mod_release/helpers.rsrepoengine.ts +790 -0
  118. package/ts/mod_release/index.ts +277 -84
  119. package/ts/mod_template/index.ts +5 -1
  120. package/ts/mod_tools/index.ts +2 -7
  121. package/ts/plugins.ts +1 -1
@@ -0,0 +1,10 @@
1
+ import * as plugins from "./mod.plugins.js";
2
+ import type { IResolvedReleaseWorkflow } from "../helpers.workflow.js";
3
+ import { type IVersionSource } from "../helpers.versionsource.js";
4
+ /**
5
+ * The version source of the release in `cwdArg`: package.json, or the Cargo
6
+ * workspace of projectType "rust" through the project's rsrepo engine.
7
+ * `gitzone release`, its plan and `gitzone release check` all open it here, so
8
+ * they refuse the same projects with the same message.
9
+ */
10
+ export declare const openReleaseVersionSource: (smartshellArg: plugins.smartshell.Smartshell, workflowArg: Pick<IResolvedReleaseWorkflow, "cargoVersioned">, cwdArg: string) => Promise<IVersionSource>;
@@ -0,0 +1,18 @@
1
+ import * as plugins from "./mod.plugins.js";
2
+ import { detectVersionSourceKind, openVersionSource, } from "../helpers.versionsource.js";
3
+ import { RsrepoEngineClient } from "./helpers.rsrepoengine.js";
4
+ /**
5
+ * The version source of the release in `cwdArg`: package.json, or the Cargo
6
+ * workspace of projectType "rust" through the project's rsrepo engine.
7
+ * `gitzone release`, its plan and `gitzone release check` all open it here, so
8
+ * they refuse the same projects with the same message.
9
+ */
10
+ export const openReleaseVersionSource = async (smartshellArg, workflowArg, cwdArg) => {
11
+ const kind = await detectVersionSourceKind(cwdArg, workflowArg.cargoVersioned ? "rust" : undefined);
12
+ if (kind !== "cargo")
13
+ return openVersionSource(kind, cwdArg);
14
+ const engine = await RsrepoEngineClient.forProject(smartshellArg, cwdArg);
15
+ await engine.assertCapabilities(["plan", "set-version"]);
16
+ return openVersionSource(kind, cwdArg, engine);
17
+ };
18
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaGVscGVycy5yZWxlYXNldmVyc2lvbnNvdXJjZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3RzL21vZF9yZWxlYXNlL2hlbHBlcnMucmVsZWFzZXZlcnNpb25zb3VyY2UudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxLQUFLLE9BQU8sTUFBTSxrQkFBa0IsQ0FBQztBQUU1QyxPQUFPLEVBQ0wsdUJBQXVCLEVBQ3ZCLGlCQUFpQixHQUVsQixNQUFNLDZCQUE2QixDQUFDO0FBQ3JDLE9BQU8sRUFBRSxrQkFBa0IsRUFBRSxNQUFNLDJCQUEyQixDQUFDO0FBRS9EOzs7OztHQUtHO0FBQ0gsTUFBTSxDQUFDLE1BQU0sd0JBQXdCLEdBQUcsS0FBSyxFQUMzQyxhQUE0QyxFQUM1QyxXQUE2RCxFQUM3RCxNQUFjLEVBQ1csRUFBRTtJQUMzQixNQUFNLElBQUksR0FBRyxNQUFNLHVCQUF1QixDQUN4QyxNQUFNLEVBQ04sV0FBVyxDQUFDLGNBQWMsQ0FBQyxDQUFDLENBQUMsTUFBTSxDQUFDLENBQUMsQ0FBQyxTQUFTLENBQ2hELENBQUM7SUFDRixJQUFJLElBQUksS0FBSyxPQUFPO1FBQUUsT0FBTyxpQkFBaUIsQ0FBQyxJQUFJLEVBQUUsTUFBTSxDQUFDLENBQUM7SUFDN0QsTUFBTSxNQUFNLEdBQUcsTUFBTSxrQkFBa0IsQ0FBQyxVQUFVLENBQUMsYUFBYSxFQUFFLE1BQU0sQ0FBQyxDQUFDO0lBQzFFLE1BQU0sTUFBTSxDQUFDLGtCQUFrQixDQUFDLENBQUMsTUFBTSxFQUFFLGFBQWEsQ0FBQyxDQUFDLENBQUM7SUFDekQsT0FBTyxpQkFBaUIsQ0FBQyxJQUFJLEVBQUUsTUFBTSxFQUFFLE1BQU0sQ0FBQyxDQUFDO0FBQ2pELENBQUMsQ0FBQyJ9
@@ -0,0 +1,192 @@
1
+ import * as plugins from "./mod.plugins.js";
2
+ /**
3
+ * The rsrepo release engine protocol, version 1. gitzone delegates every Cargo
4
+ * operation of a release (workspace plan, version edit, packaging, publication
5
+ * and registry probes) to `rsrepo engine <command> --request <file>`, the way
6
+ * Docker releases delegate to project-local tSDocker. The types are duplicated
7
+ * here on purpose: the CLI never depends on `@git.zone/rsrepo`, so it resolves
8
+ * the engine at run time and checks the protocol version instead.
9
+ */
10
+ export declare const rsrepoEngineProtocol: "gitzone-rsrepo-engine";
11
+ export declare const rsrepoEngineProtocolVersion: 1;
12
+ export type TRsrepoEngineCommand = "capabilities" | "plan" | "set-version" | "package" | "publish" | "probe";
13
+ export declare const rsrepoEngineCommands: readonly TRsrepoEngineCommand[];
14
+ export type TRsrepoEngineErrorCode = "bad-request" | "unsupported-command" | "no-workspace" | "cargo-failed" | "layout-unsupported" | "independent-versions" | "already-published" | "publish-rejected" | "registry-unreachable" | "not-found";
15
+ export interface IRsrepoEngineError {
16
+ code: TRsrepoEngineErrorCode;
17
+ message: string;
18
+ details?: unknown;
19
+ }
20
+ export interface IRsrepoEngineEnvelope<T> {
21
+ protocol: typeof rsrepoEngineProtocol;
22
+ protocolVersion: typeof rsrepoEngineProtocolVersion;
23
+ ok: boolean;
24
+ result?: T;
25
+ error?: IRsrepoEngineError;
26
+ }
27
+ export interface IRsrepoCapabilitiesResult {
28
+ rsrepoVersion: string;
29
+ cargoVersion: string;
30
+ commands: string[];
31
+ }
32
+ export interface IRsrepoPlanRequest {
33
+ cwd: string;
34
+ registries: string[];
35
+ members?: string[];
36
+ }
37
+ export type TRsrepoWorkspaceLayout = "root" | "rust" | "ts_rust";
38
+ export type TRsrepoVersionMode = "workspace" | "single" | "independent";
39
+ export type TRsrepoDependencyKind = "normal" | "build" | "dev";
40
+ export interface IRsrepoPlanDependency {
41
+ name: string;
42
+ requirement: string | null;
43
+ kind: TRsrepoDependencyKind;
44
+ }
45
+ export interface IRsrepoPlanProblem {
46
+ code: string;
47
+ message: string;
48
+ blocking: boolean;
49
+ }
50
+ /**
51
+ * Problem codes whose class the protocol fixes (Appendix P, R2 gate): a
52
+ * dependency that cannot be published blocks its dependent; a dependency the
53
+ * release does not select and a member with `publish = false` are notes. Any
54
+ * other code is classified by the engine's own `blocking` flag.
55
+ */
56
+ export declare const rsrepoPlanProblemBlocking: Readonly<Record<string, boolean>>;
57
+ export interface IRsrepoPlanMember {
58
+ name: string;
59
+ version: string;
60
+ manifestPath: string;
61
+ /** Cargo `publish`: null admits any registry, an empty list none. */
62
+ publish: string[] | null;
63
+ license: string | null;
64
+ licenseFile: string | null;
65
+ description: string | null;
66
+ internalDependencies: IRsrepoPlanDependency[];
67
+ /** Publishable to every requested registry and named in `members`, if given. */
68
+ selected: boolean;
69
+ problems: IRsrepoPlanProblem[];
70
+ }
71
+ export interface IRsrepoPlanResult {
72
+ workspaceRoot: string;
73
+ layout: TRsrepoWorkspaceLayout;
74
+ versionMode: TRsrepoVersionMode;
75
+ /** The shared version of a workspace or single package; null when independent. */
76
+ version: string | null;
77
+ /** A tracked Cargo.lock exists. */
78
+ lockfile: boolean;
79
+ members: IRsrepoPlanMember[];
80
+ /** Selected members, dependencies first. */
81
+ order: string[];
82
+ }
83
+ export interface IRsrepoSetVersionRequest {
84
+ cwd: string;
85
+ version: string;
86
+ }
87
+ export interface IRsrepoSetVersionResult {
88
+ previousVersion: string;
89
+ version: string;
90
+ /** Paths relative to the workspace root. */
91
+ changedFiles: string[];
92
+ }
93
+ export interface IRsrepoPackageRequest {
94
+ cwd: string;
95
+ outDir: string;
96
+ members: string[];
97
+ }
98
+ export interface IRsrepoPackedCrate {
99
+ name: string;
100
+ version: string;
101
+ file: string;
102
+ sha256: string;
103
+ files: string[];
104
+ }
105
+ export interface IRsrepoPackageResult {
106
+ crates: IRsrepoPackedCrate[];
107
+ }
108
+ export interface IRsrepoPublishRequest {
109
+ cwd: string;
110
+ registry: string;
111
+ member: string;
112
+ }
113
+ export interface IRsrepoPublishResult {
114
+ name: string;
115
+ version: string;
116
+ registry: string;
117
+ state: "accepted";
118
+ }
119
+ export interface IRsrepoProbeRequest {
120
+ registry: string;
121
+ name: string;
122
+ version: string;
123
+ /** Where the engine starts its cargo config lookup for registry names. */
124
+ cwd?: string;
125
+ }
126
+ export interface IRsrepoProbeResult {
127
+ present: boolean;
128
+ cksum: string | null;
129
+ yanked: boolean | null;
130
+ }
131
+ /** Every Cargo operation of a release, behind one replaceable seam. */
132
+ export interface IRsrepoEngineClient {
133
+ /** The engine binary this client runs. */
134
+ readonly binaryPath: string;
135
+ capabilities: () => Promise<IRsrepoCapabilitiesResult>;
136
+ /** Capabilities, refused unless every named command is supported. */
137
+ assertCapabilities: (commandsArg: readonly TRsrepoEngineCommand[]) => Promise<IRsrepoCapabilitiesResult>;
138
+ plan: (requestArg: IRsrepoPlanRequest) => Promise<IRsrepoPlanResult>;
139
+ setVersion: (requestArg: IRsrepoSetVersionRequest) => Promise<IRsrepoSetVersionResult>;
140
+ package: (requestArg: IRsrepoPackageRequest) => Promise<IRsrepoPackageResult>;
141
+ publish: (requestArg: IRsrepoPublishRequest) => Promise<IRsrepoPublishResult>;
142
+ probe: (requestArg: IRsrepoProbeRequest) => Promise<IRsrepoProbeResult>;
143
+ }
144
+ /**
145
+ * A command that ran and answered with a protocol error, or whose outcome is
146
+ * not a valid protocol answer (`protocol-failure`). A publish that ends in a
147
+ * protocol failure has an unknown outcome; only a probe can settle it.
148
+ */
149
+ export declare class RsrepoEngineCommandError extends Error {
150
+ readonly command: TRsrepoEngineCommand;
151
+ readonly code: TRsrepoEngineErrorCode | "protocol-failure";
152
+ constructor(command: TRsrepoEngineCommand, code: TRsrepoEngineErrorCode | "protocol-failure", messageArg: string);
153
+ }
154
+ /** A crate name as crates.io accepts it. */
155
+ export declare const isCargoCrateName: (valueArg: unknown) => valueArg is string;
156
+ /** `crates-io` or a registry name defined in cargo config. */
157
+ export declare const isCargoRegistryName: (valueArg: unknown) => valueArg is string;
158
+ export declare const assertRsrepoCapabilitiesResult: (valueArg: unknown) => IRsrepoCapabilitiesResult;
159
+ export declare const assertRsrepoPlanResult: (valueArg: unknown) => IRsrepoPlanResult;
160
+ export declare const assertRsrepoSetVersionResult: (valueArg: unknown, versionArg: string) => IRsrepoSetVersionResult;
161
+ export declare const assertRsrepoPackageResult: (valueArg: unknown, requestArg: IRsrepoPackageRequest) => IRsrepoPackageResult;
162
+ export declare const assertRsrepoPublishResult: (valueArg: unknown, requestArg: IRsrepoPublishRequest) => IRsrepoPublishResult;
163
+ export declare const assertRsrepoProbeResult: (valueArg: unknown) => IRsrepoProbeResult;
164
+ /** The parsed answer of one engine invocation: its result, or its protocol error. */
165
+ export declare const parseRsrepoEngineOutput: (commandArg: TRsrepoEngineCommand, resultArg: plugins.smartshell.IExecResult) => unknown;
166
+ /**
167
+ * The engine a project uses: its own `node_modules/.bin/rsrepo` when its
168
+ * package.json declares `@git.zone/rsrepo`, otherwise `rsrepo` on PATH (a
169
+ * global install, like gitzone itself). A declared but missing install is an
170
+ * error, never a reason to run another rsrepo.
171
+ */
172
+ export declare const resolveRsrepoEngineBinary: (projectRootArg: string, platformArg?: NodeJS.Platform) => Promise<string>;
173
+ export declare class RsrepoEngineClient implements IRsrepoEngineClient {
174
+ private readonly smartshell;
175
+ readonly binaryPath: string;
176
+ private readonly cwd;
177
+ constructor(smartshell: plugins.smartshell.Smartshell, binaryPath: string, cwd: string);
178
+ /** The client of the project's resolved engine. */
179
+ static forProject(smartshellArg: plugins.smartshell.Smartshell, projectRootArg: string): Promise<RsrepoEngineClient>;
180
+ capabilities(): Promise<IRsrepoCapabilitiesResult>;
181
+ assertCapabilities(commandsArg: readonly TRsrepoEngineCommand[]): Promise<IRsrepoCapabilitiesResult>;
182
+ plan(requestArg: IRsrepoPlanRequest): Promise<IRsrepoPlanResult>;
183
+ setVersion(requestArg: IRsrepoSetVersionRequest): Promise<IRsrepoSetVersionResult>;
184
+ package(requestArg: IRsrepoPackageRequest): Promise<IRsrepoPackageResult>;
185
+ publish(requestArg: IRsrepoPublishRequest): Promise<IRsrepoPublishResult>;
186
+ probe(requestArg: IRsrepoProbeRequest): Promise<IRsrepoProbeResult>;
187
+ /**
188
+ * Writes the request into a private directory of its own, runs the engine
189
+ * and removes the directory again, whatever the outcome.
190
+ */
191
+ private run;
192
+ }