@git.zone/cli 8.1.0 → 8.2.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/dist_ts/00_commitinfo_data.js +1 -1
- package/dist_ts/mod_deprecate/helpers.deprecation.d.ts +14 -4
- package/dist_ts/mod_deprecate/helpers.deprecation.js +34 -15
- package/dist_ts/mod_deprecate/index.js +35 -14
- package/package.json +1 -1
- package/readme.md +10 -2
- package/ts/00_commitinfo_data.ts +1 -1
- package/ts/mod_deprecate/helpers.deprecation.ts +54 -22
- package/ts/mod_deprecate/index.ts +39 -12
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*/
|
|
4
4
|
export const commitinfo = {
|
|
5
5
|
name: '@git.zone/cli',
|
|
6
|
-
version: '8.
|
|
6
|
+
version: '8.2.0',
|
|
7
7
|
description: 'A comprehensive CLI tool for enhancing and managing local development workflows with gitzone utilities, focusing on project setup, version control, code formatting, and template management.'
|
|
8
8
|
};
|
|
9
9
|
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiMDBfY29tbWl0aW5mb19kYXRhLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vdHMvMDBfY29tbWl0aW5mb19kYXRhLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBOztHQUVHO0FBQ0gsTUFBTSxDQUFDLE1BQU0sVUFBVSxHQUFHO0lBQ3hCLElBQUksRUFBRSxlQUFlO0lBQ3JCLE9BQU8sRUFBRSxPQUFPO0lBQ2hCLFdBQVcsRUFBRSwrTEFBK0w7Q0FDN00sQ0FBQSJ9
|
|
@@ -1,12 +1,22 @@
|
|
|
1
1
|
import * as plugins from "./mod.plugins.js";
|
|
2
2
|
export interface IDeprecationPlan {
|
|
3
3
|
packageName: string;
|
|
4
|
-
|
|
4
|
+
/** The package that supersedes the deprecated one, or `null` when none exists. */
|
|
5
|
+
replacement: string | null;
|
|
5
6
|
message: string;
|
|
6
7
|
registries: string[];
|
|
7
8
|
}
|
|
8
|
-
export
|
|
9
|
+
export interface IDeprecationPlanOptions {
|
|
10
|
+
packageName: string;
|
|
11
|
+
replacement?: string | null;
|
|
9
12
|
message?: string;
|
|
10
|
-
|
|
11
|
-
|
|
13
|
+
registries: string[];
|
|
14
|
+
}
|
|
15
|
+
export declare const createDeprecationPlan: (options: IDeprecationPlanOptions) => IDeprecationPlan;
|
|
16
|
+
/** Human-readable plan lines; `--json` prints the plan object itself. */
|
|
17
|
+
export declare const describeDeprecationPlan: (plan: IDeprecationPlan) => string[];
|
|
18
|
+
/**
|
|
19
|
+
* Verify the old package (and its replacement, when one is named) on every
|
|
20
|
+
* registry before changing metadata for any of them.
|
|
21
|
+
*/
|
|
12
22
|
export declare const executeDeprecation: (planArg: IDeprecationPlan, shell: plugins.smartshell.Smartshell, cwd: string, fetchImplementation?: typeof fetch) => Promise<void>;
|
|
@@ -3,18 +3,23 @@ import { normalizeNpmRegistryUrl } from "../mod_release/helpers.npmartifact.js";
|
|
|
3
3
|
export const createDeprecationPlan = (options) => {
|
|
4
4
|
const namePattern = /^(?:@[a-z0-9][a-z0-9._-]*\/)?[a-z0-9][a-z0-9._-]*$/;
|
|
5
5
|
if (typeof options.packageName !== "string" ||
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
6
|
+
!namePattern.test(options.packageName))
|
|
7
|
+
throw new Error("Deprecation requires a valid package name.");
|
|
8
|
+
const replacement = options.replacement ?? null;
|
|
9
|
+
if (replacement !== null &&
|
|
10
|
+
(typeof replacement !== "string" ||
|
|
11
|
+
!namePattern.test(replacement) ||
|
|
12
|
+
options.packageName === replacement))
|
|
10
13
|
throw new Error("Deprecation requires distinct valid package and replacement names.");
|
|
14
|
+
if (replacement === null && options.message == null)
|
|
15
|
+
throw new Error("Deprecation without a replacement requires a message with guidance.");
|
|
11
16
|
if (!Array.isArray(options.registries))
|
|
12
17
|
throw new Error("Invalid deprecation registries.");
|
|
13
18
|
const registries = options.registries.map(normalizeNpmRegistryUrl);
|
|
14
19
|
if (!registries.length || new Set(registries).size !== registries.length)
|
|
15
20
|
throw new Error("Deprecation requires unique explicit registries.");
|
|
16
21
|
const message = options.message ??
|
|
17
|
-
`Use ${
|
|
22
|
+
`Use ${replacement}. ${options.packageName} is deprecated.`;
|
|
18
23
|
if (typeof message !== "string" ||
|
|
19
24
|
!message.trim() ||
|
|
20
25
|
message.length > 2000 ||
|
|
@@ -23,11 +28,18 @@ export const createDeprecationPlan = (options) => {
|
|
|
23
28
|
}
|
|
24
29
|
return {
|
|
25
30
|
packageName: options.packageName,
|
|
26
|
-
replacement
|
|
31
|
+
replacement,
|
|
27
32
|
registries,
|
|
28
33
|
message,
|
|
29
34
|
};
|
|
30
35
|
};
|
|
36
|
+
/** Human-readable plan lines; `--json` prints the plan object itself. */
|
|
37
|
+
export const describeDeprecationPlan = (plan) => [
|
|
38
|
+
`package: ${plan.packageName}`,
|
|
39
|
+
`replacement: ${plan.replacement ?? "none"}`,
|
|
40
|
+
`registries: ${plan.registries.join(", ")}`,
|
|
41
|
+
`message: ${plan.message}`,
|
|
42
|
+
];
|
|
31
43
|
const readMetadata = async (registry, packageName, fetchImplementation) => {
|
|
32
44
|
const response = await fetchImplementation(`${registry}/${encodeURIComponent(packageName)}`, {
|
|
33
45
|
method: "GET",
|
|
@@ -35,6 +47,8 @@ const readMetadata = async (registry, packageName, fetchImplementation) => {
|
|
|
35
47
|
signal: AbortSignal.timeout(30_000),
|
|
36
48
|
headers: { accept: "application/json", "cache-control": "no-cache" },
|
|
37
49
|
});
|
|
50
|
+
if (response.status === 404)
|
|
51
|
+
throw new Error(`${packageName} is not published on ${registry}.`);
|
|
38
52
|
if (!response.ok)
|
|
39
53
|
throw new Error(`Cannot verify ${packageName} on ${registry} (HTTP ${response.status}).`);
|
|
40
54
|
const metadata = await response.json();
|
|
@@ -50,17 +64,22 @@ const readMetadata = async (registry, packageName, fetchImplementation) => {
|
|
|
50
64
|
return metadata;
|
|
51
65
|
};
|
|
52
66
|
const isDeprecationComplete = (metadata, message) => Object.values(metadata.versions).every((version) => version.deprecated === message);
|
|
53
|
-
/**
|
|
67
|
+
/**
|
|
68
|
+
* Verify the old package (and its replacement, when one is named) on every
|
|
69
|
+
* registry before changing metadata for any of them.
|
|
70
|
+
*/
|
|
54
71
|
export const executeDeprecation = async (planArg, shell, cwd, fetchImplementation = fetch) => {
|
|
55
72
|
const plan = createDeprecationPlan(planArg);
|
|
56
73
|
for (const registry of plan.registries) {
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
74
|
+
if (plan.replacement !== null) {
|
|
75
|
+
const replacement = await readMetadata(registry, plan.replacement, fetchImplementation);
|
|
76
|
+
const latestTag = replacement["dist-tags"]?.latest;
|
|
77
|
+
const latest = typeof latestTag === "string"
|
|
78
|
+
? replacement.versions[latestTag]
|
|
79
|
+
: undefined;
|
|
80
|
+
if (!latest || latest.deprecated)
|
|
81
|
+
throw new Error(`Replacement ${plan.replacement} has no active latest version on ${registry}.`);
|
|
82
|
+
}
|
|
64
83
|
await readMetadata(registry, plan.packageName, fetchImplementation);
|
|
65
84
|
}
|
|
66
85
|
for (const registry of plan.registries) {
|
|
@@ -97,4 +116,4 @@ export const executeDeprecation = async (planArg, shell, cwd, fetchImplementatio
|
|
|
97
116
|
}
|
|
98
117
|
}
|
|
99
118
|
};
|
|
100
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
119
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaGVscGVycy5kZXByZWNhdGlvbi5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3RzL21vZF9kZXByZWNhdGUvaGVscGVycy5kZXByZWNhdGlvbi50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEtBQUssT0FBTyxNQUFNLGtCQUFrQixDQUFDO0FBQzVDLE9BQU8sRUFBRSx1QkFBdUIsRUFBRSxNQUFNLHVDQUF1QyxDQUFDO0FBaUJoRixNQUFNLENBQUMsTUFBTSxxQkFBcUIsR0FBRyxDQUNuQyxPQUFnQyxFQUNkLEVBQUU7SUFDcEIsTUFBTSxXQUFXLEdBQUcsb0RBQW9ELENBQUM7SUFDekUsSUFDRSxPQUFPLE9BQU8sQ0FBQyxXQUFXLEtBQUssUUFBUTtRQUN2QyxDQUFDLFdBQVcsQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLFdBQVcsQ0FBQztRQUV0QyxNQUFNLElBQUksS0FBSyxDQUFDLDRDQUE0QyxDQUFDLENBQUM7SUFDaEUsTUFBTSxXQUFXLEdBQUcsT0FBTyxDQUFDLFdBQVcsSUFBSSxJQUFJLENBQUM7SUFDaEQsSUFDRSxXQUFXLEtBQUssSUFBSTtRQUNwQixDQUFDLE9BQU8sV0FBVyxLQUFLLFFBQVE7WUFDOUIsQ0FBQyxXQUFXLENBQUMsSUFBSSxDQUFDLFdBQVcsQ0FBQztZQUM5QixPQUFPLENBQUMsV0FBVyxLQUFLLFdBQVcsQ0FBQztRQUV0QyxNQUFNLElBQUksS0FBSyxDQUNiLG9FQUFvRSxDQUNyRSxDQUFDO0lBQ0osSUFBSSxXQUFXLEtBQUssSUFBSSxJQUFJLE9BQU8sQ0FBQyxPQUFPLElBQUksSUFBSTtRQUNqRCxNQUFNLElBQUksS0FBSyxDQUNiLHFFQUFxRSxDQUN0RSxDQUFDO0lBQ0osSUFBSSxDQUFDLEtBQUssQ0FBQyxPQUFPLENBQUMsT0FBTyxDQUFDLFVBQVUsQ0FBQztRQUNwQyxNQUFNLElBQUksS0FBSyxDQUFDLGlDQUFpQyxDQUFDLENBQUM7SUFDckQsTUFBTSxVQUFVLEdBQUcsT0FBTyxDQUFDLFVBQVUsQ0FBQyxHQUFHLENBQUMsdUJBQXVCLENBQUMsQ0FBQztJQUNuRSxJQUFJLENBQUMsVUFBVSxDQUFDLE1BQU0sSUFBSSxJQUFJLEdBQUcsQ0FBQyxVQUFVLENBQUMsQ0FBQyxJQUFJLEtBQUssVUFBVSxDQUFDLE1BQU07UUFDdEUsTUFBTSxJQUFJLEtBQUssQ0FBQyxrREFBa0QsQ0FBQyxDQUFDO0lBQ3RFLE1BQU0sT0FBTyxHQUNYLE9BQU8sQ0FBQyxPQUFPO1FBQ2YsT0FBTyxXQUFXLEtBQUssT0FBTyxDQUFDLFdBQVcsaUJBQWlCLENBQUM7SUFDOUQsSUFDRSxPQUFPLE9BQU8sS0FBSyxRQUFRO1FBQzNCLENBQUMsT0FBTyxDQUFDLElBQUksRUFBRTtRQUNmLE9BQU8sQ0FBQyxNQUFNLEdBQUcsSUFBSTtRQUNyQixrQ0FBa0MsQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLEVBQ2hELENBQUM7UUFDRCxNQUFNLElBQUksS0FBSyxDQUFDLDhCQUE4QixDQUFDLENBQUM7SUFDbEQsQ0FBQztJQUNELE9BQU87UUFDTCxXQUFXLEVBQUUsT0FBTyxDQUFDLFdBQVc7UUFDaEMsV0FBVztRQUNYLFVBQVU7UUFDVixPQUFPO0tBQ1IsQ0FBQztBQUNKLENBQUMsQ0FBQztBQUVGLHlFQUF5RTtBQUN6RSxNQUFNLENBQUMsTUFBTSx1QkFBdUIsR0FBRyxDQUFDLElBQXNCLEVBQVksRUFBRSxDQUFDO0lBQzNFLFlBQVksSUFBSSxDQUFDLFdBQVcsRUFBRTtJQUM5QixnQkFBZ0IsSUFBSSxDQUFDLFdBQVcsSUFBSSxNQUFNLEVBQUU7SUFDNUMsZUFBZSxJQUFJLENBQUMsVUFBVSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsRUFBRTtJQUMzQyxZQUFZLElBQUksQ0FBQyxPQUFPLEVBQUU7Q0FDM0IsQ0FBQztBQVFGLE1BQU0sWUFBWSxHQUFHLEtBQUssRUFDeEIsUUFBZ0IsRUFDaEIsV0FBbUIsRUFDbkIsbUJBQWlDLEVBQ04sRUFBRTtJQUM3QixNQUFNLFFBQVEsR0FBRyxNQUFNLG1CQUFtQixDQUN4QyxHQUFHLFFBQVEsSUFBSSxrQkFBa0IsQ0FBQyxXQUFXLENBQUMsRUFBRSxFQUNoRDtRQUNFLE1BQU0sRUFBRSxLQUFLO1FBQ2IsUUFBUSxFQUFFLE9BQU87UUFDakIsTUFBTSxFQUFFLFdBQVcsQ0FBQyxPQUFPLENBQUMsTUFBTSxDQUFDO1FBQ25DLE9BQU8sRUFBRSxFQUFFLE1BQU0sRUFBRSxrQkFBa0IsRUFBRSxlQUFlLEVBQUUsVUFBVSxFQUFFO0tBQ3JFLENBQ0YsQ0FBQztJQUNGLElBQUksUUFBUSxDQUFDLE1BQU0sS0FBSyxHQUFHO1FBQ3pCLE1BQU0sSUFBSSxLQUFLLENBQUMsR0FBRyxXQUFXLHdCQUF3QixRQUFRLEdBQUcsQ0FBQyxDQUFDO0lBQ3JFLElBQUksQ0FBQyxRQUFRLENBQUMsRUFBRTtRQUNkLE1BQU0sSUFBSSxLQUFLLENBQ2IsaUJBQWlCLFdBQVcsT0FBTyxRQUFRLFVBQVUsUUFBUSxDQUFDLE1BQU0sSUFBSSxDQUN6RSxDQUFDO0lBQ0osTUFBTSxRQUFRLEdBQUcsTUFBTSxRQUFRLENBQUMsSUFBSSxFQUFFLENBQUM7SUFDdkMsSUFDRSxDQUFDLFFBQVE7UUFDVCxRQUFRLENBQUMsSUFBSSxLQUFLLFdBQVc7UUFDN0IsQ0FBQyxRQUFRLENBQUMsUUFBUTtRQUNsQixPQUFPLFFBQVEsQ0FBQyxRQUFRLEtBQUssUUFBUTtRQUNyQyxLQUFLLENBQUMsT0FBTyxDQUFDLFFBQVEsQ0FBQyxRQUFRLENBQUM7UUFDaEMsQ0FBQyxNQUFNLENBQUMsSUFBSSxDQUFDLFFBQVEsQ0FBQyxRQUFRLENBQUMsQ0FBQyxNQUFNO1FBQ3RDLE1BQU0sQ0FBQyxNQUFNLENBQUMsUUFBUSxDQUFDLFFBQVEsQ0FBQyxDQUFDLElBQUksQ0FDbkMsQ0FBQyxPQUFPLEVBQUUsRUFBRSxDQUNWLENBQUMsT0FBTyxJQUFJLE9BQU8sT0FBTyxLQUFLLFFBQVEsSUFBSSxLQUFLLENBQUMsT0FBTyxDQUFDLE9BQU8sQ0FBQyxDQUNwRSxFQUNELENBQUM7UUFDRCxNQUFNLElBQUksS0FBSyxDQUNiLGlDQUFpQyxXQUFXLE9BQU8sUUFBUSxHQUFHLENBQy9ELENBQUM7SUFDSixDQUFDO0lBQ0QsT0FBTyxRQUFRLENBQUM7QUFDbEIsQ0FBQyxDQUFDO0FBRUYsTUFBTSxxQkFBcUIsR0FBRyxDQUM1QixRQUEwQixFQUMxQixPQUFlLEVBQ04sRUFBRSxDQUNYLE1BQU0sQ0FBQyxNQUFNLENBQUMsUUFBUSxDQUFDLFFBQVEsQ0FBQyxDQUFDLEtBQUssQ0FDcEMsQ0FBQyxPQUFPLEVBQUUsRUFBRSxDQUFDLE9BQU8sQ0FBQyxVQUFVLEtBQUssT0FBTyxDQUM1QyxDQUFDO0FBRUo7OztHQUdHO0FBQ0gsTUFBTSxDQUFDLE1BQU0sa0JBQWtCLEdBQUcsS0FBSyxFQUNyQyxPQUF5QixFQUN6QixLQUFvQyxFQUNwQyxHQUFXLEVBQ1gsc0JBQW9DLEtBQUssRUFDMUIsRUFBRTtJQUNqQixNQUFNLElBQUksR0FBRyxxQkFBcUIsQ0FBQyxPQUFPLENBQUMsQ0FBQztJQUM1QyxLQUFLLE1BQU0sUUFBUSxJQUFJLElBQUksQ0FBQyxVQUFVLEVBQUUsQ0FBQztRQUN2QyxJQUFJLElBQUksQ0FBQyxXQUFXLEtBQUssSUFBSSxFQUFFLENBQUM7WUFDOUIsTUFBTSxXQUFXLEdBQUcsTUFBTSxZQUFZLENBQ3BDLFFBQVEsRUFDUixJQUFJLENBQUMsV0FBVyxFQUNoQixtQkFBbUIsQ0FDcEIsQ0FBQztZQUNGLE1BQU0sU0FBUyxHQUFHLFdBQVcsQ0FBQyxXQUFXLENBQUMsRUFBRSxNQUFNLENBQUM7WUFDbkQsTUFBTSxNQUFNLEdBQ1YsT0FBTyxTQUFTLEtBQUssUUFBUTtnQkFDM0IsQ0FBQyxDQUFDLFdBQVcsQ0FBQyxRQUFRLENBQUMsU0FBUyxDQUFDO2dCQUNqQyxDQUFDLENBQUMsU0FBUyxDQUFDO1lBQ2hCLElBQUksQ0FBQyxNQUFNLElBQUksTUFBTSxDQUFDLFVBQVU7Z0JBQzlCLE1BQU0sSUFBSSxLQUFLLENBQ2IsZUFBZSxJQUFJLENBQUMsV0FBVyxvQ0FBb0MsUUFBUSxHQUFHLENBQy9FLENBQUM7UUFDTixDQUFDO1FBQ0QsTUFBTSxZQUFZLENBQUMsUUFBUSxFQUFFLElBQUksQ0FBQyxXQUFXLEVBQUUsbUJBQW1CLENBQUMsQ0FBQztJQUN0RSxDQUFDO0lBQ0QsS0FBSyxNQUFNLFFBQVEsSUFBSSxJQUFJLENBQUMsVUFBVSxFQUFFLENBQUM7UUFDdkMseUVBQXlFO1FBQ3pFLDZFQUE2RTtRQUM3RSxNQUFNLFFBQVEsR0FBRyxNQUFNLFlBQVksQ0FDakMsUUFBUSxFQUNSLElBQUksQ0FBQyxXQUFXLEVBQ2hCLG1CQUFtQixDQUNwQixDQUFDO1FBQ0YsSUFBSSxxQkFBcUIsQ0FBQyxRQUFRLEVBQUUsSUFBSSxDQUFDLE9BQU8sQ0FBQztZQUFFLFNBQVM7UUFDNUQsTUFBTSxNQUFNLEdBQUcsTUFBTSxLQUFLLENBQUMsU0FBUyxDQUNsQyxNQUFNLEVBQ047WUFDRSxXQUFXO1lBQ1gsR0FBRyxJQUFJLENBQUMsV0FBVyxJQUFJO1lBQ3ZCLElBQUksQ0FBQyxPQUFPO1lBQ1osWUFBWTtZQUNaLFFBQVE7U0FDVCxFQUNEO1lBQ0UsR0FBRztZQUNILE9BQU8sRUFBRSxPQUFPO1lBQ2hCLGtCQUFrQixFQUFFLEtBQUs7U0FDMUIsQ0FDRixDQUFDO1FBQ0YsSUFBSSxRQUFRLEdBQUcsS0FBSyxDQUFDO1FBQ3JCLEtBQUssSUFBSSxPQUFPLEdBQUcsQ0FBQyxFQUFFLE9BQU8sR0FBRyxDQUFDLEVBQUUsT0FBTyxFQUFFLEVBQUUsQ0FBQztZQUM3QyxNQUFNLFFBQVEsR0FBRyxNQUFNLFlBQVksQ0FDakMsUUFBUSxFQUNSLElBQUksQ0FBQyxXQUFXLEVBQ2hCLG1CQUFtQixDQUNwQixDQUFDO1lBQ0YsSUFBSSxxQkFBcUIsQ0FBQyxRQUFRLEVBQUUsSUFBSSxDQUFDLE9BQU8sQ0FBQyxFQUFFLENBQUM7Z0JBQ2xELFFBQVEsR0FBRyxJQUFJLENBQUM7Z0JBQ2hCLE1BQU07WUFDUixDQUFDO1lBQ0QsSUFBSSxPQUFPLEdBQUcsQ0FBQztnQkFDYixNQUFNLElBQUksT0FBTyxDQUFPLENBQUMsT0FBTyxFQUFFLEVBQUUsQ0FBQyxVQUFVLENBQUMsT0FBTyxFQUFFLEtBQUssQ0FBQyxDQUFDLENBQUM7UUFDckUsQ0FBQztRQUNELElBQUksQ0FBQyxRQUFRLEVBQUUsQ0FBQztZQUNkLElBQUksTUFBTSxDQUFDLFFBQVEsS0FBSyxDQUFDO2dCQUN2QixNQUFNLElBQUksS0FBSyxDQUFDLHlCQUF5QixRQUFRLEdBQUcsQ0FBQyxDQUFDO1lBQ3hELE1BQU0sSUFBSSxLQUFLLENBQ2Isd0RBQXdELFFBQVEsMkNBQTJDLENBQzVHLENBQUM7UUFDSixDQUFDO0lBQ0gsQ0FBQztBQUNILENBQUMsQ0FBQyJ9
|
|
@@ -1,20 +1,24 @@
|
|
|
1
1
|
import * as plugins from "./mod.plugins.js";
|
|
2
2
|
import { logger } from "../gitzone.logging.js";
|
|
3
3
|
import { getCliMode, printJson } from "../helpers.climode.js";
|
|
4
|
-
import { createDeprecationPlan, executeDeprecation, } from "./helpers.deprecation.js";
|
|
4
|
+
import { createDeprecationPlan, describeDeprecationPlan, executeDeprecation, } from "./helpers.deprecation.js";
|
|
5
5
|
export const run = async (argvArg = {}) => {
|
|
6
6
|
const mode = await getCliMode(argvArg);
|
|
7
7
|
if (mode.help) {
|
|
8
8
|
console.log("gitzone deprecate --package <old> --replacement <new> --registries <url,url> [--message <text>] [--plan] [-y]");
|
|
9
|
-
console.log(
|
|
9
|
+
console.log('gitzone deprecate --package <old> --registries <url,url> --message "<old> is no longer maintained; <guidance>" [--plan] [-y]');
|
|
10
|
+
console.log("Deprecates all versions after verifying the package, and the replacement when one is named, on every registry.");
|
|
10
11
|
return;
|
|
11
12
|
}
|
|
12
13
|
let registryInput = argvArg.registries;
|
|
13
14
|
let oldPackageName = argvArg.package;
|
|
14
15
|
let newPackageName = argvArg.replacement;
|
|
15
|
-
|
|
16
|
+
let message = argvArg.message;
|
|
17
|
+
if (!registryInput ||
|
|
18
|
+
!oldPackageName ||
|
|
19
|
+
(newPackageName === undefined && message === undefined)) {
|
|
16
20
|
if (!mode.interactive || argvArg.plan || mode.json)
|
|
17
|
-
throw new Error("Specify --package, --
|
|
21
|
+
throw new Error("Specify --package, --registries, and --replacement or --message.");
|
|
18
22
|
const smartInteract = new plugins.smartinteract.SmartInteract([
|
|
19
23
|
{
|
|
20
24
|
name: `registryUrls`,
|
|
@@ -36,48 +40,65 @@ export const run = async (argvArg = {}) => {
|
|
|
36
40
|
},
|
|
37
41
|
{
|
|
38
42
|
name: `newPackageName`,
|
|
39
|
-
message: `Whats the name of the NEW package
|
|
43
|
+
message: `Whats the name of the NEW package? (leave empty if there is none)`,
|
|
40
44
|
type: `input`,
|
|
41
45
|
default: ``,
|
|
42
|
-
validate: (
|
|
43
|
-
return
|
|
46
|
+
validate: () => {
|
|
47
|
+
return !process.env.CI;
|
|
44
48
|
},
|
|
45
49
|
},
|
|
46
50
|
]);
|
|
47
51
|
const answerBucket = await smartInteract.runQueue();
|
|
48
52
|
registryInput = answerBucket.getAnswerFor("registryUrls");
|
|
49
53
|
oldPackageName = answerBucket.getAnswerFor("oldPackageName");
|
|
50
|
-
|
|
54
|
+
const newPackageAnswer = answerBucket.getAnswerFor("newPackageName");
|
|
55
|
+
newPackageName = newPackageAnswer === "" ? undefined : newPackageAnswer;
|
|
56
|
+
if (newPackageName === undefined && message === undefined) {
|
|
57
|
+
const messageAnswer = await smartInteract.askQuestion({
|
|
58
|
+
name: `message`,
|
|
59
|
+
message: `What deprecation message guides users of the OLD package?`,
|
|
60
|
+
type: `input`,
|
|
61
|
+
default: ``,
|
|
62
|
+
validate: (stringInput) => {
|
|
63
|
+
return stringInput !== "" && !process.env.CI;
|
|
64
|
+
},
|
|
65
|
+
});
|
|
66
|
+
message = messageAnswer.value;
|
|
67
|
+
}
|
|
51
68
|
}
|
|
52
69
|
if (typeof registryInput !== "string" ||
|
|
53
70
|
typeof oldPackageName !== "string" ||
|
|
54
|
-
typeof newPackageName !== "string")
|
|
71
|
+
(newPackageName !== undefined && typeof newPackageName !== "string") ||
|
|
72
|
+
(message !== undefined && typeof message !== "string")) {
|
|
55
73
|
throw new Error("Deprecation arguments must be strings.");
|
|
56
74
|
}
|
|
57
75
|
const plan = createDeprecationPlan({
|
|
58
76
|
packageName: oldPackageName,
|
|
59
77
|
replacement: newPackageName,
|
|
60
78
|
registries: registryInput.split(",").map((value) => value.trim()),
|
|
61
|
-
message
|
|
79
|
+
message,
|
|
62
80
|
});
|
|
63
81
|
if (mode.json) {
|
|
64
82
|
printJson({ ok: true, plan });
|
|
65
83
|
return;
|
|
66
84
|
}
|
|
67
|
-
|
|
85
|
+
for (const line of describeDeprecationPlan(plan))
|
|
86
|
+
console.log(line);
|
|
68
87
|
if (argvArg.plan)
|
|
69
88
|
return;
|
|
70
89
|
if (!mode.yes) {
|
|
71
90
|
if (!mode.interactive)
|
|
72
91
|
throw new Error("Deprecation requires -y or interactive confirmation.");
|
|
73
|
-
if (!(await plugins.smartinteract.SmartInteract.getCliConfirmation(`Deprecate every version of ${
|
|
92
|
+
if (!(await plugins.smartinteract.SmartInteract.getCliConfirmation(`Deprecate every version of ${plan.packageName}?`, false)))
|
|
74
93
|
return;
|
|
75
94
|
}
|
|
76
|
-
logger.log("info",
|
|
95
|
+
logger.log("info", plan.replacement === null
|
|
96
|
+
? `Deprecating package ${plan.packageName} without a replacement`
|
|
97
|
+
: `Deprecating package ${plan.packageName} in favour of ${plan.replacement}`);
|
|
77
98
|
const smartshellInstance = new plugins.smartshell.Smartshell({
|
|
78
99
|
executor: "bash",
|
|
79
100
|
});
|
|
80
101
|
await executeDeprecation(plan, smartshellInstance, process.cwd());
|
|
81
102
|
logger.log("ok", `Verified deprecation on ${plan.registries.length} registries.`);
|
|
82
103
|
};
|
|
83
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
104
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi90cy9tb2RfZGVwcmVjYXRlL2luZGV4LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sS0FBSyxPQUFPLE1BQU0sa0JBQWtCLENBQUM7QUFFNUMsT0FBTyxFQUFFLE1BQU0sRUFBRSxNQUFNLHVCQUF1QixDQUFDO0FBQy9DLE9BQU8sRUFBRSxVQUFVLEVBQUUsU0FBUyxFQUFFLE1BQU0sdUJBQXVCLENBQUM7QUFDOUQsT0FBTyxFQUNMLHFCQUFxQixFQUNyQix1QkFBdUIsRUFDdkIsa0JBQWtCLEdBQ25CLE1BQU0sMEJBQTBCLENBQUM7QUFFbEMsTUFBTSxDQUFDLE1BQU0sR0FBRyxHQUFHLEtBQUssRUFBRSxVQUFlLEVBQUUsRUFBRSxFQUFFO0lBQzdDLE1BQU0sSUFBSSxHQUFHLE1BQU0sVUFBVSxDQUFDLE9BQU8sQ0FBQyxDQUFDO0lBQ3ZDLElBQUksSUFBSSxDQUFDLElBQUksRUFBRSxDQUFDO1FBQ2QsT0FBTyxDQUFDLEdBQUcsQ0FDVCwrR0FBK0csQ0FDaEgsQ0FBQztRQUNGLE9BQU8sQ0FBQyxHQUFHLENBQ1QsOEhBQThILENBQy9ILENBQUM7UUFDRixPQUFPLENBQUMsR0FBRyxDQUNULGdIQUFnSCxDQUNqSCxDQUFDO1FBQ0YsT0FBTztJQUNULENBQUM7SUFDRCxJQUFJLGFBQWEsR0FBRyxPQUFPLENBQUMsVUFBVSxDQUFDO0lBQ3ZDLElBQUksY0FBYyxHQUFHLE9BQU8sQ0FBQyxPQUFPLENBQUM7SUFDckMsSUFBSSxjQUFjLEdBQUcsT0FBTyxDQUFDLFdBQVcsQ0FBQztJQUN6QyxJQUFJLE9BQU8sR0FBRyxPQUFPLENBQUMsT0FBTyxDQUFDO0lBQzlCLElBQ0UsQ0FBQyxhQUFhO1FBQ2QsQ0FBQyxjQUFjO1FBQ2YsQ0FBQyxjQUFjLEtBQUssU0FBUyxJQUFJLE9BQU8sS0FBSyxTQUFTLENBQUMsRUFDdkQsQ0FBQztRQUNELElBQUksQ0FBQyxJQUFJLENBQUMsV0FBVyxJQUFJLE9BQU8sQ0FBQyxJQUFJLElBQUksSUFBSSxDQUFDLElBQUk7WUFDaEQsTUFBTSxJQUFJLEtBQUssQ0FDYixrRUFBa0UsQ0FDbkUsQ0FBQztRQUNKLE1BQU0sYUFBYSxHQUFHLElBQUksT0FBTyxDQUFDLGFBQWEsQ0FBQyxhQUFhLENBQUM7WUFDNUQ7Z0JBQ0UsSUFBSSxFQUFFLGNBQWM7Z0JBQ3BCLE9BQU8sRUFBRSw2Q0FBNkM7Z0JBQ3RELElBQUksRUFBRSxPQUFPO2dCQUNiLE9BQU8sRUFBRSw0QkFBNEI7Z0JBQ3JDLFFBQVEsRUFBRSxDQUFDLFdBQVcsRUFBRSxFQUFFO29CQUN4QixPQUFPLFdBQVcsS0FBSyxFQUFFLElBQUksQ0FBQyxPQUFPLENBQUMsR0FBRyxDQUFDLEVBQUUsQ0FBQztnQkFDL0MsQ0FBQzthQUNGO1lBQ0Q7Z0JBQ0UsSUFBSSxFQUFFLGdCQUFnQjtnQkFDdEIsT0FBTyxFQUFFLG9DQUFvQztnQkFDN0MsSUFBSSxFQUFFLE9BQU87Z0JBQ2IsT0FBTyxFQUFFLEVBQUU7Z0JBQ1gsUUFBUSxFQUFFLENBQUMsV0FBVyxFQUFFLEVBQUU7b0JBQ3hCLE9BQU8sV0FBVyxLQUFLLEVBQUUsSUFBSSxDQUFDLE9BQU8sQ0FBQyxHQUFHLENBQUMsRUFBRSxDQUFDO2dCQUMvQyxDQUFDO2FBQ0Y7WUFDRDtnQkFDRSxJQUFJLEVBQUUsZ0JBQWdCO2dCQUN0QixPQUFPLEVBQUUsbUVBQW1FO2dCQUM1RSxJQUFJLEVBQUUsT0FBTztnQkFDYixPQUFPLEVBQUUsRUFBRTtnQkFDWCxRQUFRLEVBQUUsR0FBRyxFQUFFO29CQUNiLE9BQU8sQ0FBQyxPQUFPLENBQUMsR0FBRyxDQUFDLEVBQUUsQ0FBQztnQkFDekIsQ0FBQzthQUNGO1NBQ0YsQ0FBQyxDQUFDO1FBQ0gsTUFBTSxZQUFZLEdBQUcsTUFBTSxhQUFhLENBQUMsUUFBUSxFQUFFLENBQUM7UUFDcEQsYUFBYSxHQUFHLFlBQVksQ0FBQyxZQUFZLENBQUMsY0FBYyxDQUFDLENBQUM7UUFDMUQsY0FBYyxHQUFHLFlBQVksQ0FBQyxZQUFZLENBQUMsZ0JBQWdCLENBQUMsQ0FBQztRQUM3RCxNQUFNLGdCQUFnQixHQUFHLFlBQVksQ0FBQyxZQUFZLENBQUMsZ0JBQWdCLENBQUMsQ0FBQztRQUNyRSxjQUFjLEdBQUcsZ0JBQWdCLEtBQUssRUFBRSxDQUFDLENBQUMsQ0FBQyxTQUFTLENBQUMsQ0FBQyxDQUFDLGdCQUFnQixDQUFDO1FBQ3hFLElBQUksY0FBYyxLQUFLLFNBQVMsSUFBSSxPQUFPLEtBQUssU0FBUyxFQUFFLENBQUM7WUFDMUQsTUFBTSxhQUFhLEdBQUcsTUFBTSxhQUFhLENBQUMsV0FBVyxDQUFDO2dCQUNwRCxJQUFJLEVBQUUsU0FBUztnQkFDZixPQUFPLEVBQUUsMkRBQTJEO2dCQUNwRSxJQUFJLEVBQUUsT0FBTztnQkFDYixPQUFPLEVBQUUsRUFBRTtnQkFDWCxRQUFRLEVBQUUsQ0FBQyxXQUFXLEVBQUUsRUFBRTtvQkFDeEIsT0FBTyxXQUFXLEtBQUssRUFBRSxJQUFJLENBQUMsT0FBTyxDQUFDLEdBQUcsQ0FBQyxFQUFFLENBQUM7Z0JBQy9DLENBQUM7YUFDRixDQUFDLENBQUM7WUFDSCxPQUFPLEdBQUcsYUFBYSxDQUFDLEtBQUssQ0FBQztRQUNoQyxDQUFDO0lBQ0gsQ0FBQztJQUNELElBQ0UsT0FBTyxhQUFhLEtBQUssUUFBUTtRQUNqQyxPQUFPLGNBQWMsS0FBSyxRQUFRO1FBQ2xDLENBQUMsY0FBYyxLQUFLLFNBQVMsSUFBSSxPQUFPLGNBQWMsS0FBSyxRQUFRLENBQUM7UUFDcEUsQ0FBQyxPQUFPLEtBQUssU0FBUyxJQUFJLE9BQU8sT0FBTyxLQUFLLFFBQVEsQ0FBQyxFQUN0RCxDQUFDO1FBQ0QsTUFBTSxJQUFJLEtBQUssQ0FBQyx3Q0FBd0MsQ0FBQyxDQUFDO0lBQzVELENBQUM7SUFDRCxNQUFNLElBQUksR0FBRyxxQkFBcUIsQ0FBQztRQUNqQyxXQUFXLEVBQUUsY0FBYztRQUMzQixXQUFXLEVBQUUsY0FBYztRQUMzQixVQUFVLEVBQUUsYUFBYSxDQUFDLEtBQUssQ0FBQyxHQUFHLENBQUMsQ0FBQyxHQUFHLENBQUMsQ0FBQyxLQUFLLEVBQUUsRUFBRSxDQUFDLEtBQUssQ0FBQyxJQUFJLEVBQUUsQ0FBQztRQUNqRSxPQUFPO0tBQ1IsQ0FBQyxDQUFDO0lBQ0gsSUFBSSxJQUFJLENBQUMsSUFBSSxFQUFFLENBQUM7UUFDZCxTQUFTLENBQUMsRUFBRSxFQUFFLEVBQUUsSUFBSSxFQUFFLElBQUksRUFBRSxDQUFDLENBQUM7UUFDOUIsT0FBTztJQUNULENBQUM7SUFDRCxLQUFLLE1BQU0sSUFBSSxJQUFJLHVCQUF1QixDQUFDLElBQUksQ0FBQztRQUFFLE9BQU8sQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLENBQUM7SUFDcEUsSUFBSSxPQUFPLENBQUMsSUFBSTtRQUFFLE9BQU87SUFDekIsSUFBSSxDQUFDLElBQUksQ0FBQyxHQUFHLEVBQUUsQ0FBQztRQUNkLElBQUksQ0FBQyxJQUFJLENBQUMsV0FBVztZQUNuQixNQUFNLElBQUksS0FBSyxDQUFDLHNEQUFzRCxDQUFDLENBQUM7UUFDMUUsSUFDRSxDQUFDLENBQUMsTUFBTSxPQUFPLENBQUMsYUFBYSxDQUFDLGFBQWEsQ0FBQyxrQkFBa0IsQ0FDNUQsOEJBQThCLElBQUksQ0FBQyxXQUFXLEdBQUcsRUFDakQsS0FBSyxDQUNOLENBQUM7WUFFRixPQUFPO0lBQ1gsQ0FBQztJQUNELE1BQU0sQ0FBQyxHQUFHLENBQ1IsTUFBTSxFQUNOLElBQUksQ0FBQyxXQUFXLEtBQUssSUFBSTtRQUN2QixDQUFDLENBQUMsdUJBQXVCLElBQUksQ0FBQyxXQUFXLHdCQUF3QjtRQUNqRSxDQUFDLENBQUMsdUJBQXVCLElBQUksQ0FBQyxXQUFXLGlCQUFpQixJQUFJLENBQUMsV0FBVyxFQUFFLENBQy9FLENBQUM7SUFDRixNQUFNLGtCQUFrQixHQUFHLElBQUksT0FBTyxDQUFDLFVBQVUsQ0FBQyxVQUFVLENBQUM7UUFDM0QsUUFBUSxFQUFFLE1BQU07S0FDakIsQ0FBQyxDQUFDO0lBQ0gsTUFBTSxrQkFBa0IsQ0FBQyxJQUFJLEVBQUUsa0JBQWtCLEVBQUUsT0FBTyxDQUFDLEdBQUcsRUFBRSxDQUFDLENBQUM7SUFDbEUsTUFBTSxDQUFDLEdBQUcsQ0FDUixJQUFJLEVBQ0osMkJBQTJCLElBQUksQ0FBQyxVQUFVLENBQUMsTUFBTSxjQUFjLENBQ2hFLENBQUM7QUFDSixDQUFDLENBQUMifQ==
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@git.zone/cli",
|
|
3
3
|
"private": false,
|
|
4
|
-
"version": "8.
|
|
4
|
+
"version": "8.2.0",
|
|
5
5
|
"description": "A comprehensive CLI tool for enhancing and managing local development workflows with gitzone utilities, focusing on project setup, version control, code formatting, and template management.",
|
|
6
6
|
"main": "dist_ts/index.js",
|
|
7
7
|
"typings": "dist_ts/index.d.ts",
|
package/readme.md
CHANGED
|
@@ -1852,6 +1852,9 @@ gitzone deprecate
|
|
|
1852
1852
|
# Preview an explicit deprecation across both registries
|
|
1853
1853
|
gitzone deprecate --package @example/old --replacement @example/new --registries https://registry.npmjs.org,https://mirror.example.test --plan
|
|
1854
1854
|
|
|
1855
|
+
# Preview a deprecation for a package without a successor
|
|
1856
|
+
gitzone deprecate --package @example/old --registries https://registry.npmjs.org,https://mirror.example.test --message "@example/old is no longer maintained; use the platform fetch API instead." --plan
|
|
1857
|
+
|
|
1855
1858
|
# Prepare a project for local work
|
|
1856
1859
|
gitzone start
|
|
1857
1860
|
|
|
@@ -1861,8 +1864,13 @@ gitzone helpers shortid
|
|
|
1861
1864
|
|
|
1862
1865
|
For explicit deprecation, replace `--plan` with `-y` to apply the reviewed
|
|
1863
1866
|
operation. `--message` supplies migration instructions; otherwise the message
|
|
1864
|
-
names the replacement.
|
|
1865
|
-
|
|
1867
|
+
names the replacement. A package without an honest successor is deprecated
|
|
1868
|
+
without `--replacement`; `--message` is then required and should say what
|
|
1869
|
+
users do instead, and the plan shows `replacement: none` (`--json`:
|
|
1870
|
+
`"replacement": null`). Interactive mode accepts an empty replacement and then
|
|
1871
|
+
asks for the message. Deprecation applies to every version. GitZone verifies
|
|
1872
|
+
that the old package exists on all registries, and that the replacement, when
|
|
1873
|
+
named, has an active latest version there, before issuing any change, invokes
|
|
1866
1874
|
`pnpm deprecate` with literal arguments, and verifies the old versions' metadata
|
|
1867
1875
|
after each registry operation. Verification uses up to five fresh metadata reads,
|
|
1868
1876
|
one second apart, to allow registry propagation. A rerun skips any registry where
|
package/ts/00_commitinfo_data.ts
CHANGED
|
@@ -3,6 +3,6 @@
|
|
|
3
3
|
*/
|
|
4
4
|
export const commitinfo = {
|
|
5
5
|
name: '@git.zone/cli',
|
|
6
|
-
version: '8.
|
|
6
|
+
version: '8.2.0',
|
|
7
7
|
description: 'A comprehensive CLI tool for enhancing and managing local development workflows with gitzone utilities, focusing on project setup, version control, code formatting, and template management.'
|
|
8
8
|
}
|
|
@@ -3,25 +3,42 @@ import { normalizeNpmRegistryUrl } from "../mod_release/helpers.npmartifact.js";
|
|
|
3
3
|
|
|
4
4
|
export interface IDeprecationPlan {
|
|
5
5
|
packageName: string;
|
|
6
|
-
|
|
6
|
+
/** The package that supersedes the deprecated one, or `null` when none exists. */
|
|
7
|
+
replacement: string | null;
|
|
7
8
|
message: string;
|
|
8
9
|
registries: string[];
|
|
9
10
|
}
|
|
10
11
|
|
|
12
|
+
export interface IDeprecationPlanOptions {
|
|
13
|
+
packageName: string;
|
|
14
|
+
replacement?: string | null;
|
|
15
|
+
message?: string;
|
|
16
|
+
registries: string[];
|
|
17
|
+
}
|
|
18
|
+
|
|
11
19
|
export const createDeprecationPlan = (
|
|
12
|
-
options:
|
|
20
|
+
options: IDeprecationPlanOptions,
|
|
13
21
|
): IDeprecationPlan => {
|
|
14
22
|
const namePattern = /^(?:@[a-z0-9][a-z0-9._-]*\/)?[a-z0-9][a-z0-9._-]*$/;
|
|
15
23
|
if (
|
|
16
24
|
typeof options.packageName !== "string" ||
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
25
|
+
!namePattern.test(options.packageName)
|
|
26
|
+
)
|
|
27
|
+
throw new Error("Deprecation requires a valid package name.");
|
|
28
|
+
const replacement = options.replacement ?? null;
|
|
29
|
+
if (
|
|
30
|
+
replacement !== null &&
|
|
31
|
+
(typeof replacement !== "string" ||
|
|
32
|
+
!namePattern.test(replacement) ||
|
|
33
|
+
options.packageName === replacement)
|
|
21
34
|
)
|
|
22
35
|
throw new Error(
|
|
23
36
|
"Deprecation requires distinct valid package and replacement names.",
|
|
24
37
|
);
|
|
38
|
+
if (replacement === null && options.message == null)
|
|
39
|
+
throw new Error(
|
|
40
|
+
"Deprecation without a replacement requires a message with guidance.",
|
|
41
|
+
);
|
|
25
42
|
if (!Array.isArray(options.registries))
|
|
26
43
|
throw new Error("Invalid deprecation registries.");
|
|
27
44
|
const registries = options.registries.map(normalizeNpmRegistryUrl);
|
|
@@ -29,7 +46,7 @@ export const createDeprecationPlan = (
|
|
|
29
46
|
throw new Error("Deprecation requires unique explicit registries.");
|
|
30
47
|
const message =
|
|
31
48
|
options.message ??
|
|
32
|
-
`Use ${
|
|
49
|
+
`Use ${replacement}. ${options.packageName} is deprecated.`;
|
|
33
50
|
if (
|
|
34
51
|
typeof message !== "string" ||
|
|
35
52
|
!message.trim() ||
|
|
@@ -40,12 +57,20 @@ export const createDeprecationPlan = (
|
|
|
40
57
|
}
|
|
41
58
|
return {
|
|
42
59
|
packageName: options.packageName,
|
|
43
|
-
replacement
|
|
60
|
+
replacement,
|
|
44
61
|
registries,
|
|
45
62
|
message,
|
|
46
63
|
};
|
|
47
64
|
};
|
|
48
65
|
|
|
66
|
+
/** Human-readable plan lines; `--json` prints the plan object itself. */
|
|
67
|
+
export const describeDeprecationPlan = (plan: IDeprecationPlan): string[] => [
|
|
68
|
+
`package: ${plan.packageName}`,
|
|
69
|
+
`replacement: ${plan.replacement ?? "none"}`,
|
|
70
|
+
`registries: ${plan.registries.join(", ")}`,
|
|
71
|
+
`message: ${plan.message}`,
|
|
72
|
+
];
|
|
73
|
+
|
|
49
74
|
interface IPackageMetadata {
|
|
50
75
|
name: string;
|
|
51
76
|
versions: Record<string, { deprecated?: string }>;
|
|
@@ -66,6 +91,8 @@ const readMetadata = async (
|
|
|
66
91
|
headers: { accept: "application/json", "cache-control": "no-cache" },
|
|
67
92
|
},
|
|
68
93
|
);
|
|
94
|
+
if (response.status === 404)
|
|
95
|
+
throw new Error(`${packageName} is not published on ${registry}.`);
|
|
69
96
|
if (!response.ok)
|
|
70
97
|
throw new Error(
|
|
71
98
|
`Cannot verify ${packageName} on ${registry} (HTTP ${response.status}).`,
|
|
@@ -98,7 +125,10 @@ const isDeprecationComplete = (
|
|
|
98
125
|
(version) => version.deprecated === message,
|
|
99
126
|
);
|
|
100
127
|
|
|
101
|
-
/**
|
|
128
|
+
/**
|
|
129
|
+
* Verify the old package (and its replacement, when one is named) on every
|
|
130
|
+
* registry before changing metadata for any of them.
|
|
131
|
+
*/
|
|
102
132
|
export const executeDeprecation = async (
|
|
103
133
|
planArg: IDeprecationPlan,
|
|
104
134
|
shell: plugins.smartshell.Smartshell,
|
|
@@ -107,20 +137,22 @@ export const executeDeprecation = async (
|
|
|
107
137
|
): Promise<void> => {
|
|
108
138
|
const plan = createDeprecationPlan(planArg);
|
|
109
139
|
for (const registry of plan.registries) {
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
const latestTag = replacement["dist-tags"]?.latest;
|
|
116
|
-
const latest =
|
|
117
|
-
typeof latestTag === "string"
|
|
118
|
-
? replacement.versions[latestTag]
|
|
119
|
-
: undefined;
|
|
120
|
-
if (!latest || latest.deprecated)
|
|
121
|
-
throw new Error(
|
|
122
|
-
`Replacement ${plan.replacement} has no active latest version on ${registry}.`,
|
|
140
|
+
if (plan.replacement !== null) {
|
|
141
|
+
const replacement = await readMetadata(
|
|
142
|
+
registry,
|
|
143
|
+
plan.replacement,
|
|
144
|
+
fetchImplementation,
|
|
123
145
|
);
|
|
146
|
+
const latestTag = replacement["dist-tags"]?.latest;
|
|
147
|
+
const latest =
|
|
148
|
+
typeof latestTag === "string"
|
|
149
|
+
? replacement.versions[latestTag]
|
|
150
|
+
: undefined;
|
|
151
|
+
if (!latest || latest.deprecated)
|
|
152
|
+
throw new Error(
|
|
153
|
+
`Replacement ${plan.replacement} has no active latest version on ${registry}.`,
|
|
154
|
+
);
|
|
155
|
+
}
|
|
124
156
|
await readMetadata(registry, plan.packageName, fetchImplementation);
|
|
125
157
|
}
|
|
126
158
|
for (const registry of plan.registries) {
|
|
@@ -4,6 +4,7 @@ import { logger } from "../gitzone.logging.js";
|
|
|
4
4
|
import { getCliMode, printJson } from "../helpers.climode.js";
|
|
5
5
|
import {
|
|
6
6
|
createDeprecationPlan,
|
|
7
|
+
describeDeprecationPlan,
|
|
7
8
|
executeDeprecation,
|
|
8
9
|
} from "./helpers.deprecation.js";
|
|
9
10
|
|
|
@@ -14,16 +15,26 @@ export const run = async (argvArg: any = {}) => {
|
|
|
14
15
|
"gitzone deprecate --package <old> --replacement <new> --registries <url,url> [--message <text>] [--plan] [-y]",
|
|
15
16
|
);
|
|
16
17
|
console.log(
|
|
17
|
-
|
|
18
|
+
'gitzone deprecate --package <old> --registries <url,url> --message "<old> is no longer maintained; <guidance>" [--plan] [-y]',
|
|
19
|
+
);
|
|
20
|
+
console.log(
|
|
21
|
+
"Deprecates all versions after verifying the package, and the replacement when one is named, on every registry.",
|
|
18
22
|
);
|
|
19
23
|
return;
|
|
20
24
|
}
|
|
21
25
|
let registryInput = argvArg.registries;
|
|
22
26
|
let oldPackageName = argvArg.package;
|
|
23
27
|
let newPackageName = argvArg.replacement;
|
|
24
|
-
|
|
28
|
+
let message = argvArg.message;
|
|
29
|
+
if (
|
|
30
|
+
!registryInput ||
|
|
31
|
+
!oldPackageName ||
|
|
32
|
+
(newPackageName === undefined && message === undefined)
|
|
33
|
+
) {
|
|
25
34
|
if (!mode.interactive || argvArg.plan || mode.json)
|
|
26
|
-
throw new Error(
|
|
35
|
+
throw new Error(
|
|
36
|
+
"Specify --package, --registries, and --replacement or --message.",
|
|
37
|
+
);
|
|
27
38
|
const smartInteract = new plugins.smartinteract.SmartInteract([
|
|
28
39
|
{
|
|
29
40
|
name: `registryUrls`,
|
|
@@ -45,23 +56,37 @@ export const run = async (argvArg: any = {}) => {
|
|
|
45
56
|
},
|
|
46
57
|
{
|
|
47
58
|
name: `newPackageName`,
|
|
48
|
-
message: `Whats the name of the NEW package
|
|
59
|
+
message: `Whats the name of the NEW package? (leave empty if there is none)`,
|
|
49
60
|
type: `input`,
|
|
50
61
|
default: ``,
|
|
51
|
-
validate: (
|
|
52
|
-
return
|
|
62
|
+
validate: () => {
|
|
63
|
+
return !process.env.CI;
|
|
53
64
|
},
|
|
54
65
|
},
|
|
55
66
|
]);
|
|
56
67
|
const answerBucket = await smartInteract.runQueue();
|
|
57
68
|
registryInput = answerBucket.getAnswerFor("registryUrls");
|
|
58
69
|
oldPackageName = answerBucket.getAnswerFor("oldPackageName");
|
|
59
|
-
|
|
70
|
+
const newPackageAnswer = answerBucket.getAnswerFor("newPackageName");
|
|
71
|
+
newPackageName = newPackageAnswer === "" ? undefined : newPackageAnswer;
|
|
72
|
+
if (newPackageName === undefined && message === undefined) {
|
|
73
|
+
const messageAnswer = await smartInteract.askQuestion({
|
|
74
|
+
name: `message`,
|
|
75
|
+
message: `What deprecation message guides users of the OLD package?`,
|
|
76
|
+
type: `input`,
|
|
77
|
+
default: ``,
|
|
78
|
+
validate: (stringInput) => {
|
|
79
|
+
return stringInput !== "" && !process.env.CI;
|
|
80
|
+
},
|
|
81
|
+
});
|
|
82
|
+
message = messageAnswer.value;
|
|
83
|
+
}
|
|
60
84
|
}
|
|
61
85
|
if (
|
|
62
86
|
typeof registryInput !== "string" ||
|
|
63
87
|
typeof oldPackageName !== "string" ||
|
|
64
|
-
typeof newPackageName !== "string"
|
|
88
|
+
(newPackageName !== undefined && typeof newPackageName !== "string") ||
|
|
89
|
+
(message !== undefined && typeof message !== "string")
|
|
65
90
|
) {
|
|
66
91
|
throw new Error("Deprecation arguments must be strings.");
|
|
67
92
|
}
|
|
@@ -69,20 +94,20 @@ export const run = async (argvArg: any = {}) => {
|
|
|
69
94
|
packageName: oldPackageName,
|
|
70
95
|
replacement: newPackageName,
|
|
71
96
|
registries: registryInput.split(",").map((value) => value.trim()),
|
|
72
|
-
message
|
|
97
|
+
message,
|
|
73
98
|
});
|
|
74
99
|
if (mode.json) {
|
|
75
100
|
printJson({ ok: true, plan });
|
|
76
101
|
return;
|
|
77
102
|
}
|
|
78
|
-
console.log(
|
|
103
|
+
for (const line of describeDeprecationPlan(plan)) console.log(line);
|
|
79
104
|
if (argvArg.plan) return;
|
|
80
105
|
if (!mode.yes) {
|
|
81
106
|
if (!mode.interactive)
|
|
82
107
|
throw new Error("Deprecation requires -y or interactive confirmation.");
|
|
83
108
|
if (
|
|
84
109
|
!(await plugins.smartinteract.SmartInteract.getCliConfirmation(
|
|
85
|
-
`Deprecate every version of ${
|
|
110
|
+
`Deprecate every version of ${plan.packageName}?`,
|
|
86
111
|
false,
|
|
87
112
|
))
|
|
88
113
|
)
|
|
@@ -90,7 +115,9 @@ export const run = async (argvArg: any = {}) => {
|
|
|
90
115
|
}
|
|
91
116
|
logger.log(
|
|
92
117
|
"info",
|
|
93
|
-
|
|
118
|
+
plan.replacement === null
|
|
119
|
+
? `Deprecating package ${plan.packageName} without a replacement`
|
|
120
|
+
: `Deprecating package ${plan.packageName} in favour of ${plan.replacement}`,
|
|
94
121
|
);
|
|
95
122
|
const smartshellInstance = new plugins.smartshell.Smartshell({
|
|
96
123
|
executor: "bash",
|