@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.
- package/assets/templates/asset_binary_installer/install.sh +109 -34
- package/assets/templates/asset_binary_release_gitea/.gitea/workflows/release.yml +17 -4
- package/assets/templates/ci_rust/.gitea/workflows/rust_nottags.yaml +29 -0
- package/assets/templates/ci_rust/.gitea/workflows/rust_tags.yaml +32 -0
- package/assets/templates/gitignore/_gitignore +1 -1
- package/assets/templates/gitignore_rust/_gitignore +31 -0
- package/assets/templates/license_mit/license +4 -1
- package/assets/templates/rust/.smartscaf.yml +16 -0
- package/assets/templates/rust/_Cargo.toml +12 -0
- package/assets/templates/rust/_crate_Cargo.toml +10 -0
- package/assets/templates/rust/_crate_lib.rs +19 -0
- package/assets/templates/rust/_smartconfig.json +27 -0
- package/assets/templates/rust/readme.md +23 -0
- package/dist_ts/00_commitinfo_data.js +2 -2
- package/dist_ts/classes.gitzoneconfig.d.ts +3 -1
- package/dist_ts/classes.gitzoneconfig.js +9 -1
- package/dist_ts/helpers.managedassets.d.ts +1 -1
- package/dist_ts/helpers.managedassets.js +58 -14
- package/dist_ts/helpers.releasetargets.d.ts +6 -0
- package/dist_ts/helpers.releasetargets.js +13 -0
- package/dist_ts/helpers.smartconfigmigrations.js +42 -1
- package/dist_ts/helpers.toolconfig.d.ts +50 -0
- package/dist_ts/helpers.toolconfig.js +212 -0
- package/dist_ts/helpers.tssea.d.ts +9 -2
- package/dist_ts/helpers.tssea.js +47 -17
- package/dist_ts/helpers.tstest.d.ts +27 -8
- package/dist_ts/helpers.tstest.js +64 -26
- package/dist_ts/helpers.versionsource.d.ts +37 -0
- package/dist_ts/helpers.versionsource.js +112 -0
- package/dist_ts/helpers.workflow.d.ts +45 -1
- package/dist_ts/helpers.workflow.js +120 -5
- package/dist_ts/mod_commit/mod.helpers.d.ts +0 -24
- package/dist_ts/mod_commit/mod.helpers.js +1 -94
- package/dist_ts/mod_config/index.js +131 -18
- package/dist_ts/mod_format/formatters/assets.formatter.js +29 -27
- package/dist_ts/mod_format/formatters/gitignore.formatter.d.ts +4 -2
- package/dist_ts/mod_format/formatters/gitignore.formatter.js +10 -7
- package/dist_ts/mod_format/formatters/license.formatter.d.ts +8 -0
- package/dist_ts/mod_format/formatters/license.formatter.js +25 -2
- package/dist_ts/mod_format/formatters/packagejson.formatter.js +14 -3
- package/dist_ts/mod_format/formatters/rustfmt.formatter.d.ts +19 -0
- package/dist_ts/mod_format/formatters/rustfmt.formatter.js +97 -0
- package/dist_ts/mod_format/formatters/smartconfig.formatter.js +5 -2
- package/dist_ts/mod_format/index.js +3 -1
- package/dist_ts/mod_format/interfaces.format.js +2 -1
- package/dist_ts/mod_release/classes.releasejournal.d.ts +38 -2
- package/dist_ts/mod_release/classes.releasejournal.js +238 -66
- package/dist_ts/mod_release/helpers.cargorelease.d.ts +52 -0
- package/dist_ts/mod_release/helpers.cargorelease.js +195 -0
- package/dist_ts/mod_release/helpers.npmpackages.d.ts +18 -0
- package/dist_ts/mod_release/helpers.npmpackages.js +40 -2
- package/dist_ts/mod_release/helpers.releasecheck.d.ts +73 -0
- package/dist_ts/mod_release/helpers.releasecheck.js +269 -0
- package/dist_ts/mod_release/helpers.releasepreparation.d.ts +22 -8
- package/dist_ts/mod_release/helpers.releasepreparation.js +74 -26
- package/dist_ts/mod_release/helpers.releasepublication.d.ts +21 -1
- package/dist_ts/mod_release/helpers.releasepublication.js +249 -4
- package/dist_ts/mod_release/helpers.releaseversionsource.d.ts +10 -0
- package/dist_ts/mod_release/helpers.releaseversionsource.js +18 -0
- package/dist_ts/mod_release/helpers.rsrepoengine.d.ts +192 -0
- package/dist_ts/mod_release/helpers.rsrepoengine.js +457 -0
- package/dist_ts/mod_release/index.d.ts +3 -0
- package/dist_ts/mod_release/index.js +177 -65
- package/dist_ts/mod_template/index.js +6 -2
- package/package.json +1 -1
- package/readme.md +237 -21
- package/ts/00_commitinfo_data.ts +1 -1
- package/ts/classes.gitzoneconfig.ts +10 -1
- package/ts/helpers.managedassets.ts +64 -14
- package/ts/helpers.releasetargets.ts +13 -0
- package/ts/helpers.smartconfigmigrations.ts +48 -0
- package/ts/helpers.toolconfig.ts +280 -0
- package/ts/helpers.tssea.ts +59 -16
- package/ts/helpers.tstest.ts +105 -35
- package/ts/helpers.versionsource.ts +169 -0
- package/ts/helpers.workflow.ts +197 -5
- package/ts/mod_commit/mod.helpers.ts +0 -119
- package/ts/mod_config/index.ts +169 -19
- package/ts/mod_format/formatters/assets.formatter.ts +28 -27
- package/ts/mod_format/formatters/gitignore.formatter.ts +10 -6
- package/ts/mod_format/formatters/license.formatter.ts +26 -1
- package/ts/mod_format/formatters/packagejson.formatter.ts +14 -2
- package/ts/mod_format/formatters/rustfmt.formatter.ts +107 -0
- package/ts/mod_format/formatters/smartconfig.formatter.ts +8 -1
- package/ts/mod_format/index.ts +2 -0
- package/ts/mod_format/interfaces.format.ts +1 -0
- package/ts/mod_release/classes.releasejournal.ts +312 -39
- package/ts/mod_release/helpers.cargorelease.ts +289 -0
- package/ts/mod_release/helpers.npmpackages.ts +76 -1
- package/ts/mod_release/helpers.releasecheck.ts +409 -0
- package/ts/mod_release/helpers.releasepreparation.ts +116 -36
- package/ts/mod_release/helpers.releasepublication.ts +462 -1
- package/ts/mod_release/helpers.releaseversionsource.ts +29 -0
- package/ts/mod_release/helpers.rsrepoengine.ts +790 -0
- package/ts/mod_release/index.ts +277 -84
- package/ts/mod_template/index.ts +5 -1
|
@@ -5,7 +5,14 @@ export declare const tsseaPackageName = "@git.zone/tssea";
|
|
|
5
5
|
/** The `@git.zone/tssea` versions whose `./config` export this CLI reads: `^1.1.0`. */
|
|
6
6
|
export declare const supportedTsseaRange = "^1.1.0";
|
|
7
7
|
/**
|
|
8
|
-
*
|
|
9
|
-
*
|
|
8
|
+
* `@git.zone/tsrepo` carries tssea as its `sea` module; its `./sea/config` export is
|
|
9
|
+
* tssea's `./config` contract. This CLI reads it from tsrepo `^1.0.0`.
|
|
10
|
+
*/
|
|
11
|
+
export declare const supportedTsrepoRange = "^1.0.0";
|
|
12
|
+
/**
|
|
13
|
+
* Resolves the executables of the project's sea configuration with the package the project
|
|
14
|
+
* itself installs, so the project's version interprets its own config: `@git.zone/tsrepo`
|
|
15
|
+
* (`./sea/config`, config `@git.zone/tsrepo.sea` or the legacy `@git.zone/tssea`) when the
|
|
16
|
+
* project declares it, otherwise `@git.zone/tssea` (`./config`, config `@git.zone/tssea`).
|
|
10
17
|
*/
|
|
11
18
|
export declare const resolveProjectTsseaOutputs: (projectDirArg: string, smartconfigDataArg: Record<string, unknown>) => Promise<ITsseaOutputs>;
|
package/dist_ts/helpers.tssea.js
CHANGED
|
@@ -1,21 +1,42 @@
|
|
|
1
1
|
import * as plugins from './plugins.js';
|
|
2
2
|
import { isPlainObject } from './helpers.objects.js';
|
|
3
|
+
import { readTsrepoToolSection, tsrepoNamespace } from './helpers.toolconfig.js';
|
|
3
4
|
/** The tssea package whose `./config` export resolves a project's executables. */
|
|
4
5
|
export const tsseaPackageName = '@git.zone/tssea';
|
|
5
6
|
/** The `@git.zone/tssea` versions whose `./config` export this CLI reads: `^1.1.0`. */
|
|
6
7
|
export const supportedTsseaRange = '^1.1.0';
|
|
8
|
+
/**
|
|
9
|
+
* `@git.zone/tsrepo` carries tssea as its `sea` module; its `./sea/config` export is
|
|
10
|
+
* tssea's `./config` contract. This CLI reads it from tsrepo `^1.0.0`.
|
|
11
|
+
*/
|
|
12
|
+
export const supportedTsrepoRange = '^1.0.0';
|
|
7
13
|
/** A tssea failure, recognized by shape: `instanceof` fails across package copies. */
|
|
8
14
|
const isTsseaError = (errorArg) => errorArg instanceof Error &&
|
|
9
15
|
errorArg.name === 'TsseaError' &&
|
|
10
16
|
typeof errorArg.code === 'string';
|
|
11
|
-
/** Whether an exact `x.y.z` version
|
|
12
|
-
const
|
|
17
|
+
/** Whether an exact `x.y.z` version has the given major and at least the given minor; prereleases do not. */
|
|
18
|
+
const isStableVersionInMajor = (versionArg, majorArg, minimumMinorArg) => {
|
|
13
19
|
const match = /^(\d+)\.(\d+)\.(\d+)$/.exec(versionArg);
|
|
14
20
|
if (!match) {
|
|
15
21
|
return false;
|
|
16
22
|
}
|
|
17
23
|
const [major, minor] = [Number(match[1]), Number(match[2])];
|
|
18
|
-
return major ===
|
|
24
|
+
return major === majorArg && minor >= minimumMinorArg;
|
|
25
|
+
};
|
|
26
|
+
const tsseaProvider = {
|
|
27
|
+
packageName: tsseaPackageName,
|
|
28
|
+
configExport: `${tsseaPackageName}/config`,
|
|
29
|
+
range: supportedTsseaRange,
|
|
30
|
+
isSupportedVersion: (versionArg) => isStableVersionInMajor(versionArg, 1, 1),
|
|
31
|
+
readConfig: (smartconfigDataArg) => smartconfigDataArg[tsseaPackageName],
|
|
32
|
+
};
|
|
33
|
+
const tsrepoProvider = {
|
|
34
|
+
packageName: tsrepoNamespace,
|
|
35
|
+
configExport: `${tsrepoNamespace}/sea/config`,
|
|
36
|
+
range: supportedTsrepoRange,
|
|
37
|
+
isSupportedVersion: (versionArg) => isStableVersionInMajor(versionArg, 1, 0),
|
|
38
|
+
// tsrepo reads `@git.zone/tsrepo.sea`, falls back to `@git.zone/tssea` and refuses both.
|
|
39
|
+
readConfig: (smartconfigDataArg) => readTsrepoToolSection(smartconfigDataArg, 'sea'),
|
|
19
40
|
};
|
|
20
41
|
const readProjectManifest = async (projectDirArg) => {
|
|
21
42
|
const manifestPath = plugins.path.join(projectDirArg, 'package.json');
|
|
@@ -39,43 +60,52 @@ const declaresDependency = (manifestArg, nameArg) => ['dependencies', 'devDepend
|
|
|
39
60
|
return isPlainObject(field) && typeof field[nameArg] === 'string';
|
|
40
61
|
});
|
|
41
62
|
/**
|
|
42
|
-
* Resolves the executables of the project's
|
|
43
|
-
*
|
|
63
|
+
* Resolves the executables of the project's sea configuration with the package the project
|
|
64
|
+
* itself installs, so the project's version interprets its own config: `@git.zone/tsrepo`
|
|
65
|
+
* (`./sea/config`, config `@git.zone/tsrepo.sea` or the legacy `@git.zone/tssea`) when the
|
|
66
|
+
* project declares it, otherwise `@git.zone/tssea` (`./config`, config `@git.zone/tssea`).
|
|
44
67
|
*/
|
|
45
68
|
export const resolveProjectTsseaOutputs = async (projectDirArg, smartconfigDataArg) => {
|
|
46
69
|
const manifest = await readProjectManifest(projectDirArg);
|
|
47
|
-
|
|
48
|
-
|
|
70
|
+
const provider = declaresDependency(manifest, tsrepoProvider.packageName)
|
|
71
|
+
? tsrepoProvider
|
|
72
|
+
: declaresDependency(manifest, tsseaProvider.packageName)
|
|
73
|
+
? tsseaProvider
|
|
74
|
+
: undefined;
|
|
75
|
+
if (!provider) {
|
|
76
|
+
throw new Error(`binaryCli builds with ${tsseaPackageName} or ${tsrepoNamespace}; \`pnpm install --save-dev ${tsseaPackageName}\`, then rerun.`);
|
|
49
77
|
}
|
|
78
|
+
const { packageName, range } = provider;
|
|
50
79
|
// The project's own direct link, never one an ancestor folder would resolve.
|
|
51
|
-
const installPath = plugins.path.join(projectDirArg, 'node_modules', ...
|
|
80
|
+
const installPath = plugins.path.join(projectDirArg, 'node_modules', ...packageName.split('/'));
|
|
52
81
|
try {
|
|
53
82
|
await plugins.fs.lstat(installPath);
|
|
54
83
|
}
|
|
55
84
|
catch {
|
|
56
|
-
throw new Error(`${
|
|
85
|
+
throw new Error(`${packageName} is declared but not installed in ${projectDirArg}: run \`pnpm install\`, then rerun.`);
|
|
57
86
|
}
|
|
58
87
|
const projectRequire = plugins.nodeModule.createRequire(plugins.path.join(projectDirArg, 'package.json'));
|
|
59
|
-
const installedManifest = projectRequire(`${
|
|
88
|
+
const installedManifest = projectRequire(`${packageName}/package.json`);
|
|
60
89
|
const installedVersion = isPlainObject(installedManifest) && typeof installedManifest.version === 'string'
|
|
61
90
|
? installedManifest.version
|
|
62
91
|
: 'unknown';
|
|
63
|
-
if (!
|
|
92
|
+
if (!provider.isSupportedVersion(installedVersion)) {
|
|
64
93
|
const newerMajor = /^(\d+)\./.exec(installedVersion);
|
|
65
94
|
throw new Error(newerMajor && Number(newerMajor[1]) > 1
|
|
66
|
-
? `The project installs ${
|
|
67
|
-
: `The project installs ${
|
|
95
|
+
? `The project installs ${packageName} ${installedVersion}, but this @git.zone/cli supports ${range}: update @git.zone/cli.`
|
|
96
|
+
: `The project installs ${packageName} ${installedVersion}, but this @git.zone/cli supports ${range}: upgrade ${packageName} in the project.`);
|
|
68
97
|
}
|
|
69
|
-
const
|
|
98
|
+
const rawConfig = provider.readConfig(smartconfigDataArg);
|
|
99
|
+
const configModuleUrl = plugins.nodeUrl.pathToFileURL(projectRequire.resolve(provider.configExport)).href;
|
|
70
100
|
const configModule = (await import(configModuleUrl));
|
|
71
101
|
try {
|
|
72
|
-
return configModule.resolveOutputs(
|
|
102
|
+
return configModule.resolveOutputs(rawConfig, projectDirArg);
|
|
73
103
|
}
|
|
74
104
|
catch (error) {
|
|
75
105
|
if (isTsseaError(error)) {
|
|
76
|
-
throw new Error(`${
|
|
106
|
+
throw new Error(`${packageName}: ${error.message} [${error.code}]`, { cause: error });
|
|
77
107
|
}
|
|
78
108
|
throw error;
|
|
79
109
|
}
|
|
80
110
|
};
|
|
81
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
111
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaGVscGVycy50c3NlYS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3RzL2hlbHBlcnMudHNzZWEudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQ0EsT0FBTyxLQUFLLE9BQU8sTUFBTSxjQUFjLENBQUM7QUFDeEMsT0FBTyxFQUFFLGFBQWEsRUFBRSxNQUFNLHNCQUFzQixDQUFDO0FBQ3JELE9BQU8sRUFBRSxxQkFBcUIsRUFBRSxlQUFlLEVBQUUsTUFBTSx5QkFBeUIsQ0FBQztBQUlqRixrRkFBa0Y7QUFDbEYsTUFBTSxDQUFDLE1BQU0sZ0JBQWdCLEdBQUcsaUJBQWlCLENBQUM7QUFFbEQsdUZBQXVGO0FBQ3ZGLE1BQU0sQ0FBQyxNQUFNLG1CQUFtQixHQUFHLFFBQVEsQ0FBQztBQUU1Qzs7O0dBR0c7QUFDSCxNQUFNLENBQUMsTUFBTSxvQkFBb0IsR0FBRyxRQUFRLENBQUM7QUFpQjdDLHNGQUFzRjtBQUN0RixNQUFNLFlBQVksR0FBRyxDQUFDLFFBQWlCLEVBQXdDLEVBQUUsQ0FDL0UsUUFBUSxZQUFZLEtBQUs7SUFDekIsUUFBUSxDQUFDLElBQUksS0FBSyxZQUFZO0lBQzlCLE9BQVEsUUFBdUMsQ0FBQyxJQUFJLEtBQUssUUFBUSxDQUFDO0FBRXBFLDZHQUE2RztBQUM3RyxNQUFNLHNCQUFzQixHQUFHLENBQUMsVUFBa0IsRUFBRSxRQUFnQixFQUFFLGVBQXVCLEVBQVcsRUFBRTtJQUN4RyxNQUFNLEtBQUssR0FBRyx1QkFBdUIsQ0FBQyxJQUFJLENBQUMsVUFBVSxDQUFDLENBQUM7SUFDdkQsSUFBSSxDQUFDLEtBQUssRUFBRSxDQUFDO1FBQ1gsT0FBTyxLQUFLLENBQUM7SUFDZixDQUFDO0lBQ0QsTUFBTSxDQUFDLEtBQUssRUFBRSxLQUFLLENBQUMsR0FBRyxDQUFDLE1BQU0sQ0FBQyxLQUFLLENBQUMsQ0FBQyxDQUFDLENBQUMsRUFBRSxNQUFNLENBQUMsS0FBSyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQztJQUM1RCxPQUFPLEtBQUssS0FBSyxRQUFRLElBQUksS0FBSyxJQUFJLGVBQWUsQ0FBQztBQUN4RCxDQUFDLENBQUM7QUFFRixNQUFNLGFBQWEsR0FBdUI7SUFDeEMsV0FBVyxFQUFFLGdCQUFnQjtJQUM3QixZQUFZLEVBQUUsR0FBRyxnQkFBZ0IsU0FBUztJQUMxQyxLQUFLLEVBQUUsbUJBQW1CO0lBQzFCLGtCQUFrQixFQUFFLENBQUMsVUFBVSxFQUFFLEVBQUUsQ0FBQyxzQkFBc0IsQ0FBQyxVQUFVLEVBQUUsQ0FBQyxFQUFFLENBQUMsQ0FBQztJQUM1RSxVQUFVLEVBQUUsQ0FBQyxrQkFBa0IsRUFBRSxFQUFFLENBQUMsa0JBQWtCLENBQUMsZ0JBQWdCLENBQUM7Q0FDekUsQ0FBQztBQUVGLE1BQU0sY0FBYyxHQUF1QjtJQUN6QyxXQUFXLEVBQUUsZUFBZTtJQUM1QixZQUFZLEVBQUUsR0FBRyxlQUFlLGFBQWE7SUFDN0MsS0FBSyxFQUFFLG9CQUFvQjtJQUMzQixrQkFBa0IsRUFBRSxDQUFDLFVBQVUsRUFBRSxFQUFFLENBQUMsc0JBQXNCLENBQUMsVUFBVSxFQUFFLENBQUMsRUFBRSxDQUFDLENBQUM7SUFDNUUseUZBQXlGO0lBQ3pGLFVBQVUsRUFBRSxDQUFDLGtCQUFrQixFQUFFLEVBQUUsQ0FBQyxxQkFBcUIsQ0FBQyxrQkFBa0IsRUFBRSxLQUFLLENBQUM7Q0FDckYsQ0FBQztBQUVGLE1BQU0sbUJBQW1CLEdBQUcsS0FBSyxFQUFFLGFBQXFCLEVBQW9DLEVBQUU7SUFDNUYsTUFBTSxZQUFZLEdBQUcsT0FBTyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsYUFBYSxFQUFFLGNBQWMsQ0FBQyxDQUFDO0lBQ3RFLElBQUksT0FBZSxDQUFDO0lBQ3BCLElBQUksQ0FBQztRQUNILE9BQU8sR0FBRyxNQUFNLE9BQU8sQ0FBQyxFQUFFLENBQUMsUUFBUSxDQUFDLFlBQVksRUFBRSxNQUFNLENBQUMsQ0FBQztJQUM1RCxDQUFDO0lBQUMsT0FBTyxLQUFLLEVBQUUsQ0FBQztRQUNmLE1BQU0sSUFBSSxLQUFLLENBQUMscURBQXFELFlBQVksa0JBQWtCLEVBQUU7WUFDbkcsS0FBSyxFQUFFLEtBQUs7U0FDYixDQUFDLENBQUM7SUFDTCxDQUFDO0lBQ0QsTUFBTSxRQUFRLEdBQVksSUFBSSxDQUFDLEtBQUssQ0FBQyxPQUFPLENBQUMsQ0FBQztJQUM5QyxJQUFJLENBQUMsYUFBYSxDQUFDLFFBQVEsQ0FBQyxFQUFFLENBQUM7UUFDN0IsTUFBTSxJQUFJLEtBQUssQ0FBQyxHQUFHLFlBQVksK0JBQStCLENBQUMsQ0FBQztJQUNsRSxDQUFDO0lBQ0QsT0FBTyxRQUFRLENBQUM7QUFDbEIsQ0FBQyxDQUFDO0FBRUYsTUFBTSxrQkFBa0IsR0FBRyxDQUFDLFdBQW9DLEVBQUUsT0FBZSxFQUFXLEVBQUUsQ0FDNUYsQ0FBQyxjQUFjLEVBQUUsaUJBQWlCLENBQUMsQ0FBQyxJQUFJLENBQUMsQ0FBQyxRQUFRLEVBQUUsRUFBRTtJQUNwRCxNQUFNLEtBQUssR0FBRyxXQUFXLENBQUMsUUFBUSxDQUFDLENBQUM7SUFDcEMsT0FBTyxhQUFhLENBQUMsS0FBSyxDQUFDLElBQUksT0FBTyxLQUFLLENBQUMsT0FBTyxDQUFDLEtBQUssUUFBUSxDQUFDO0FBQ3BFLENBQUMsQ0FBQyxDQUFDO0FBRUw7Ozs7O0dBS0c7QUFDSCxNQUFNLENBQUMsTUFBTSwwQkFBMEIsR0FBRyxLQUFLLEVBQzdDLGFBQXFCLEVBQ3JCLGtCQUEyQyxFQUNuQixFQUFFO0lBQzFCLE1BQU0sUUFBUSxHQUFHLE1BQU0sbUJBQW1CLENBQUMsYUFBYSxDQUFDLENBQUM7SUFDMUQsTUFBTSxRQUFRLEdBQUcsa0JBQWtCLENBQUMsUUFBUSxFQUFFLGNBQWMsQ0FBQyxXQUFXLENBQUM7UUFDdkUsQ0FBQyxDQUFDLGNBQWM7UUFDaEIsQ0FBQyxDQUFDLGtCQUFrQixDQUFDLFFBQVEsRUFBRSxhQUFhLENBQUMsV0FBVyxDQUFDO1lBQ3ZELENBQUMsQ0FBQyxhQUFhO1lBQ2YsQ0FBQyxDQUFDLFNBQVMsQ0FBQztJQUNoQixJQUFJLENBQUMsUUFBUSxFQUFFLENBQUM7UUFDZCxNQUFNLElBQUksS0FBSyxDQUNiLHlCQUF5QixnQkFBZ0IsT0FBTyxlQUFlLCtCQUErQixnQkFBZ0IsaUJBQWlCLENBQ2hJLENBQUM7SUFDSixDQUFDO0lBQ0QsTUFBTSxFQUFFLFdBQVcsRUFBRSxLQUFLLEVBQUUsR0FBRyxRQUFRLENBQUM7SUFDeEMsNkVBQTZFO0lBQzdFLE1BQU0sV0FBVyxHQUFHLE9BQU8sQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLGFBQWEsRUFBRSxjQUFjLEVBQUUsR0FBRyxXQUFXLENBQUMsS0FBSyxDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUM7SUFDaEcsSUFBSSxDQUFDO1FBQ0gsTUFBTSxPQUFPLENBQUMsRUFBRSxDQUFDLEtBQUssQ0FBQyxXQUFXLENBQUMsQ0FBQztJQUN0QyxDQUFDO0lBQUMsTUFBTSxDQUFDO1FBQ1AsTUFBTSxJQUFJLEtBQUssQ0FBQyxHQUFHLFdBQVcscUNBQXFDLGFBQWEscUNBQXFDLENBQUMsQ0FBQztJQUN6SCxDQUFDO0lBQ0QsTUFBTSxjQUFjLEdBQUcsT0FBTyxDQUFDLFVBQVUsQ0FBQyxhQUFhLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsYUFBYSxFQUFFLGNBQWMsQ0FBQyxDQUFDLENBQUM7SUFDMUcsTUFBTSxpQkFBaUIsR0FBWSxjQUFjLENBQUMsR0FBRyxXQUFXLGVBQWUsQ0FBQyxDQUFDO0lBQ2pGLE1BQU0sZ0JBQWdCLEdBQ3BCLGFBQWEsQ0FBQyxpQkFBaUIsQ0FBQyxJQUFJLE9BQU8saUJBQWlCLENBQUMsT0FBTyxLQUFLLFFBQVE7UUFDL0UsQ0FBQyxDQUFDLGlCQUFpQixDQUFDLE9BQU87UUFDM0IsQ0FBQyxDQUFDLFNBQVMsQ0FBQztJQUNoQixJQUFJLENBQUMsUUFBUSxDQUFDLGtCQUFrQixDQUFDLGdCQUFnQixDQUFDLEVBQUUsQ0FBQztRQUNuRCxNQUFNLFVBQVUsR0FBRyxVQUFVLENBQUMsSUFBSSxDQUFDLGdCQUFnQixDQUFDLENBQUM7UUFDckQsTUFBTSxJQUFJLEtBQUssQ0FDYixVQUFVLElBQUksTUFBTSxDQUFDLFVBQVUsQ0FBQyxDQUFDLENBQUMsQ0FBQyxHQUFHLENBQUM7WUFDckMsQ0FBQyxDQUFDLHdCQUF3QixXQUFXLElBQUksZ0JBQWdCLHFDQUFxQyxLQUFLLHlCQUF5QjtZQUM1SCxDQUFDLENBQUMsd0JBQXdCLFdBQVcsSUFBSSxnQkFBZ0IscUNBQXFDLEtBQUssYUFBYSxXQUFXLGtCQUFrQixDQUNoSixDQUFDO0lBQ0osQ0FBQztJQUNELE1BQU0sU0FBUyxHQUFHLFFBQVEsQ0FBQyxVQUFVLENBQUMsa0JBQWtCLENBQUMsQ0FBQztJQUMxRCxNQUFNLGVBQWUsR0FBRyxPQUFPLENBQUMsT0FBTyxDQUFDLGFBQWEsQ0FBQyxjQUFjLENBQUMsT0FBTyxDQUFDLFFBQVEsQ0FBQyxZQUFZLENBQUMsQ0FBQyxDQUFDLElBQUksQ0FBQztJQUMxRyxNQUFNLFlBQVksR0FBRyxDQUFDLE1BQU0sTUFBTSxDQUFDLGVBQWUsQ0FBQyxDQUF1QixDQUFDO0lBQzNFLElBQUksQ0FBQztRQUNILE9BQU8sWUFBWSxDQUFDLGNBQWMsQ0FBQyxTQUFTLEVBQUUsYUFBYSxDQUFDLENBQUM7SUFDL0QsQ0FBQztJQUFDLE9BQU8sS0FBSyxFQUFFLENBQUM7UUFDZixJQUFJLFlBQVksQ0FBQyxLQUFLLENBQUMsRUFBRSxDQUFDO1lBQ3hCLE1BQU0sSUFBSSxLQUFLLENBQUMsR0FBRyxXQUFXLEtBQUssS0FBSyxDQUFDLE9BQU8sS0FBSyxLQUFLLENBQUMsSUFBSSxHQUFHLEVBQUUsRUFBRSxLQUFLLEVBQUUsS0FBSyxFQUFFLENBQUMsQ0FBQztRQUN4RixDQUFDO1FBQ0QsTUFBTSxLQUFLLENBQUM7SUFDZCxDQUFDO0FBQ0gsQ0FBQyxDQUFDIn0=
|
|
@@ -5,11 +5,28 @@ import * as plugins from "./plugins.js";
|
|
|
5
5
|
* project that does not should simply skip the cleanup.
|
|
6
6
|
*/
|
|
7
7
|
export declare const getProjectTstestBinPath: (projectRootArg: string, platformArg?: NodeJS.Platform) => string;
|
|
8
|
+
/** The project's own `@git.zone/tsrepo` binary, which carries tstest as `tsrepo test`. */
|
|
9
|
+
export declare const getProjectTsrepoBinPath: (projectRootArg: string, platformArg?: NodeJS.Platform) => string;
|
|
8
10
|
export declare const hasInstalledProjectTstestBinary: (projectRootArg: string, platformArg?: NodeJS.Platform) => Promise<boolean>;
|
|
11
|
+
export declare const hasInstalledProjectTsrepoBinary: (projectRootArg: string, platformArg?: NodeJS.Platform) => Promise<boolean>;
|
|
12
|
+
/** The command that removes the project's test artifacts. */
|
|
13
|
+
export interface ITestCleanupCommand {
|
|
14
|
+
tool: "tsrepo" | "tstest";
|
|
15
|
+
binPath: string;
|
|
16
|
+
args: string[];
|
|
17
|
+
}
|
|
18
|
+
/**
|
|
19
|
+
* `tsrepo test clean` when the project installs `@git.zone/tsrepo`, which
|
|
20
|
+
* carries tstest, otherwise its own `tstest clean`. Both are legitimate
|
|
21
|
+
* installs; tsrepo wins when a project has both.
|
|
22
|
+
*/
|
|
23
|
+
export declare const getProjectTestCleanupCommand: (projectRootArg: string, platformArg?: NodeJS.Platform) => Promise<ITestCleanupCommand>;
|
|
9
24
|
/**
|
|
10
25
|
* Whether the project wants its test artifacts removed as part of a release.
|
|
11
26
|
* Defaults to true; a project opts out with
|
|
12
|
-
* `{"@git.zone/
|
|
27
|
+
* `{"@git.zone/tsrepo": {"test": {"cleanup": {"onRelease": false}}}}`, or the
|
|
28
|
+
* legacy `{"@git.zone/tstest": {"cleanup": {"onRelease": false}}}`. Like
|
|
29
|
+
* tsrepo itself, this refuses a project that carries both sections.
|
|
13
30
|
*/
|
|
14
31
|
export declare const readTstestCleanupOnRelease: (projectRootArg: string) => boolean;
|
|
15
32
|
/** First tstest version that understands the `clean` subcommand. */
|
|
@@ -20,16 +37,18 @@ export declare const satisfiesMinimumCleanVersion: (versionArg: string) => boole
|
|
|
20
37
|
*/
|
|
21
38
|
export declare const readProjectTstestVersion: (projectRootArg: string) => Promise<string | null>;
|
|
22
39
|
/**
|
|
23
|
-
* True when a release should
|
|
24
|
-
*
|
|
25
|
-
*
|
|
26
|
-
*
|
|
40
|
+
* True when a release should clean the project's test artifacts: the project
|
|
41
|
+
* has not opted out, and it installs tsrepo (every tsrepo has `tsrepo test
|
|
42
|
+
* clean`) or a tstest at a version that understands `tstest clean`. An older
|
|
43
|
+
* tstest would treat `clean` as a test path, so it is deliberately skipped
|
|
44
|
+
* rather than invoked.
|
|
27
45
|
*/
|
|
28
46
|
export declare const shouldCleanTestArtifactsOnRelease: (projectRootArg: string) => Promise<boolean>;
|
|
29
47
|
/** Single-quote a value for safe interpolation into a shell command. */
|
|
30
48
|
export declare const shellQuote: (valueArg: string) => string;
|
|
31
49
|
/**
|
|
32
|
-
* Run the project's `
|
|
33
|
-
* reported and swallowed rather than failing an
|
|
50
|
+
* Run the project's `tsrepo test clean`, or its `tstest clean`. Cleanup is
|
|
51
|
+
* housekeeping, so a failure is reported and swallowed rather than failing an
|
|
52
|
+
* otherwise complete release.
|
|
34
53
|
*/
|
|
35
|
-
export declare const
|
|
54
|
+
export declare const runTestArtifactCleanup: (smartshellArg: plugins.smartshell.Smartshell, projectRootArg: string) => Promise<void>;
|
|
@@ -1,35 +1,67 @@
|
|
|
1
1
|
import * as plugins from "./plugins.js";
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
* project that does not should simply skip the cleanup.
|
|
6
|
-
*/
|
|
7
|
-
export const getProjectTstestBinPath = (projectRootArg, platformArg = process.platform) => {
|
|
8
|
-
return plugins.path.join(projectRootArg, "node_modules", ".bin", platformArg === "win32" ? "tstest.CMD" : "tstest");
|
|
9
|
-
};
|
|
10
|
-
export const hasInstalledProjectTstestBinary = async (projectRootArg, platformArg = process.platform) => {
|
|
2
|
+
import { readTsrepoToolSection } from "./helpers.toolconfig.js";
|
|
3
|
+
const getProjectBinPath = (projectRootArg, nameArg, platformArg) => plugins.path.join(projectRootArg, "node_modules", ".bin", platformArg === "win32" ? `${nameArg}.CMD` : nameArg);
|
|
4
|
+
const isAccessible = async (pathArg) => {
|
|
11
5
|
try {
|
|
12
|
-
await plugins.fs.access(
|
|
6
|
+
await plugins.fs.access(pathArg);
|
|
13
7
|
return true;
|
|
14
8
|
}
|
|
15
9
|
catch {
|
|
16
10
|
return false;
|
|
17
11
|
}
|
|
18
12
|
};
|
|
13
|
+
/**
|
|
14
|
+
* Resolve the project's own tstest binary. The CLI deliberately does not
|
|
15
|
+
* depend on tstest at runtime: a project that tests already has it, and a
|
|
16
|
+
* project that does not should simply skip the cleanup.
|
|
17
|
+
*/
|
|
18
|
+
export const getProjectTstestBinPath = (projectRootArg, platformArg = process.platform) => getProjectBinPath(projectRootArg, "tstest", platformArg);
|
|
19
|
+
/** The project's own `@git.zone/tsrepo` binary, which carries tstest as `tsrepo test`. */
|
|
20
|
+
export const getProjectTsrepoBinPath = (projectRootArg, platformArg = process.platform) => getProjectBinPath(projectRootArg, "tsrepo", platformArg);
|
|
21
|
+
export const hasInstalledProjectTstestBinary = async (projectRootArg, platformArg = process.platform) => isAccessible(getProjectTstestBinPath(projectRootArg, platformArg));
|
|
22
|
+
export const hasInstalledProjectTsrepoBinary = async (projectRootArg, platformArg = process.platform) => isAccessible(getProjectTsrepoBinPath(projectRootArg, platformArg));
|
|
23
|
+
/**
|
|
24
|
+
* `tsrepo test clean` when the project installs `@git.zone/tsrepo`, which
|
|
25
|
+
* carries tstest, otherwise its own `tstest clean`. Both are legitimate
|
|
26
|
+
* installs; tsrepo wins when a project has both.
|
|
27
|
+
*/
|
|
28
|
+
export const getProjectTestCleanupCommand = async (projectRootArg, platformArg = process.platform) => (await hasInstalledProjectTsrepoBinary(projectRootArg, platformArg))
|
|
29
|
+
? {
|
|
30
|
+
tool: "tsrepo",
|
|
31
|
+
binPath: getProjectTsrepoBinPath(projectRootArg, platformArg),
|
|
32
|
+
args: ["test", "clean"],
|
|
33
|
+
}
|
|
34
|
+
: {
|
|
35
|
+
tool: "tstest",
|
|
36
|
+
binPath: getProjectTstestBinPath(projectRootArg, platformArg),
|
|
37
|
+
args: ["clean"],
|
|
38
|
+
};
|
|
19
39
|
/**
|
|
20
40
|
* Whether the project wants its test artifacts removed as part of a release.
|
|
21
41
|
* Defaults to true; a project opts out with
|
|
22
|
-
* `{"@git.zone/
|
|
42
|
+
* `{"@git.zone/tsrepo": {"test": {"cleanup": {"onRelease": false}}}}`, or the
|
|
43
|
+
* legacy `{"@git.zone/tstest": {"cleanup": {"onRelease": false}}}`. Like
|
|
44
|
+
* tsrepo itself, this refuses a project that carries both sections.
|
|
23
45
|
*/
|
|
24
46
|
export const readTstestCleanupOnRelease = (projectRootArg) => {
|
|
47
|
+
let smartconfigData;
|
|
25
48
|
try {
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
return tstestConfig?.cleanup?.onRelease !== false;
|
|
49
|
+
smartconfigData = new plugins.smartconfig.Smartconfig(projectRootArg)
|
|
50
|
+
.smartconfigJsonData;
|
|
29
51
|
}
|
|
30
52
|
catch {
|
|
31
53
|
return true;
|
|
32
54
|
}
|
|
55
|
+
if (typeof smartconfigData !== "object" ||
|
|
56
|
+
smartconfigData === null ||
|
|
57
|
+
Array.isArray(smartconfigData)) {
|
|
58
|
+
return true;
|
|
59
|
+
}
|
|
60
|
+
const testConfig = readTsrepoToolSection(smartconfigData, "test");
|
|
61
|
+
const cleanup = testConfig?.cleanup;
|
|
62
|
+
return !(typeof cleanup === "object" &&
|
|
63
|
+
cleanup !== null &&
|
|
64
|
+
cleanup.onRelease === false);
|
|
33
65
|
};
|
|
34
66
|
/** First tstest version that understands the `clean` subcommand. */
|
|
35
67
|
export const MINIMUM_TSTEST_CLEAN_VERSION = "6.1.0";
|
|
@@ -64,15 +96,19 @@ export const readProjectTstestVersion = async (projectRootArg) => {
|
|
|
64
96
|
}
|
|
65
97
|
};
|
|
66
98
|
/**
|
|
67
|
-
* True when a release should
|
|
68
|
-
*
|
|
69
|
-
*
|
|
70
|
-
*
|
|
99
|
+
* True when a release should clean the project's test artifacts: the project
|
|
100
|
+
* has not opted out, and it installs tsrepo (every tsrepo has `tsrepo test
|
|
101
|
+
* clean`) or a tstest at a version that understands `tstest clean`. An older
|
|
102
|
+
* tstest would treat `clean` as a test path, so it is deliberately skipped
|
|
103
|
+
* rather than invoked.
|
|
71
104
|
*/
|
|
72
105
|
export const shouldCleanTestArtifactsOnRelease = async (projectRootArg) => {
|
|
73
106
|
if (!readTstestCleanupOnRelease(projectRootArg)) {
|
|
74
107
|
return false;
|
|
75
108
|
}
|
|
109
|
+
if (await hasInstalledProjectTsrepoBinary(projectRootArg)) {
|
|
110
|
+
return true;
|
|
111
|
+
}
|
|
76
112
|
if (!(await hasInstalledProjectTstestBinary(projectRootArg))) {
|
|
77
113
|
return false;
|
|
78
114
|
}
|
|
@@ -82,21 +118,23 @@ export const shouldCleanTestArtifactsOnRelease = async (projectRootArg) => {
|
|
|
82
118
|
/** Single-quote a value for safe interpolation into a shell command. */
|
|
83
119
|
export const shellQuote = (valueArg) => `'${valueArg.replaceAll("'", `'\\''`)}'`;
|
|
84
120
|
/**
|
|
85
|
-
* Run the project's `
|
|
86
|
-
* reported and swallowed rather than failing an
|
|
121
|
+
* Run the project's `tsrepo test clean`, or its `tstest clean`. Cleanup is
|
|
122
|
+
* housekeeping, so a failure is reported and swallowed rather than failing an
|
|
123
|
+
* otherwise complete release.
|
|
87
124
|
*/
|
|
88
|
-
export const
|
|
89
|
-
const
|
|
125
|
+
export const runTestArtifactCleanup = async (smartshellArg, projectRootArg) => {
|
|
126
|
+
const command = await getProjectTestCleanupCommand(projectRootArg);
|
|
127
|
+
const label = `${command.tool} ${command.args.join(" ")}`;
|
|
90
128
|
console.log("cleaning test artifacts");
|
|
91
129
|
try {
|
|
92
130
|
// Quoted: a project path may contain spaces or shell metacharacters.
|
|
93
|
-
const execResult = await smartshellArg.exec(`cd ${shellQuote(projectRootArg)} && ${shellQuote(
|
|
131
|
+
const execResult = await smartshellArg.exec(`cd ${shellQuote(projectRootArg)} && ${[command.binPath, ...command.args].map(shellQuote).join(" ")}`);
|
|
94
132
|
if (execResult.exitCode !== 0) {
|
|
95
|
-
console.error(
|
|
133
|
+
console.error(`${label} exited with ${execResult.exitCode}; leaving test artifacts in place`);
|
|
96
134
|
}
|
|
97
135
|
}
|
|
98
136
|
catch (error) {
|
|
99
|
-
console.error(
|
|
137
|
+
console.error(`${label} failed: ${error}`);
|
|
100
138
|
}
|
|
101
139
|
};
|
|
102
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
140
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaGVscGVycy50c3Rlc3QuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi90cy9oZWxwZXJzLnRzdGVzdC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEtBQUssT0FBTyxNQUFNLGNBQWMsQ0FBQztBQUN4QyxPQUFPLEVBQUUscUJBQXFCLEVBQUUsTUFBTSx5QkFBeUIsQ0FBQztBQUVoRSxNQUFNLGlCQUFpQixHQUFHLENBQ3hCLGNBQXNCLEVBQ3RCLE9BQWUsRUFDZixXQUE0QixFQUNwQixFQUFFLENBQ1YsT0FBTyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQ2YsY0FBYyxFQUNkLGNBQWMsRUFDZCxNQUFNLEVBQ04sV0FBVyxLQUFLLE9BQU8sQ0FBQyxDQUFDLENBQUMsR0FBRyxPQUFPLE1BQU0sQ0FBQyxDQUFDLENBQUMsT0FBTyxDQUNyRCxDQUFDO0FBRUosTUFBTSxZQUFZLEdBQUcsS0FBSyxFQUFFLE9BQWUsRUFBb0IsRUFBRTtJQUMvRCxJQUFJLENBQUM7UUFDSCxNQUFNLE9BQU8sQ0FBQyxFQUFFLENBQUMsTUFBTSxDQUFDLE9BQU8sQ0FBQyxDQUFDO1FBQ2pDLE9BQU8sSUFBSSxDQUFDO0lBQ2QsQ0FBQztJQUFDLE1BQU0sQ0FBQztRQUNQLE9BQU8sS0FBSyxDQUFDO0lBQ2YsQ0FBQztBQUNILENBQUMsQ0FBQztBQUVGOzs7O0dBSUc7QUFDSCxNQUFNLENBQUMsTUFBTSx1QkFBdUIsR0FBRyxDQUNyQyxjQUFzQixFQUN0QixXQUFXLEdBQW9CLE9BQU8sQ0FBQyxRQUFRLEVBQ3ZDLEVBQUUsQ0FBQyxpQkFBaUIsQ0FBQyxjQUFjLEVBQUUsUUFBUSxFQUFFLFdBQVcsQ0FBQyxDQUFDO0FBRXRFLDBGQUEwRjtBQUMxRixNQUFNLENBQUMsTUFBTSx1QkFBdUIsR0FBRyxDQUNyQyxjQUFzQixFQUN0QixXQUFXLEdBQW9CLE9BQU8sQ0FBQyxRQUFRLEVBQ3ZDLEVBQUUsQ0FBQyxpQkFBaUIsQ0FBQyxjQUFjLEVBQUUsUUFBUSxFQUFFLFdBQVcsQ0FBQyxDQUFDO0FBRXRFLE1BQU0sQ0FBQyxNQUFNLCtCQUErQixHQUFHLEtBQUssRUFDbEQsY0FBc0IsRUFDdEIsV0FBVyxHQUFvQixPQUFPLENBQUMsUUFBUSxFQUM3QixFQUFFLENBQ3BCLFlBQVksQ0FBQyx1QkFBdUIsQ0FBQyxjQUFjLEVBQUUsV0FBVyxDQUFDLENBQUMsQ0FBQztBQUVyRSxNQUFNLENBQUMsTUFBTSwrQkFBK0IsR0FBRyxLQUFLLEVBQ2xELGNBQXNCLEVBQ3RCLFdBQVcsR0FBb0IsT0FBTyxDQUFDLFFBQVEsRUFDN0IsRUFBRSxDQUNwQixZQUFZLENBQUMsdUJBQXVCLENBQUMsY0FBYyxFQUFFLFdBQVcsQ0FBQyxDQUFDLENBQUM7QUFTckU7Ozs7R0FJRztBQUNILE1BQU0sQ0FBQyxNQUFNLDRCQUE0QixHQUFHLEtBQUssRUFDL0MsY0FBc0IsRUFDdEIsV0FBVyxHQUFvQixPQUFPLENBQUMsUUFBUSxFQUNqQixFQUFFLENBQ2hDLENBQUMsTUFBTSwrQkFBK0IsQ0FBQyxjQUFjLEVBQUUsV0FBVyxDQUFDLENBQUM7SUFDbEUsQ0FBQyxDQUFDO1FBQ0UsSUFBSSxFQUFFLFFBQVE7UUFDZCxPQUFPLEVBQUUsdUJBQXVCLENBQUMsY0FBYyxFQUFFLFdBQVcsQ0FBQztRQUM3RCxJQUFJLEVBQUUsQ0FBQyxNQUFNLEVBQUUsT0FBTyxDQUFDO0tBQ3hCO0lBQ0gsQ0FBQyxDQUFDO1FBQ0UsSUFBSSxFQUFFLFFBQVE7UUFDZCxPQUFPLEVBQUUsdUJBQXVCLENBQUMsY0FBYyxFQUFFLFdBQVcsQ0FBQztRQUM3RCxJQUFJLEVBQUUsQ0FBQyxPQUFPLENBQUM7S0FDaEIsQ0FBQztBQUVSOzs7Ozs7R0FNRztBQUNILE1BQU0sQ0FBQyxNQUFNLDBCQUEwQixHQUFHLENBQUMsY0FBc0IsRUFBVyxFQUFFO0lBQzVFLElBQUksZUFBd0IsQ0FBQztJQUM3QixJQUFJLENBQUM7UUFDSCxlQUFlLEdBQUcsSUFBSSxPQUFPLENBQUMsV0FBVyxDQUFDLFdBQVcsQ0FBQyxjQUFjLENBQUM7YUFDbEUsbUJBQW1CLENBQUM7SUFDekIsQ0FBQztJQUFDLE1BQU0sQ0FBQztRQUNQLE9BQU8sSUFBSSxDQUFDO0lBQ2QsQ0FBQztJQUNELElBQ0UsT0FBTyxlQUFlLEtBQUssUUFBUTtRQUNuQyxlQUFlLEtBQUssSUFBSTtRQUN4QixLQUFLLENBQUMsT0FBTyxDQUFDLGVBQWUsQ0FBQyxFQUM5QixDQUFDO1FBQ0QsT0FBTyxJQUFJLENBQUM7SUFDZCxDQUFDO0lBQ0QsTUFBTSxVQUFVLEdBQUcscUJBQXFCLENBQ3RDLGVBQTBDLEVBQzFDLE1BQU0sQ0FDUCxDQUFDO0lBQ0YsTUFBTSxPQUFPLEdBQUcsVUFBVSxFQUFFLE9BQU8sQ0FBQztJQUNwQyxPQUFPLENBQUMsQ0FDTixPQUFPLE9BQU8sS0FBSyxRQUFRO1FBQzNCLE9BQU8sS0FBSyxJQUFJO1FBQ2YsT0FBbUMsQ0FBQyxTQUFTLEtBQUssS0FBSyxDQUN6RCxDQUFDO0FBQ0osQ0FBQyxDQUFDO0FBRUYsb0VBQW9FO0FBQ3BFLE1BQU0sQ0FBQyxNQUFNLDRCQUE0QixHQUFHLE9BQU8sQ0FBQztBQUVwRCxNQUFNLFlBQVksR0FBRyxDQUFDLFVBQWtCLEVBQVksRUFBRSxDQUNwRCxVQUFVO0tBQ1AsS0FBSyxDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUMsQ0FBQztLQUNiLEtBQUssQ0FBQyxHQUFHLENBQUM7S0FDVixHQUFHLENBQUMsQ0FBQyxJQUFJLEVBQUUsRUFBRSxDQUFDLE1BQU0sQ0FBQyxRQUFRLENBQUMsSUFBSSxFQUFFLEVBQUUsQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDO0FBRW5ELE1BQU0sQ0FBQyxNQUFNLDRCQUE0QixHQUFHLENBQUMsVUFBa0IsRUFBVyxFQUFFO0lBQzFFLE1BQU0sTUFBTSxHQUFHLFlBQVksQ0FBQyxVQUFVLENBQUMsQ0FBQztJQUN4QyxNQUFNLFFBQVEsR0FBRyxZQUFZLENBQUMsNEJBQTRCLENBQUMsQ0FBQztJQUM1RCxLQUFLLElBQUksS0FBSyxHQUFHLENBQUMsRUFBRSxLQUFLLEdBQUcsUUFBUSxDQUFDLE1BQU0sRUFBRSxLQUFLLEVBQUUsRUFBRSxDQUFDO1FBQ3JELE1BQU0sVUFBVSxHQUFHLE1BQU0sQ0FBQyxLQUFLLENBQUMsSUFBSSxDQUFDLENBQUM7UUFDdEMsSUFBSSxVQUFVLEdBQUcsUUFBUSxDQUFDLEtBQUssQ0FBQztZQUFFLE9BQU8sSUFBSSxDQUFDO1FBQzlDLElBQUksVUFBVSxHQUFHLFFBQVEsQ0FBQyxLQUFLLENBQUM7WUFBRSxPQUFPLEtBQUssQ0FBQztJQUNqRCxDQUFDO0lBQ0QsT0FBTyxJQUFJLENBQUM7QUFDZCxDQUFDLENBQUM7QUFFRjs7R0FFRztBQUNILE1BQU0sQ0FBQyxNQUFNLHdCQUF3QixHQUFHLEtBQUssRUFDM0MsY0FBc0IsRUFDRSxFQUFFO0lBQzFCLElBQUksQ0FBQztRQUNILE1BQU0sZUFBZSxHQUFHLE9BQU8sQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUN2QyxjQUFjLEVBQ2QsY0FBYyxFQUNkLFdBQVcsRUFDWCxRQUFRLEVBQ1IsY0FBYyxDQUNmLENBQUM7UUFDRixNQUFNLFFBQVEsR0FBRyxNQUFNLE9BQU8sQ0FBQyxFQUFFLENBQUMsUUFBUSxDQUFDLGVBQWUsRUFBRSxNQUFNLENBQUMsQ0FBQztRQUNwRSxNQUFNLE1BQU0sR0FBRyxJQUFJLENBQUMsS0FBSyxDQUFDLFFBQVEsQ0FBeUIsQ0FBQztRQUM1RCxPQUFPLE1BQU0sQ0FBQyxPQUFPLElBQUksSUFBSSxDQUFDO0lBQ2hDLENBQUM7SUFBQyxNQUFNLENBQUM7UUFDUCxPQUFPLElBQUksQ0FBQztJQUNkLENBQUM7QUFDSCxDQUFDLENBQUM7QUFFRjs7Ozs7O0dBTUc7QUFDSCxNQUFNLENBQUMsTUFBTSxpQ0FBaUMsR0FBRyxLQUFLLEVBQ3BELGNBQXNCLEVBQ0osRUFBRTtJQUNwQixJQUFJLENBQUMsMEJBQTBCLENBQUMsY0FBYyxDQUFDLEVBQUUsQ0FBQztRQUNoRCxPQUFPLEtBQUssQ0FBQztJQUNmLENBQUM7SUFDRCxJQUFJLE1BQU0sK0JBQStCLENBQUMsY0FBYyxDQUFDLEVBQUUsQ0FBQztRQUMxRCxPQUFPLElBQUksQ0FBQztJQUNkLENBQUM7SUFDRCxJQUFJLENBQUMsQ0FBQyxNQUFNLCtCQUErQixDQUFDLGNBQWMsQ0FBQyxDQUFDLEVBQUUsQ0FBQztRQUM3RCxPQUFPLEtBQUssQ0FBQztJQUNmLENBQUM7SUFDRCxNQUFNLE9BQU8sR0FBRyxNQUFNLHdCQUF3QixDQUFDLGNBQWMsQ0FBQyxDQUFDO0lBQy9ELE9BQU8sT0FBTyxDQUFDLENBQUMsQ0FBQyw0QkFBNEIsQ0FBQyxPQUFPLENBQUMsQ0FBQyxDQUFDLENBQUMsS0FBSyxDQUFDO0FBQ2pFLENBQUMsQ0FBQztBQUVGLHdFQUF3RTtBQUN4RSxNQUFNLENBQUMsTUFBTSxVQUFVLEdBQUcsQ0FBQyxRQUFnQixFQUFVLEVBQUUsQ0FDckQsSUFBSSxRQUFRLENBQUMsVUFBVSxDQUFDLEdBQUcsRUFBRSxPQUFPLENBQUMsR0FBRyxDQUFDO0FBRTNDOzs7O0dBSUc7QUFDSCxNQUFNLENBQUMsTUFBTSxzQkFBc0IsR0FBRyxLQUFLLEVBQ3pDLGFBQTRDLEVBQzVDLGNBQXNCLEVBQ1AsRUFBRTtJQUNqQixNQUFNLE9BQU8sR0FBRyxNQUFNLDRCQUE0QixDQUFDLGNBQWMsQ0FBQyxDQUFDO0lBQ25FLE1BQU0sS0FBSyxHQUFHLEdBQUcsT0FBTyxDQUFDLElBQUksSUFBSSxPQUFPLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxHQUFHLENBQUMsRUFBRSxDQUFDO0lBQzFELE9BQU8sQ0FBQyxHQUFHLENBQUMseUJBQXlCLENBQUMsQ0FBQztJQUN2QyxJQUFJLENBQUM7UUFDSCxxRUFBcUU7UUFDckUsTUFBTSxVQUFVLEdBQUcsTUFBTSxhQUFhLENBQUMsSUFBSSxDQUN6QyxNQUFNLFVBQVUsQ0FBQyxjQUFjLENBQUMsT0FBTyxDQUFDLE9BQU8sQ0FBQyxPQUFPLEVBQUUsR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLENBQUMsR0FBRyxDQUFDLFVBQVUsQ0FBQyxDQUFDLElBQUksQ0FBQyxHQUFHLENBQUMsRUFBRSxDQUN0RyxDQUFDO1FBQ0YsSUFBSSxVQUFVLENBQUMsUUFBUSxLQUFLLENBQUMsRUFBRSxDQUFDO1lBQzlCLE9BQU8sQ0FBQyxLQUFLLENBQ1gsR0FBRyxLQUFLLGdCQUFnQixVQUFVLENBQUMsUUFBUSxtQ0FBbUMsQ0FDL0UsQ0FBQztRQUNKLENBQUM7SUFDSCxDQUFDO0lBQUMsT0FBTyxLQUFLLEVBQUUsQ0FBQztRQUNmLE9BQU8sQ0FBQyxLQUFLLENBQUMsR0FBRyxLQUFLLFlBQVksS0FBSyxFQUFFLENBQUMsQ0FBQztJQUM3QyxDQUFDO0FBQ0gsQ0FBQyxDQUFDIn0=
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
import type { IRsrepoEngineClient } from "./mod_release/helpers.rsrepoengine.js";
|
|
2
|
+
/**
|
|
3
|
+
* Where a project keeps the version gitzone releases:
|
|
4
|
+
* - `npm`: package.json.
|
|
5
|
+
* - `npm+internal-rust`: package.json; the crates of its `rust/` or `ts_rust/`
|
|
6
|
+
* workspace keep their own versions.
|
|
7
|
+
* - `cargo`: the Cargo workspace (`projectType: "rust"`), read and written
|
|
8
|
+
* only through the rsrepo engine (`plan` and `set-version`).
|
|
9
|
+
*/
|
|
10
|
+
export type TVersionSourceKind = "npm" | "npm+internal-rust" | "cargo";
|
|
11
|
+
export interface IVersionSource {
|
|
12
|
+
kind: TVersionSourceKind;
|
|
13
|
+
/** The project directory the source reads and writes. */
|
|
14
|
+
cwd: string;
|
|
15
|
+
/** What carries the version, for messages. */
|
|
16
|
+
description: string;
|
|
17
|
+
/** `00_commitinfo_data.ts` is baked only into TypeScript projects. */
|
|
18
|
+
bakesCommitInfo: boolean;
|
|
19
|
+
readCurrentVersion: () => Promise<string>;
|
|
20
|
+
/** Writes the version and returns the changed files, relative to the workspace root. */
|
|
21
|
+
writeVersion: (versionArg: string) => Promise<string[]>;
|
|
22
|
+
}
|
|
23
|
+
/** Internal Rust workspaces of a TypeScript package, as tsrust lays them out. */
|
|
24
|
+
export declare const internalRustWorkspaceDirectories: readonly ["rust", "ts_rust"];
|
|
25
|
+
/**
|
|
26
|
+
* The version source of a project: Cargo for `projectType: "rust"`, otherwise
|
|
27
|
+
* package.json, which a TypeScript project with an internal Rust workspace
|
|
28
|
+
* shares with nothing.
|
|
29
|
+
*/
|
|
30
|
+
export declare const detectVersionSourceKind: (cwdArg: string, projectTypeArg: unknown) => Promise<TVersionSourceKind>;
|
|
31
|
+
/** The project's projectType, read from the `.smartconfig.json` in `cwdArg`. */
|
|
32
|
+
export declare const readProjectType: (cwdArg: string) => unknown;
|
|
33
|
+
/**
|
|
34
|
+
* Opens the version source of `kindArg`. A Cargo source needs the project's
|
|
35
|
+
* rsrepo engine; a package.json source never runs it.
|
|
36
|
+
*/
|
|
37
|
+
export declare const openVersionSource: (kindArg: TVersionSourceKind, cwdArg: string, engineArg?: IRsrepoEngineClient) => IVersionSource;
|
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
import * as plugins from "./plugins.js";
|
|
2
|
+
const fileExists = async (pathArg) => {
|
|
3
|
+
try {
|
|
4
|
+
return (await plugins.fs.stat(pathArg)).isFile();
|
|
5
|
+
}
|
|
6
|
+
catch (error) {
|
|
7
|
+
if (error.code === "ENOENT")
|
|
8
|
+
return false;
|
|
9
|
+
throw error;
|
|
10
|
+
}
|
|
11
|
+
};
|
|
12
|
+
/** Internal Rust workspaces of a TypeScript package, as tsrust lays them out. */
|
|
13
|
+
export const internalRustWorkspaceDirectories = ["rust", "ts_rust"];
|
|
14
|
+
/**
|
|
15
|
+
* The version source of a project: Cargo for `projectType: "rust"`, otherwise
|
|
16
|
+
* package.json, which a TypeScript project with an internal Rust workspace
|
|
17
|
+
* shares with nothing.
|
|
18
|
+
*/
|
|
19
|
+
export const detectVersionSourceKind = async (cwdArg, projectTypeArg) => {
|
|
20
|
+
if (projectTypeArg === "rust")
|
|
21
|
+
return "cargo";
|
|
22
|
+
if (!(await fileExists(plugins.path.join(cwdArg, "package.json")))) {
|
|
23
|
+
if (await fileExists(plugins.path.join(cwdArg, "Cargo.toml"))) {
|
|
24
|
+
throw new Error(`${cwdArg} has a Cargo.toml and no package.json: set @git.zone/cli.projectType to "rust" so gitzone versions the Cargo workspace.`);
|
|
25
|
+
}
|
|
26
|
+
throw new Error(`No package.json found in ${cwdArg}: gitzone commit and release version the package.json, or the Cargo workspace of projectType "rust".`);
|
|
27
|
+
}
|
|
28
|
+
for (const directory of internalRustWorkspaceDirectories) {
|
|
29
|
+
if (await fileExists(plugins.path.join(cwdArg, directory, "Cargo.toml"))) {
|
|
30
|
+
return "npm+internal-rust";
|
|
31
|
+
}
|
|
32
|
+
}
|
|
33
|
+
return "npm";
|
|
34
|
+
};
|
|
35
|
+
/** The project's projectType, read from the `.smartconfig.json` in `cwdArg`. */
|
|
36
|
+
export const readProjectType = (cwdArg) => {
|
|
37
|
+
const smartconfigInstance = new plugins.smartconfig.Smartconfig(cwdArg);
|
|
38
|
+
const cliConfig = smartconfigInstance.dataFor("@git.zone/cli", {});
|
|
39
|
+
return cliConfig?.projectType;
|
|
40
|
+
};
|
|
41
|
+
const packageJsonVersionSource = (kindArg, cwdArg) => {
|
|
42
|
+
const packageJsonPath = plugins.path.join(cwdArg, "package.json");
|
|
43
|
+
const readPackageJson = async () => {
|
|
44
|
+
let content;
|
|
45
|
+
try {
|
|
46
|
+
content = await plugins.fs.readFile(packageJsonPath, "utf8");
|
|
47
|
+
}
|
|
48
|
+
catch (error) {
|
|
49
|
+
if (error.code === "ENOENT") {
|
|
50
|
+
throw new Error(`No package.json found in ${cwdArg}: gitzone commit and release version the package.json.`);
|
|
51
|
+
}
|
|
52
|
+
throw error;
|
|
53
|
+
}
|
|
54
|
+
const parsed = JSON.parse(content);
|
|
55
|
+
if (typeof parsed !== "object" || parsed === null || Array.isArray(parsed)) {
|
|
56
|
+
throw new Error(`${packageJsonPath} must contain a JSON object.`);
|
|
57
|
+
}
|
|
58
|
+
return parsed;
|
|
59
|
+
};
|
|
60
|
+
return {
|
|
61
|
+
kind: kindArg,
|
|
62
|
+
cwd: cwdArg,
|
|
63
|
+
description: kindArg === "npm"
|
|
64
|
+
? "package.json"
|
|
65
|
+
: "package.json (internal crates keep their own versions)",
|
|
66
|
+
bakesCommitInfo: true,
|
|
67
|
+
readCurrentVersion: async () => {
|
|
68
|
+
const version = (await readPackageJson()).version;
|
|
69
|
+
if (typeof version !== "string" || !version) {
|
|
70
|
+
throw new Error("package.json does not contain a version field");
|
|
71
|
+
}
|
|
72
|
+
return version;
|
|
73
|
+
},
|
|
74
|
+
writeVersion: async (versionArg) => {
|
|
75
|
+
const packageJson = await readPackageJson();
|
|
76
|
+
packageJson.version = versionArg;
|
|
77
|
+
await plugins.fs.writeFile(packageJsonPath, `${JSON.stringify(packageJson, null, 2)}\n`, "utf8");
|
|
78
|
+
return ["package.json"];
|
|
79
|
+
},
|
|
80
|
+
};
|
|
81
|
+
};
|
|
82
|
+
const cargoVersionSource = (cwdArg, engineArg) => ({
|
|
83
|
+
kind: "cargo",
|
|
84
|
+
cwd: cwdArg,
|
|
85
|
+
description: "the Cargo workspace version",
|
|
86
|
+
bakesCommitInfo: false,
|
|
87
|
+
readCurrentVersion: async () => {
|
|
88
|
+
const plan = await engineArg.plan({ cwd: cwdArg, registries: [] });
|
|
89
|
+
if (plan.layout !== "root") {
|
|
90
|
+
throw new Error(`projectType "rust" versions a Cargo workspace at the repository root; rsrepo found the ${plan.layout}/ layout.`);
|
|
91
|
+
}
|
|
92
|
+
if (plan.version === null) {
|
|
93
|
+
throw new Error("The Cargo workspace versions its crates independently. gitzone releases one shared version: move the members to [workspace.package] version and `version.workspace = true`.");
|
|
94
|
+
}
|
|
95
|
+
return plan.version;
|
|
96
|
+
},
|
|
97
|
+
writeVersion: async (versionArg) => (await engineArg.setVersion({ cwd: cwdArg, version: versionArg }))
|
|
98
|
+
.changedFiles,
|
|
99
|
+
});
|
|
100
|
+
/**
|
|
101
|
+
* Opens the version source of `kindArg`. A Cargo source needs the project's
|
|
102
|
+
* rsrepo engine; a package.json source never runs it.
|
|
103
|
+
*/
|
|
104
|
+
export const openVersionSource = (kindArg, cwdArg, engineArg) => {
|
|
105
|
+
if (kindArg !== "cargo")
|
|
106
|
+
return packageJsonVersionSource(kindArg, cwdArg);
|
|
107
|
+
if (!engineArg) {
|
|
108
|
+
throw new Error("The Cargo version source requires the rsrepo engine.");
|
|
109
|
+
}
|
|
110
|
+
return cargoVersionSource(cwdArg, engineArg);
|
|
111
|
+
};
|
|
112
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaGVscGVycy52ZXJzaW9uc291cmNlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vdHMvaGVscGVycy52ZXJzaW9uc291cmNlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sS0FBSyxPQUFPLE1BQU0sY0FBYyxDQUFDO0FBMEJ4QyxNQUFNLFVBQVUsR0FBRyxLQUFLLEVBQUUsT0FBZSxFQUFvQixFQUFFO0lBQzdELElBQUksQ0FBQztRQUNILE9BQU8sQ0FBQyxNQUFNLE9BQU8sQ0FBQyxFQUFFLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxDQUFDLENBQUMsTUFBTSxFQUFFLENBQUM7SUFDbkQsQ0FBQztJQUFDLE9BQU8sS0FBSyxFQUFFLENBQUM7UUFDZixJQUFLLEtBQStCLENBQUMsSUFBSSxLQUFLLFFBQVE7WUFBRSxPQUFPLEtBQUssQ0FBQztRQUNyRSxNQUFNLEtBQUssQ0FBQztJQUNkLENBQUM7QUFDSCxDQUFDLENBQUM7QUFFRixpRkFBaUY7QUFDakYsTUFBTSxDQUFDLE1BQU0sZ0NBQWdDLEdBQUcsQ0FBQyxNQUFNLEVBQUUsU0FBUyxDQUFVLENBQUM7QUFFN0U7Ozs7R0FJRztBQUNILE1BQU0sQ0FBQyxNQUFNLHVCQUF1QixHQUFHLEtBQUssRUFDMUMsTUFBYyxFQUNkLGNBQXVCLEVBQ00sRUFBRTtJQUMvQixJQUFJLGNBQWMsS0FBSyxNQUFNO1FBQUUsT0FBTyxPQUFPLENBQUM7SUFDOUMsSUFBSSxDQUFDLENBQUMsTUFBTSxVQUFVLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsTUFBTSxFQUFFLGNBQWMsQ0FBQyxDQUFDLENBQUMsRUFBRSxDQUFDO1FBQ25FLElBQUksTUFBTSxVQUFVLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsTUFBTSxFQUFFLFlBQVksQ0FBQyxDQUFDLEVBQUUsQ0FBQztZQUM5RCxNQUFNLElBQUksS0FBSyxDQUNiLEdBQUcsTUFBTSx5SEFBeUgsQ0FDbkksQ0FBQztRQUNKLENBQUM7UUFDRCxNQUFNLElBQUksS0FBSyxDQUNiLDRCQUE0QixNQUFNLHNHQUFzRyxDQUN6SSxDQUFDO0lBQ0osQ0FBQztJQUNELEtBQUssTUFBTSxTQUFTLElBQUksZ0NBQWdDLEVBQUUsQ0FBQztRQUN6RCxJQUFJLE1BQU0sVUFBVSxDQUFDLE9BQU8sQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLE1BQU0sRUFBRSxTQUFTLEVBQUUsWUFBWSxDQUFDLENBQUMsRUFBRSxDQUFDO1lBQ3pFLE9BQU8sbUJBQW1CLENBQUM7UUFDN0IsQ0FBQztJQUNILENBQUM7SUFDRCxPQUFPLEtBQUssQ0FBQztBQUNmLENBQUMsQ0FBQztBQUVGLGdGQUFnRjtBQUNoRixNQUFNLENBQUMsTUFBTSxlQUFlLEdBQUcsQ0FBQyxNQUFjLEVBQVcsRUFBRTtJQUN6RCxNQUFNLG1CQUFtQixHQUFHLElBQUksT0FBTyxDQUFDLFdBQVcsQ0FBQyxXQUFXLENBQUMsTUFBTSxDQUFDLENBQUM7SUFDeEUsTUFBTSxTQUFTLEdBQUcsbUJBQW1CLENBQUMsT0FBTyxDQUMzQyxlQUFlLEVBQ2YsRUFBRSxDQUNILENBQUM7SUFDRixPQUFPLFNBQVMsRUFBRSxXQUFXLENBQUM7QUFDaEMsQ0FBQyxDQUFDO0FBRUYsTUFBTSx3QkFBd0IsR0FBRyxDQUMvQixPQUFvQyxFQUNwQyxNQUFjLEVBQ0UsRUFBRTtJQUNsQixNQUFNLGVBQWUsR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxNQUFNLEVBQUUsY0FBYyxDQUFDLENBQUM7SUFDbEUsTUFBTSxlQUFlLEdBQUcsS0FBSyxJQUFzQyxFQUFFO1FBQ25FLElBQUksT0FBZSxDQUFDO1FBQ3BCLElBQUksQ0FBQztZQUNILE9BQU8sR0FBRyxNQUFNLE9BQU8sQ0FBQyxFQUFFLENBQUMsUUFBUSxDQUFDLGVBQWUsRUFBRSxNQUFNLENBQUMsQ0FBQztRQUMvRCxDQUFDO1FBQUMsT0FBTyxLQUFLLEVBQUUsQ0FBQztZQUNmLElBQUssS0FBK0IsQ0FBQyxJQUFJLEtBQUssUUFBUSxFQUFFLENBQUM7Z0JBQ3ZELE1BQU0sSUFBSSxLQUFLLENBQ2IsNEJBQTRCLE1BQU0sd0RBQXdELENBQzNGLENBQUM7WUFDSixDQUFDO1lBQ0QsTUFBTSxLQUFLLENBQUM7UUFDZCxDQUFDO1FBQ0QsTUFBTSxNQUFNLEdBQVksSUFBSSxDQUFDLEtBQUssQ0FBQyxPQUFPLENBQUMsQ0FBQztRQUM1QyxJQUFJLE9BQU8sTUFBTSxLQUFLLFFBQVEsSUFBSSxNQUFNLEtBQUssSUFBSSxJQUFJLEtBQUssQ0FBQyxPQUFPLENBQUMsTUFBTSxDQUFDLEVBQUUsQ0FBQztZQUMzRSxNQUFNLElBQUksS0FBSyxDQUFDLEdBQUcsZUFBZSw4QkFBOEIsQ0FBQyxDQUFDO1FBQ3BFLENBQUM7UUFDRCxPQUFPLE1BQWlDLENBQUM7SUFDM0MsQ0FBQyxDQUFDO0lBQ0YsT0FBTztRQUNMLElBQUksRUFBRSxPQUFPO1FBQ2IsR0FBRyxFQUFFLE1BQU07UUFDWCxXQUFXLEVBQ1QsT0FBTyxLQUFLLEtBQUs7WUFDZixDQUFDLENBQUMsY0FBYztZQUNoQixDQUFDLENBQUMsd0RBQXdEO1FBQzlELGVBQWUsRUFBRSxJQUFJO1FBQ3JCLGtCQUFrQixFQUFFLEtBQUssSUFBSSxFQUFFO1lBQzdCLE1BQU0sT0FBTyxHQUFHLENBQUMsTUFBTSxlQUFlLEVBQUUsQ0FBQyxDQUFDLE9BQU8sQ0FBQztZQUNsRCxJQUFJLE9BQU8sT0FBTyxLQUFLLFFBQVEsSUFBSSxDQUFDLE9BQU8sRUFBRSxDQUFDO2dCQUM1QyxNQUFNLElBQUksS0FBSyxDQUFDLCtDQUErQyxDQUFDLENBQUM7WUFDbkUsQ0FBQztZQUNELE9BQU8sT0FBTyxDQUFDO1FBQ2pCLENBQUM7UUFDRCxZQUFZLEVBQUUsS0FBSyxFQUFFLFVBQVUsRUFBRSxFQUFFO1lBQ2pDLE1BQU0sV0FBVyxHQUFHLE1BQU0sZUFBZSxFQUFFLENBQUM7WUFDNUMsV0FBVyxDQUFDLE9BQU8sR0FBRyxVQUFVLENBQUM7WUFDakMsTUFBTSxPQUFPLENBQUMsRUFBRSxDQUFDLFNBQVMsQ0FDeEIsZUFBZSxFQUNmLEdBQUcsSUFBSSxDQUFDLFNBQVMsQ0FBQyxXQUFXLEVBQUUsSUFBSSxFQUFFLENBQUMsQ0FBQyxJQUFJLEVBQzNDLE1BQU0sQ0FDUCxDQUFDO1lBQ0YsT0FBTyxDQUFDLGNBQWMsQ0FBQyxDQUFDO1FBQzFCLENBQUM7S0FDRixDQUFDO0FBQ0osQ0FBQyxDQUFDO0FBRUYsTUFBTSxrQkFBa0IsR0FBRyxDQUN6QixNQUFjLEVBQ2QsU0FBOEIsRUFDZCxFQUFFLENBQUMsQ0FBQztJQUNwQixJQUFJLEVBQUUsT0FBTztJQUNiLEdBQUcsRUFBRSxNQUFNO0lBQ1gsV0FBVyxFQUFFLDZCQUE2QjtJQUMxQyxlQUFlLEVBQUUsS0FBSztJQUN0QixrQkFBa0IsRUFBRSxLQUFLLElBQUksRUFBRTtRQUM3QixNQUFNLElBQUksR0FBRyxNQUFNLFNBQVMsQ0FBQyxJQUFJLENBQUMsRUFBRSxHQUFHLEVBQUUsTUFBTSxFQUFFLFVBQVUsRUFBRSxFQUFFLEVBQUUsQ0FBQyxDQUFDO1FBQ25FLElBQUksSUFBSSxDQUFDLE1BQU0sS0FBSyxNQUFNLEVBQUUsQ0FBQztZQUMzQixNQUFNLElBQUksS0FBSyxDQUNiLDBGQUEwRixJQUFJLENBQUMsTUFBTSxXQUFXLENBQ2pILENBQUM7UUFDSixDQUFDO1FBQ0QsSUFBSSxJQUFJLENBQUMsT0FBTyxLQUFLLElBQUksRUFBRSxDQUFDO1lBQzFCLE1BQU0sSUFBSSxLQUFLLENBQ2IsNktBQTZLLENBQzlLLENBQUM7UUFDSixDQUFDO1FBQ0QsT0FBTyxJQUFJLENBQUMsT0FBTyxDQUFDO0lBQ3RCLENBQUM7SUFDRCxZQUFZLEVBQUUsS0FBSyxFQUFFLFVBQVUsRUFBRSxFQUFFLENBQ2pDLENBQUMsTUFBTSxTQUFTLENBQUMsVUFBVSxDQUFDLEVBQUUsR0FBRyxFQUFFLE1BQU0sRUFBRSxPQUFPLEVBQUUsVUFBVSxFQUFFLENBQUMsQ0FBQztTQUMvRCxZQUFZO0NBQ2xCLENBQUMsQ0FBQztBQUVIOzs7R0FHRztBQUNILE1BQU0sQ0FBQyxNQUFNLGlCQUFpQixHQUFHLENBQy9CLE9BQTJCLEVBQzNCLE1BQWMsRUFDZCxTQUErQixFQUNmLEVBQUU7SUFDbEIsSUFBSSxPQUFPLEtBQUssT0FBTztRQUFFLE9BQU8sd0JBQXdCLENBQUMsT0FBTyxFQUFFLE1BQU0sQ0FBQyxDQUFDO0lBQzFFLElBQUksQ0FBQyxTQUFTLEVBQUUsQ0FBQztRQUNmLE1BQU0sSUFBSSxLQUFLLENBQUMsc0RBQXNELENBQUMsQ0FBQztJQUMxRSxDQUFDO0lBQ0QsT0FBTyxrQkFBa0IsQ0FBQyxNQUFNLEVBQUUsU0FBUyxDQUFDLENBQUM7QUFDL0MsQ0FBQyxDQUFDIn0=
|
|
@@ -4,7 +4,7 @@ import { type IGiteaAssetTransferLimits } from "./mod_release/helpers.giteaasset
|
|
|
4
4
|
import { type IReleaseNpmPackageSet } from "./mod_release/helpers.npmpackages.js";
|
|
5
5
|
export type TConfirmationMode = "prompt" | "auto" | "plan";
|
|
6
6
|
export type TCommitStep = "format" | "analyze" | "test" | "build" | "changelog" | "commit" | "push";
|
|
7
|
-
export type TReleaseTarget = "git" | "giteaAssets" | "npm" | "docker";
|
|
7
|
+
export type TReleaseTarget = "git" | "giteaAssets" | "npm" | "cargo" | "docker";
|
|
8
8
|
export interface ICommitWorkflowConfig {
|
|
9
9
|
confirmation?: TConfirmationMode;
|
|
10
10
|
staging?: "all";
|
|
@@ -100,6 +100,31 @@ export interface IReleaseDockerTargetConfig {
|
|
|
100
100
|
context?: string;
|
|
101
101
|
noBuild?: boolean;
|
|
102
102
|
}
|
|
103
|
+
/**
|
|
104
|
+
* Cargo publication through the rsrepo engine. No configured cargo target
|
|
105
|
+
* means no Cargo publication.
|
|
106
|
+
*/
|
|
107
|
+
export interface IReleaseCargoTargetConfig {
|
|
108
|
+
enabled?: boolean;
|
|
109
|
+
/** `crates-io` or registry names defined in cargo config. */
|
|
110
|
+
registries?: string[];
|
|
111
|
+
/** Crates to publish; default every member whose Cargo `publish` admits each registry. */
|
|
112
|
+
members?: string[];
|
|
113
|
+
/** Minutes one accepted crate may stay unindexed before resume takes over. */
|
|
114
|
+
verificationWindowMinutes?: number;
|
|
115
|
+
}
|
|
116
|
+
export interface IResolvedReleaseCargoConfiguration {
|
|
117
|
+
registries: string[];
|
|
118
|
+
members?: string[];
|
|
119
|
+
verificationWindowMinutes: number;
|
|
120
|
+
}
|
|
121
|
+
/** The keys `release.targets` accepts; anything else is a typo or a target this gitzone lacks. */
|
|
122
|
+
export declare const releaseTargetConfigKeys: readonly ["git", "giteaAssets", "npm", "docker", "cargo"];
|
|
123
|
+
export declare const defaultCargoVerificationWindowMinutes = 15;
|
|
124
|
+
/** An enabled flag or registries switch the cargo target on, as for npm. */
|
|
125
|
+
export declare const isCargoTargetEnabled: (configArg: unknown) => boolean;
|
|
126
|
+
/** The active cargo target's settings; every key is checked. */
|
|
127
|
+
export declare const resolveCargoTargetConfiguration: (configArg: unknown) => IResolvedReleaseCargoConfiguration;
|
|
103
128
|
export interface IReleaseWorkflowConfig {
|
|
104
129
|
confirmation?: TConfirmationMode;
|
|
105
130
|
/** Newest completed local release records to keep; default 3. */
|
|
@@ -131,6 +156,7 @@ export interface IReleaseWorkflowConfig {
|
|
|
131
156
|
npm?: IReleaseNpmTargetConfig;
|
|
132
157
|
giteaAssets?: IReleaseGiteaAssetsTargetConfig;
|
|
133
158
|
docker?: IReleaseDockerTargetConfig;
|
|
159
|
+
cargo?: IReleaseCargoTargetConfig;
|
|
134
160
|
};
|
|
135
161
|
}
|
|
136
162
|
export interface IResolvedCommitWorkflow {
|
|
@@ -157,6 +183,12 @@ export interface IResolvedReleaseWorkflow {
|
|
|
157
183
|
cleanTestArtifacts: boolean;
|
|
158
184
|
testCommand: string;
|
|
159
185
|
buildCommand: string;
|
|
186
|
+
/**
|
|
187
|
+
* projectType "rust": the Cargo workspace carries the version, read and
|
|
188
|
+
* written through the rsrepo engine, and the release checkout fetches its
|
|
189
|
+
* locked Cargo dependencies.
|
|
190
|
+
*/
|
|
191
|
+
cargoVersioned: boolean;
|
|
160
192
|
changelogFile: "changelog.md";
|
|
161
193
|
changelogPendingSection: "Pending";
|
|
162
194
|
changelogVersionHeading: "## {{date}} - {{version}}";
|
|
@@ -187,6 +219,8 @@ export interface IResolvedReleaseWorkflow {
|
|
|
187
219
|
giteaAssetTransfer?: IGiteaAssetTransferLimits;
|
|
188
220
|
/** Attachments of a draft in progress at the same time. */
|
|
189
221
|
giteaAssetConcurrency?: number;
|
|
222
|
+
/** The cargo target's registries, member filter and verification window, when active. */
|
|
223
|
+
cargo?: IResolvedReleaseCargoConfiguration;
|
|
190
224
|
dockerEnabled: boolean;
|
|
191
225
|
dockerEngine: "tsdocker";
|
|
192
226
|
dockerRegistry?: string;
|
|
@@ -218,8 +252,17 @@ export interface IResolvedReleaseResumeConfiguration {
|
|
|
218
252
|
giteaAssets?: IResolvedReleaseGiteaAssetsConfiguration;
|
|
219
253
|
giteaAssetTransfer?: IGiteaAssetTransferLimits;
|
|
220
254
|
giteaAssetConcurrency?: number;
|
|
255
|
+
cargo?: IResolvedReleaseCargoConfiguration;
|
|
221
256
|
}
|
|
222
257
|
export type TResolvedReleaseDockerConfiguration = Pick<IResolvedReleaseWorkflow, "dockerRegistry" | "dockerBuildRegistries" | "dockerTest" | "dockerPatterns" | "dockerCached" | "dockerParallel" | "dockerContext" | "dockerNoBuild">;
|
|
258
|
+
/**
|
|
259
|
+
* The test and build commands a project runs when its configuration names
|
|
260
|
+
* none: pnpm scripts, or rsrepo for a Rust project, which has no package.json.
|
|
261
|
+
*/
|
|
262
|
+
export declare const getDefaultProjectCommands: (projectTypeArg: unknown) => {
|
|
263
|
+
test: string;
|
|
264
|
+
build: string;
|
|
265
|
+
};
|
|
223
266
|
export type TTsdockerMinimumVersion = readonly [number, number, number];
|
|
224
267
|
export declare const getTsdockerMinimumVersion: (buildRegistriesRequestedArg: boolean, imageTestsRequestedArg: boolean) => TTsdockerMinimumVersion | undefined;
|
|
225
268
|
export declare const formatTsdockerMinimumVersion: (minimumVersionArg: TTsdockerMinimumVersion) => string;
|
|
@@ -259,5 +302,6 @@ export declare const resolveReleaseResumeConfiguration: (optionsArg: {
|
|
|
259
302
|
git: boolean;
|
|
260
303
|
npm: boolean;
|
|
261
304
|
giteaAssets?: boolean;
|
|
305
|
+
cargo?: boolean;
|
|
262
306
|
}) => Promise<IResolvedReleaseResumeConfiguration>;
|
|
263
307
|
export declare const resolveReleaseDockerConfiguration: () => Promise<TResolvedReleaseDockerConfiguration>;
|