@arcgis/codemod 6.0.0-next.4 → 6.0.0-next.41
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/chunks/aggregateUsages.js +351 -0
- package/dist/chunks/auditDefinitions.js +173 -0
- package/dist/chunks/auditUsages.js +1246 -0
- package/dist/chunks/classification.js +168 -126
- package/dist/chunks/cli.js +387 -231
- package/dist/chunks/codemod5.js +0 -1
- package/dist/chunks/codemod7.js +1214 -1232
- package/dist/chunks/componentAudit.js +272 -0
- package/dist/chunks/format.js +140 -112
- package/dist/chunks/legacyCompatibility.js +210 -0
- package/dist/chunks/log.js +21 -7
- package/dist/chunks/sync.js +148 -142
- package/dist/chunks/syncMarkdown.js +42 -0
- package/dist/chunks/useProjectInstance.js +27 -24
- package/package.json +10 -7
- package/dist/chunks/hardcodedBehavior.js +0 -63
- package/dist/chunks/index.js +0 -459
- package/dist/chunks/index2.js +0 -160
package/dist/chunks/cli.js
CHANGED
|
@@ -1,21 +1,22 @@
|
|
|
1
1
|
import { log as g } from "@arcgis/toolkit/log";
|
|
2
|
-
import { Command as
|
|
3
|
-
import {
|
|
4
|
-
import { path as
|
|
5
|
-
import { asyncFindPath as
|
|
2
|
+
import { Command as ce, InvalidArgumentError as A } from "@commander-js/extra-typings";
|
|
3
|
+
import { realpath as X, stat as Y } from "node:fs/promises";
|
|
4
|
+
import { path as r, getCwd as W, toPosixPathSeparators as H } from "@arcgis/node-toolkit/path";
|
|
5
|
+
import { asyncFindPath as T, existsAsync as J } from "@arcgis/node-toolkit/file";
|
|
6
6
|
import "ts-morph";
|
|
7
|
-
import
|
|
8
|
-
import { asyncRetrievePackageJson as
|
|
9
|
-
import { glob as
|
|
10
|
-
import { gitIgnoreFileToGlobs as
|
|
11
|
-
import { identity as
|
|
12
|
-
import { styleText as
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
7
|
+
import d from "typescript";
|
|
8
|
+
import { asyncRetrievePackageJson as de } from "@arcgis/node-toolkit/packageJson";
|
|
9
|
+
import { glob as Z } from "tinyglobby";
|
|
10
|
+
import { gitIgnoreFileToGlobs as ee } from "@arcgis/node-toolkit/glob";
|
|
11
|
+
import { identity as q } from "@arcgis/toolkit/function";
|
|
12
|
+
import { styleText as M } from "node:util";
|
|
13
|
+
import { randomUUID as le } from "node:crypto";
|
|
14
|
+
const pe = (t, e, o) => {
|
|
15
|
+
const s = t[e];
|
|
16
|
+
return s ? typeof s == "function" ? s() : Promise.resolve(s) : new Promise((n, l) => {
|
|
17
|
+
(typeof queueMicrotask == "function" ? queueMicrotask : setTimeout)(l.bind(null, /* @__PURE__ */ new Error("Unknown variable dynamic import: " + e + (e.split("/").length !== o ? ". Note that variables only represent file names one level deep." : ""))));
|
|
17
18
|
});
|
|
18
|
-
},
|
|
19
|
+
}, Me = {
|
|
19
20
|
allowImportingTsExtensions: !0,
|
|
20
21
|
allowJs: !0,
|
|
21
22
|
allowArbitraryExtensions: !0,
|
|
@@ -25,81 +26,93 @@ const X = (t, e, s) => {
|
|
|
25
26
|
forceConsistentCasingInFileNames: !1,
|
|
26
27
|
isolatedModules: !1,
|
|
27
28
|
isolatedDeclarations: !1,
|
|
28
|
-
jsx:
|
|
29
|
+
jsx: d.JsxEmit.Preserve,
|
|
29
30
|
lib: ["lib.esnext.d.ts", "lib.dom.d.ts"],
|
|
30
|
-
module:
|
|
31
|
-
moduleResolution:
|
|
32
|
-
moduleDetection:
|
|
31
|
+
module: d.ModuleKind.ESNext,
|
|
32
|
+
moduleResolution: d.ModuleResolutionKind.Bundler,
|
|
33
|
+
moduleDetection: d.ModuleDetectionKind.Auto,
|
|
33
34
|
strict: !1,
|
|
34
|
-
target:
|
|
35
|
+
target: d.ScriptTarget.ESNext,
|
|
35
36
|
resolveJsonModule: !0,
|
|
36
37
|
esModuleInterop: !0
|
|
37
|
-
},
|
|
38
|
+
}, S = {
|
|
38
39
|
codemod: void 0,
|
|
39
40
|
codemodName: void 0,
|
|
40
41
|
projectsData: void 0,
|
|
41
42
|
project: void 0
|
|
42
|
-
}
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
43
|
+
}, te = [
|
|
44
|
+
// Hardcoded ignores in TypeScript
|
|
45
|
+
"**/node_modules/**",
|
|
46
|
+
"**/bower_components/**",
|
|
47
|
+
"**/jspm_packages/**",
|
|
48
|
+
// Default build output folder in bundlers
|
|
49
|
+
"**/dist/**"
|
|
50
|
+
];
|
|
51
|
+
async function ue() {
|
|
52
|
+
const { ignorePatterns: t, globRoot: e, hasIgnoreFiles: o } = await me(), s = await ge(e);
|
|
53
|
+
return t.push(...s.ignorePatterns), !o && !s.hasIgnoreFiles && t.push(...te), { ignorePatterns: t, globRoot: e };
|
|
46
54
|
}
|
|
47
|
-
async function
|
|
48
|
-
const t = []
|
|
49
|
-
let
|
|
55
|
+
async function me() {
|
|
56
|
+
const t = [];
|
|
57
|
+
let e = !1;
|
|
58
|
+
const o = await T(".git"), s = o === void 0 ? void 0 : r.dirname(o);
|
|
59
|
+
let n, l = W(), f = r.dirname(l);
|
|
50
60
|
do {
|
|
51
|
-
if (
|
|
61
|
+
if (n = f, s !== void 0 && n !== s && !n.startsWith(`${s}/`))
|
|
52
62
|
break;
|
|
53
|
-
const
|
|
54
|
-
if (await
|
|
55
|
-
|
|
56
|
-
const
|
|
57
|
-
for (const
|
|
58
|
-
const
|
|
59
|
-
let
|
|
60
|
-
const
|
|
61
|
-
for (let
|
|
62
|
-
const
|
|
63
|
-
if (!(
|
|
64
|
-
|
|
63
|
+
const u = r.join(n, ".gitignore");
|
|
64
|
+
if (await J(u)) {
|
|
65
|
+
e = !0, l = r.dirname(u);
|
|
66
|
+
const h = r.relative(l, W()).split("/"), N = ee(u);
|
|
67
|
+
for (const b of N) {
|
|
68
|
+
const w = b.startsWith("!") ? b.slice(1) : b, y = w.search(/[*?[]/u), P = y === -1 ? w : w.slice(0, y), m = P.split("/"), I = y !== -1 && !P.endsWith("/");
|
|
69
|
+
let v = !0;
|
|
70
|
+
const D = Math.min(h.length, m.length);
|
|
71
|
+
for (let i = 0; i < D; i++) {
|
|
72
|
+
const a = m[i];
|
|
73
|
+
if (!(I && i === m.length - 1 ? h[i].startsWith(a) : h[i] === a) && a !== "") {
|
|
74
|
+
v = !1;
|
|
65
75
|
break;
|
|
66
76
|
}
|
|
67
77
|
}
|
|
68
|
-
|
|
78
|
+
v && (b.startsWith("!") || t.push(b));
|
|
69
79
|
}
|
|
70
80
|
}
|
|
71
|
-
|
|
72
|
-
} while (
|
|
73
|
-
return { ignorePatterns: t, globRoot:
|
|
81
|
+
f = r.dirname(n);
|
|
82
|
+
} while (f !== n);
|
|
83
|
+
return { ignorePatterns: t, globRoot: l, hasIgnoreFiles: e };
|
|
74
84
|
}
|
|
75
|
-
async function
|
|
76
|
-
|
|
77
|
-
cwd:
|
|
85
|
+
async function ge(t) {
|
|
86
|
+
const e = await Z("**/.gitignore", {
|
|
87
|
+
cwd: W(),
|
|
78
88
|
// Gitignore files are unlikely to be symbolic links
|
|
79
89
|
followSymbolicLinks: !1,
|
|
80
90
|
// Don't look for ignore files in these places for speed:
|
|
81
|
-
ignore:
|
|
82
|
-
// Hardcoded ignores in TypeScript
|
|
83
|
-
"**/node_modules/**",
|
|
84
|
-
"**/bower_components/**",
|
|
85
|
-
"**/jspm_packages/**",
|
|
86
|
-
// Default build output folder in bundlers
|
|
87
|
-
"**/dist/**"
|
|
88
|
-
],
|
|
91
|
+
ignore: te,
|
|
89
92
|
// Not applicable for our glob pattern
|
|
90
93
|
expandDirectories: !1
|
|
91
|
-
})).flatMap((s) => {
|
|
92
|
-
const o = i.relative(t, i.dirname(s)), r = H(s), l = [];
|
|
93
|
-
for (const w of r)
|
|
94
|
-
w.startsWith("!") || l.push(i.join(o, w));
|
|
95
|
-
return l;
|
|
96
94
|
});
|
|
95
|
+
return { ignorePatterns: e.flatMap((s) => {
|
|
96
|
+
const n = r.relative(t, r.dirname(s)), l = ee(s), f = [];
|
|
97
|
+
for (const u of l)
|
|
98
|
+
u.startsWith("!") || f.push(r.join(n, u));
|
|
99
|
+
return f;
|
|
100
|
+
}), hasIgnoreFiles: e.length > 0 };
|
|
97
101
|
}
|
|
98
|
-
const
|
|
99
|
-
async function
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
102
|
+
const oe = ["js", "jsx", "mjs", "cjs"], se = ["ts", "tsx", "mts", "cts"], fe = /* @__PURE__ */ new Set([...oe, ...se]), he = ["json"], be = ["css", "scss", "sass", "html"];
|
|
103
|
+
async function we({
|
|
104
|
+
targetFilePath: t,
|
|
105
|
+
includeComponentFiles: e = !1,
|
|
106
|
+
includeTsConfigFiles: o = !1
|
|
107
|
+
} = {}) {
|
|
108
|
+
const s = await ue(), l = `**/*.{${[
|
|
109
|
+
...oe,
|
|
110
|
+
...se,
|
|
111
|
+
...he,
|
|
112
|
+
...e ? be : []
|
|
113
|
+
].join(",")}}`, f = r.join(process.cwd(), l), u = r.join(r.resolve(s.globRoot), "/"), U = (await Z(f, {
|
|
114
|
+
cwd: s.globRoot,
|
|
115
|
+
ignore: s.ignorePatterns,
|
|
103
116
|
// The files we are looking for are unlikely to be symbolic links
|
|
104
117
|
followSymbolicLinks: !1,
|
|
105
118
|
// Not applicable for our glob pattern
|
|
@@ -108,136 +121,165 @@ async function ne(t) {
|
|
|
108
121
|
// default behavior). If any tsconfig.json explicitly includes such files,
|
|
109
122
|
// they will still be codemodded.
|
|
110
123
|
})).filter(
|
|
111
|
-
(
|
|
124
|
+
(i) => i.endsWith(".json") || t === void 0 || u + i === t
|
|
112
125
|
);
|
|
113
|
-
let
|
|
114
|
-
|
|
115
|
-
const
|
|
116
|
-
for (const
|
|
117
|
-
const
|
|
118
|
-
if (
|
|
119
|
-
const
|
|
120
|
-
|
|
126
|
+
let h = r.relative(s.globRoot, process.cwd());
|
|
127
|
+
h !== "" && (h += "/");
|
|
128
|
+
const N = u.length + h.length, b = [], w = [], y = /* @__PURE__ */ new Set();
|
|
129
|
+
for (const i of U) {
|
|
130
|
+
const a = u + i;
|
|
131
|
+
if (i.endsWith(".json")) {
|
|
132
|
+
const c = r.basename(i);
|
|
133
|
+
c === "package.json" ? b.push(a) : (c.startsWith("tsconfig.") || c.startsWith("jsconfig.")) && w.push(a);
|
|
121
134
|
} else {
|
|
122
|
-
const
|
|
123
|
-
|
|
135
|
+
const c = i.slice(h.length);
|
|
136
|
+
y.add(c);
|
|
124
137
|
}
|
|
125
138
|
}
|
|
126
|
-
let
|
|
127
|
-
|
|
128
|
-
const
|
|
129
|
-
if (
|
|
130
|
-
return
|
|
131
|
-
const
|
|
132
|
-
return
|
|
139
|
+
let P = await T("tsconfig.json", r.dirname(process.cwd()));
|
|
140
|
+
P !== void 0 && (P = H(P), w.push(P)), w.sort((i, a) => {
|
|
141
|
+
const c = a.split("/").length - i.split("/").length;
|
|
142
|
+
if (c !== 0)
|
|
143
|
+
return c;
|
|
144
|
+
const p = r.basename(i), x = r.basename(a);
|
|
145
|
+
return p === x ? 0 : p.endsWith("tsconfig.json") ? -1 : x.endsWith("tsconfig.json") ? 1 : p.endsWith("tsconfig.build.json") ? -1 : x.endsWith("tsconfig.build.json") ? 1 : p.localeCompare(x);
|
|
133
146
|
});
|
|
134
|
-
let
|
|
135
|
-
|
|
136
|
-
const
|
|
147
|
+
let m = await T("package.json");
|
|
148
|
+
m !== void 0 && (m = H(m));
|
|
149
|
+
const I = [
|
|
150
|
+
.../* @__PURE__ */ new Set([...b, ...m === void 0 ? [] : [m]])
|
|
151
|
+
].sort((i, a) => a.length - i.length), v = [], D = /* @__PURE__ */ new Set();
|
|
137
152
|
if (await Promise.all(
|
|
138
|
-
|
|
139
|
-
const
|
|
140
|
-
if (
|
|
153
|
+
w.map(async (i) => {
|
|
154
|
+
const a = r.relative(process.cwd(), i), c = d.readConfigFile(i, d.sys.readFile);
|
|
155
|
+
if (c.error !== void 0) {
|
|
141
156
|
g(
|
|
142
157
|
"error",
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
getCanonicalFileName:
|
|
146
|
-
getCurrentDirectory:
|
|
147
|
-
getNewLine: () =>
|
|
158
|
+
a,
|
|
159
|
+
d.formatDiagnosticsWithColorAndContext([c.error], {
|
|
160
|
+
getCanonicalFileName: q,
|
|
161
|
+
getCurrentDirectory: d.sys.getCurrentDirectory,
|
|
162
|
+
getNewLine: () => d.sys.newLine
|
|
148
163
|
})
|
|
149
164
|
);
|
|
150
165
|
return;
|
|
151
166
|
}
|
|
152
|
-
const
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
167
|
+
const p = d.parseJsonConfigFileContent(
|
|
168
|
+
c.config,
|
|
169
|
+
d.sys,
|
|
170
|
+
r.dirname(i),
|
|
156
171
|
void 0,
|
|
157
|
-
|
|
158
|
-
),
|
|
159
|
-
|
|
172
|
+
i
|
|
173
|
+
), x = 18003;
|
|
174
|
+
p.errors.filter((k) => k.code !== x).length > 0 && g(
|
|
160
175
|
"warn",
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
getCanonicalFileName:
|
|
164
|
-
getCurrentDirectory:
|
|
165
|
-
getNewLine: () =>
|
|
176
|
+
a,
|
|
177
|
+
d.formatDiagnosticsWithColorAndContext(p.errors, {
|
|
178
|
+
getCanonicalFileName: q,
|
|
179
|
+
getCurrentDirectory: d.sys.getCurrentDirectory,
|
|
180
|
+
getNewLine: () => d.sys.newLine
|
|
166
181
|
})
|
|
167
182
|
);
|
|
168
|
-
const
|
|
169
|
-
if (t !== void 0 &&
|
|
183
|
+
const L = i === P, K = p.fileNames.filter((k) => {
|
|
184
|
+
if (t !== void 0 && k !== t)
|
|
170
185
|
return !1;
|
|
171
|
-
const
|
|
172
|
-
return
|
|
173
|
-
})
|
|
174
|
-
|
|
186
|
+
const E = k.slice(N);
|
|
187
|
+
return y.delete(E) ? (D.add(E), !0) : D.has(E) || E.endsWith(".json") || k.includes("node_modules") || L ? !1 : d.sys.fileExists(k);
|
|
188
|
+
}), re = (
|
|
189
|
+
// Scanning tsconfig.json
|
|
190
|
+
o && // Don't include tsconfig outside the scanned scope
|
|
191
|
+
!L && // If filtering by file, ensure this tsconfig is the one being targeted
|
|
192
|
+
(t === void 0 || t === i)
|
|
193
|
+
);
|
|
194
|
+
if (K.length === 0 && !re)
|
|
175
195
|
return;
|
|
176
|
-
const
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
break;
|
|
184
|
-
}
|
|
185
|
-
if (j === e.globRoot)
|
|
186
|
-
break;
|
|
187
|
-
j = i.dirname(j);
|
|
188
|
-
}
|
|
189
|
-
const L = k === void 0 ? void 0 : { filePath: k, contents: await $(i.dirname(k)) }, V = {
|
|
190
|
-
typeScriptConfig: {
|
|
191
|
-
filePath: n,
|
|
192
|
-
compilerOptions: f.options
|
|
193
|
-
},
|
|
194
|
-
packageJson: L,
|
|
195
|
-
logName: D("blue", L?.contents?.name ?? O),
|
|
196
|
-
cwd: O,
|
|
197
|
-
filePaths: F
|
|
198
|
-
};
|
|
199
|
-
h.push(V);
|
|
196
|
+
const _ = r.dirname(i), ae = z(_, I) ?? m;
|
|
197
|
+
v.push(
|
|
198
|
+
await B(K, _, ae, {
|
|
199
|
+
filePath: i,
|
|
200
|
+
compilerOptions: p.options
|
|
201
|
+
})
|
|
202
|
+
);
|
|
200
203
|
})
|
|
201
|
-
),
|
|
202
|
-
const
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
packageJson: n,
|
|
209
|
-
cwd: process.cwd(),
|
|
210
|
-
logName: D("blue", n?.contents?.name ?? process.cwd()),
|
|
211
|
-
filePaths: Array.from(v).map((d) => i.join(process.cwd(), d))
|
|
212
|
-
});
|
|
204
|
+
), y.size > 0) {
|
|
205
|
+
const i = [...y].map((c) => r.join(process.cwd(), c)), a = Map.groupBy(i, (c) => z(c, I));
|
|
206
|
+
v.push(
|
|
207
|
+
...await Promise.all(
|
|
208
|
+
[...a].map(async ([c, p]) => await B(p, process.cwd(), c))
|
|
209
|
+
)
|
|
210
|
+
);
|
|
213
211
|
}
|
|
214
|
-
return
|
|
212
|
+
return v.sort(
|
|
213
|
+
(i, a) => i.cwd.localeCompare(a.cwd) || (i.typeScriptConfig?.filePath ?? "").localeCompare(a.typeScriptConfig?.filePath ?? "") || (i.packageJson?.filePath ?? "").localeCompare(a.packageJson?.filePath ?? "")
|
|
214
|
+
), S.projectsData = v, v;
|
|
215
|
+
}
|
|
216
|
+
function Ue(t) {
|
|
217
|
+
const e = r.extname(t).slice(1);
|
|
218
|
+
return fe.has(e);
|
|
219
|
+
}
|
|
220
|
+
function z(t, e) {
|
|
221
|
+
return e.find((o) => {
|
|
222
|
+
const s = r.dirname(o);
|
|
223
|
+
return t === s || t.startsWith(`${s}/`);
|
|
224
|
+
});
|
|
225
|
+
}
|
|
226
|
+
async function B(t, e, o, s) {
|
|
227
|
+
const n = o === void 0 ? void 0 : {
|
|
228
|
+
filePath: o,
|
|
229
|
+
contents: await de(r.dirname(o))
|
|
230
|
+
};
|
|
231
|
+
return {
|
|
232
|
+
typeScriptConfig: s,
|
|
233
|
+
packageJson: n,
|
|
234
|
+
cwd: e,
|
|
235
|
+
filePaths: t.sort(),
|
|
236
|
+
logName: M("blue", n?.contents.name ?? e)
|
|
237
|
+
};
|
|
215
238
|
}
|
|
216
|
-
function
|
|
217
|
-
|
|
239
|
+
function ye() {
|
|
240
|
+
S.codemod.meta.needsFooter && (S.codemod.meta.needsFooter = !1, process.exitCode !== void 0 && process.exitCode !== 0 ? g(
|
|
218
241
|
"warn",
|
|
219
|
-
|
|
242
|
+
S.codemodName,
|
|
220
243
|
"One or more exceptions occurred during the codemod run. Please review the output above."
|
|
221
244
|
) : g(
|
|
222
245
|
"info",
|
|
223
|
-
|
|
224
|
-
`${
|
|
246
|
+
S.codemodName,
|
|
247
|
+
`${M("green", "Codemod completed successfully.")} Recommended next steps:
|
|
225
248
|
- Review the codemod changes.
|
|
226
249
|
- If your project uses ESLint, run ESLint autofix on the changed files.
|
|
227
250
|
- If your project uses Prettier, run Prettier on the changed files.
|
|
228
251
|
- If your project uses TypeScript, run type checking to ensure there are no type errors.`
|
|
229
252
|
));
|
|
230
253
|
}
|
|
231
|
-
async function
|
|
232
|
-
|
|
233
|
-
const
|
|
234
|
-
|
|
235
|
-
|
|
254
|
+
async function Pe(t, e, o) {
|
|
255
|
+
S.codemod = t, S.codemodName = e;
|
|
256
|
+
const s = await we({
|
|
257
|
+
targetFilePath: o,
|
|
258
|
+
includeComponentFiles: t.meta.includeComponentFiles,
|
|
259
|
+
includeTsConfigFiles: t.meta.includeTsConfigFiles
|
|
260
|
+
});
|
|
261
|
+
if (s.length === 0) {
|
|
262
|
+
const n = t.meta.includeComponentFiles ? "source files or component manifests" : ".js or .ts files";
|
|
263
|
+
g("error", e, `Failed to find any ${n} in ${process.cwd()} to run the codemod on.`), process.exitCode = 1;
|
|
236
264
|
return;
|
|
237
265
|
}
|
|
238
|
-
await t.run(
|
|
266
|
+
await t.run(s), ye();
|
|
239
267
|
}
|
|
240
|
-
|
|
268
|
+
async function ve(t) {
|
|
269
|
+
const e = r.resolve(t);
|
|
270
|
+
await J(e) || (g("error", "@arcgis/codemod", `Failed to find the target path: ${t}`), process.exit(1));
|
|
271
|
+
const o = await X(e), s = (await Y(o)).isFile();
|
|
272
|
+
return process.chdir(s ? r.dirname(o) : o), s ? o : void 0;
|
|
273
|
+
}
|
|
274
|
+
const R = {
|
|
275
|
+
outdatedDependencies: {
|
|
276
|
+
label: "Outdated SDK dependencies - highest priority",
|
|
277
|
+
description: "Out of date SDK packages hide APIs that may be deprecated in the most recent version."
|
|
278
|
+
},
|
|
279
|
+
mismatchedDependencies: {
|
|
280
|
+
label: "Mismatched SDK dependency versions",
|
|
281
|
+
description: "Web GIS SDK packages within the same package.json must use the same exact version - that is the only tested combination."
|
|
282
|
+
},
|
|
241
283
|
coreViews: {
|
|
242
284
|
label: "@arcgis/core views and UI - highest priority",
|
|
243
285
|
description: "Use map components and slots instead. Directly constructed views will no longer include .ui (like zoom buttons) in 6.0."
|
|
@@ -252,16 +294,20 @@ const W = {
|
|
|
252
294
|
},
|
|
253
295
|
codemod: {
|
|
254
296
|
label: "Codemod available - quick fix",
|
|
255
|
-
description: "A codemod is available to automate these migrations."
|
|
297
|
+
description: "A codemod is available to automate these migrations. See https://webgis.esri.com/references/codemod/introduction."
|
|
256
298
|
},
|
|
257
299
|
calcite: {
|
|
258
|
-
label: "Calcite
|
|
300
|
+
label: "Calcite design system",
|
|
259
301
|
description: "This does not include visual breaking changes. See complete list in https://confluencewikidev.esri.com/spaces/Calcite/pages/464553094/Calcite+6.0+-+Breaking+Change+Release+February"
|
|
260
302
|
},
|
|
261
303
|
arcgisCore: { label: "@arcgis/core" },
|
|
262
304
|
arcgisComponents: { label: "WebGIS SDK components" },
|
|
263
305
|
arcgisSupport: { label: "WebGIS SDK support packages" },
|
|
264
306
|
otherEsri: { label: "Other Esri and ArcGIS packages" },
|
|
307
|
+
outdatedTypeScriptConfig: {
|
|
308
|
+
label: "Outdated TypeScript configuration",
|
|
309
|
+
description: "Legacy compiler settings and targets below the Web GIS SDK baseline are not supported in the ArcGIS ecosystem. They may cause incompatibilities with newer packages."
|
|
310
|
+
},
|
|
265
311
|
coreIntl: {
|
|
266
312
|
label: "@arcgis/core translation utils",
|
|
267
313
|
description: "Use https://webgis.esri.com/references/toolkit/intl instead."
|
|
@@ -270,42 +316,88 @@ const W = {
|
|
|
270
316
|
label: "Non-Esri packages and web platform - low priority",
|
|
271
317
|
description: "These deprecations do not block updating Esri packages and are not tied to an ArcGIS release."
|
|
272
318
|
}
|
|
273
|
-
},
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
319
|
+
}, $ = "https://webgis.esri.com/api/deprecations";
|
|
320
|
+
async function Le(t, e) {
|
|
321
|
+
const o = le();
|
|
322
|
+
process.stderr.write(`Submitting deprecation report (${o}).
|
|
323
|
+
`);
|
|
324
|
+
let s;
|
|
325
|
+
try {
|
|
326
|
+
s = await fetch(e, {
|
|
327
|
+
method: "POST",
|
|
328
|
+
headers: { "Content-Type": "application/json" },
|
|
329
|
+
body: JSON.stringify({
|
|
330
|
+
submissionId: o,
|
|
331
|
+
report: t
|
|
332
|
+
}),
|
|
333
|
+
signal: AbortSignal.timeout(12e4),
|
|
334
|
+
redirect: "error"
|
|
335
|
+
});
|
|
336
|
+
} catch (l) {
|
|
337
|
+
throw new Error(`Deprecation reporting failed; check submission ${o} before retrying.`, {
|
|
338
|
+
cause: l
|
|
339
|
+
});
|
|
340
|
+
}
|
|
341
|
+
if (!s.ok)
|
|
342
|
+
throw new Error(`Deprecation reporting failed: HTTP ${s.status}. Submission ID: ${o}`);
|
|
343
|
+
const n = await s.json();
|
|
344
|
+
if (typeof n != "object" || n === null || !("submissionId" in n) || n.submissionId !== o)
|
|
345
|
+
throw new Error(`Invalid collector acknowledgement. Check submission ${o} before retrying.`);
|
|
346
|
+
process.stderr.write(`Deprecation report submitted to ${e} (${o}).
|
|
347
|
+
`);
|
|
348
|
+
}
|
|
349
|
+
const Se = /(?:esri|arcgis)/iu, xe = ["/.astro/"], G = ["all", "repositories", "apis", "unused-apis"], Ke = {
|
|
350
|
+
usages: "Refactor-out deprecated API usages",
|
|
351
|
+
definitions: "Remove deprecated APIs in next breaking changes release"
|
|
352
|
+
}, _e = {
|
|
353
|
+
usages: "The following deprecated APIs are used in files owned by assigned CODEOWNERS. Refactor them before the APIs are removed.",
|
|
354
|
+
definitions: "The following deprecated APIs are owned by assigned CODEOWNERS. Remove them in the next breaking changes release."
|
|
355
|
+
}, He = "This issue is autogenerated and updated regularly based on remaining items. Feel free to add comments and labels, update assignees, set milestone, or create sub-issues. Close it once completed. A new issue will be created if new findings are detected.", qe = "Task", ze = "deprecations sync-issues";
|
|
356
|
+
function Be(t) {
|
|
357
|
+
return Se.test(t);
|
|
358
|
+
}
|
|
359
|
+
function Ve(t) {
|
|
360
|
+
return xe.some((e) => `/${t}`.includes(e));
|
|
361
|
+
}
|
|
362
|
+
const F = new ce(), O = "See https://www.npmjs.com/package/@arcgis/codemod for a list of available public codemods. [Esri internal] Non-public codemods are documented at https://webgis.esri.com/references/codemod/introduction.";
|
|
363
|
+
F.name("@arcgis/codemod").description("Codemod for migrating or refactoring usages of ArcGIS Maps SDK for JavaScript");
|
|
364
|
+
F.command("run").description("Run a single codemod").argument("<codemodName>", `Name of the codemod. ${O}`).argument("[path]", "Directory to transform", process.cwd()).showHelpAfterError(O).action(async (t, e) => {
|
|
365
|
+
const o = await ve(e);
|
|
366
|
+
let s;
|
|
278
367
|
try {
|
|
279
|
-
|
|
280
|
-
} catch (
|
|
368
|
+
s = await pe(/* @__PURE__ */ Object.assign({ "./codemods/api-extractor-strict-mode/codemod.ts": () => import("./codemod.js"), "./codemods/geometry-operator-renames/codemod.ts": () => import("./codemod2.js"), "./codemods/lumina-component-extras-improvements/codemod.ts": () => import("./codemod3.js"), "./codemods/lumina-toolkit/codemod.ts": () => import("./codemod4.js"), "./codemods/node-toolkit/codemod.ts": () => import("./codemod5.js"), "./codemods/normalize-calcite-icon-names/codemod.ts": () => import("./codemod6.js"), "./codemods/refactor-out-esri-namespace/codemod.ts": () => import("./codemod7.js"), "./codemods/toolkit-5.2-renames/codemod.ts": () => import("./codemod8.js") }), `./codemods/${t}/codemod.ts`, 4);
|
|
369
|
+
} catch (n) {
|
|
281
370
|
if (
|
|
282
371
|
// direct Node execution
|
|
283
|
-
typeof
|
|
284
|
-
String(
|
|
372
|
+
typeof n == "object" && n !== null && "code" in n && n.code === "ERR_MODULE_NOT_FOUND" && "url" in n && typeof n.url == "string" && n.url.endsWith(`/${t}/codemod.ts`) || // Vite build execution
|
|
373
|
+
String(n).includes("Unknown variable dynamic import:")
|
|
285
374
|
) {
|
|
286
|
-
g("error", "@arcgis/codemod", `Can't find codemod by name "${t}"
|
|
375
|
+
g("error", "@arcgis/codemod", `Can't find codemod by name "${t}". ${O}`), process.exitCode = 1;
|
|
287
376
|
return;
|
|
288
377
|
} else
|
|
289
|
-
throw
|
|
378
|
+
throw n;
|
|
290
379
|
}
|
|
291
|
-
if (typeof
|
|
292
|
-
g("error", "@arcgis/codemod", `Can't find codemod by name "${t}"
|
|
380
|
+
if (typeof s.codemod != "object" || s.codemod === null) {
|
|
381
|
+
g("error", "@arcgis/codemod", `Can't find codemod by name "${t}". ${O}`), process.exitCode = 1;
|
|
293
382
|
return;
|
|
294
383
|
}
|
|
295
|
-
await
|
|
384
|
+
await Pe(s.codemod, M("blue", t), o);
|
|
296
385
|
});
|
|
297
|
-
const
|
|
386
|
+
const C = F.command("deprecations").description(
|
|
298
387
|
`Audit and report deprecated APIs.
|
|
299
388
|
|
|
300
389
|
Documentation: https://webgis.esri.com/references/codemod/deprecations`
|
|
301
|
-
);
|
|
302
|
-
|
|
390
|
+
), ie = "Globs to exclude from the scan (relative to cwd). Example: deprecated-package/**. Can provide --exclude multiple times. Use this sparingly. Use cases: deprecated packages, unmaintained test apps";
|
|
391
|
+
C.command("audit-usages").description(
|
|
303
392
|
"Report deprecated API usages. Documentation: https://webgis.esri.com/references/codemod/deprecations#audit-usages"
|
|
304
|
-
).argument("[path]", "Directory to audit", process.cwd()).option("--esri-only", "Only report usages of deprecated APIs from Esri and ArcGIS packages", !1).option(
|
|
393
|
+
).argument("[path]", "Directory to audit", process.cwd()).option("--exclude <glob>", ie, j, []).option("--esri-only", "Only report usages of deprecated APIs from Esri and ArcGIS packages", !1).option(
|
|
305
394
|
"--category <category>",
|
|
306
|
-
`Only report usages in a category. Available categories: ${Object.keys(
|
|
307
|
-
|
|
395
|
+
`Only report usages in a category. Available categories: ${Object.keys(R).join(", ")}`,
|
|
396
|
+
ne
|
|
308
397
|
).option("--package <package-name>", "Only report usages of deprecated APIs from this package").option(
|
|
398
|
+
"--report [url]",
|
|
399
|
+
`Submit a complete repository scan to the WebGIS collector (default: ${$})`
|
|
400
|
+
).option(
|
|
309
401
|
"--json",
|
|
310
402
|
"Output results as JSON. Example: npx @arcgis/codemod deprecations audit-usages --json > usages.json",
|
|
311
403
|
!1
|
|
@@ -314,29 +406,79 @@ J.command("audit-usages").description(
|
|
|
314
406
|
"Output results as Markdown. Example: npx @arcgis/codemod deprecations audit-usages --md > usages.md",
|
|
315
407
|
!1
|
|
316
408
|
).action(async (t, e) => {
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
return;
|
|
320
|
-
}
|
|
321
|
-
const s = await G(t), { auditDeprecatedUsages: o } = await import("./index.js"), r = e.md ? "md" : e.json ? "json" : "text";
|
|
322
|
-
await o(s, {
|
|
323
|
-
esriOnly: e.esriOnly,
|
|
324
|
-
outputFormat: r,
|
|
325
|
-
category: e.category,
|
|
326
|
-
packageName: e.package
|
|
327
|
-
});
|
|
409
|
+
const { auditDeprecatedUsages: o } = await import("./auditUsages.js");
|
|
410
|
+
await o(t, e);
|
|
328
411
|
});
|
|
329
|
-
|
|
412
|
+
C.command("audit-definitions").description(
|
|
330
413
|
"Report exported APIs marked as deprecated. Documentation: https://webgis.esri.com/references/codemod/deprecations#audit-definitions"
|
|
331
|
-
).argument("[path]", "Directory to audit", process.cwd()).option(
|
|
414
|
+
).argument("[path]", "Directory to audit", process.cwd()).option("--exclude <glob>", ie, j, []).option(
|
|
332
415
|
"--json",
|
|
333
416
|
"Output results as JSON. Example: npx @arcgis/codemod deprecations audit-definitions --json > definitions.json",
|
|
334
417
|
!1
|
|
335
418
|
).action(async (t, e) => {
|
|
336
|
-
const
|
|
337
|
-
await o(
|
|
419
|
+
const { auditDeprecatedDefinitions: o } = await import("./auditDefinitions.js");
|
|
420
|
+
await o(t, e);
|
|
421
|
+
});
|
|
422
|
+
C.command("aggregate-usages").description(
|
|
423
|
+
"Aggregate audit-usages reports into repository summaries and an API usage tree. Documentation: https://webgis.esri.com/references/codemod/deprecations#analyze-the-ecosystem"
|
|
424
|
+
).argument("[reports...]", "Paths to audit-usages JSON files").option(
|
|
425
|
+
"--section <section>",
|
|
426
|
+
`Reports to include in the markdown report: ${G.join(", ")}`,
|
|
427
|
+
ke,
|
|
428
|
+
"all"
|
|
429
|
+
).option(
|
|
430
|
+
"--remote [url]",
|
|
431
|
+
`Read the latest stored audit per repository from the WebGIS collector (default: ${$})`
|
|
432
|
+
).option(
|
|
433
|
+
"--repository <repository>",
|
|
434
|
+
"Select a remote repository (host/owner/repo); repeat to select multiple",
|
|
435
|
+
j,
|
|
436
|
+
[]
|
|
437
|
+
).option("--branch <branch>", "Select remote audits from this branch").option("--since <date>", "Select remote audits on or after this ISO date", V).option("--until <date>", "Select remote audits on or before this ISO date", V).option(
|
|
438
|
+
"--definitions <report>",
|
|
439
|
+
"Compare an audit-definitions JSON report to list APIs with zero detected usages. Can be specified multiple times.",
|
|
440
|
+
j,
|
|
441
|
+
[]
|
|
442
|
+
).option("--esri-only", "Only report usages of deprecated APIs from Esri and ArcGIS packages", !1).option(
|
|
443
|
+
"--category <category>",
|
|
444
|
+
`Only report usages in a category. Available categories: ${Object.keys(R).join(", ")}`,
|
|
445
|
+
ne
|
|
446
|
+
).option("--package <package-name>", "Only report usages of deprecated APIs from this package").option("--json", "Output results as JSON", !1).option("--md", "Output results as Markdown", !1).action(async (t, e) => {
|
|
447
|
+
if (!t.length && !e.remote || !e.remote && (e.repository.length || e.branch || e.since || e.until))
|
|
448
|
+
throw new Error("Provide report files or --remote. Repository, branch, and date selection require --remote.");
|
|
449
|
+
if (e.since && e.until && e.since > e.until)
|
|
450
|
+
throw new Error("--since must not be after --until.");
|
|
451
|
+
if (e.json && e.md) {
|
|
452
|
+
g("error", "@arcgis/codemod", "The --json and --md options cannot be used together."), process.exitCode = 1;
|
|
453
|
+
return;
|
|
454
|
+
}
|
|
455
|
+
const { aggregateUsagesFromFiles: o } = await import("./aggregateUsages.js");
|
|
456
|
+
await o(
|
|
457
|
+
t,
|
|
458
|
+
e.md ? "md" : e.json ? "json" : "text",
|
|
459
|
+
{
|
|
460
|
+
esriOnly: e.esriOnly,
|
|
461
|
+
category: e.category,
|
|
462
|
+
packageName: e.package,
|
|
463
|
+
section: e.section
|
|
464
|
+
},
|
|
465
|
+
e.definitions,
|
|
466
|
+
e.remote ? {
|
|
467
|
+
url: e.remote === !0 ? $ : e.remote,
|
|
468
|
+
repositories: e.repository,
|
|
469
|
+
branch: e.branch,
|
|
470
|
+
since: e.since,
|
|
471
|
+
until: e.until
|
|
472
|
+
} : void 0
|
|
473
|
+
);
|
|
338
474
|
});
|
|
339
|
-
|
|
475
|
+
function ke(t) {
|
|
476
|
+
const e = G.find((o) => o === t);
|
|
477
|
+
if (e !== void 0)
|
|
478
|
+
return e;
|
|
479
|
+
throw new A(`Expected one of: ${G.join(", ")}.`);
|
|
480
|
+
}
|
|
481
|
+
C.command("sync-issues").description(
|
|
340
482
|
`Create or update deprecation audit issues. Requires authenticated gh cli.
|
|
341
483
|
|
|
342
484
|
Existing open issues are updated if out of date (matched by title and invisible comment inside).
|
|
@@ -344,51 +486,65 @@ Otherwise, a new issue is created. Assignees are determined based on CODEOWNERS.
|
|
|
344
486
|
).argument(
|
|
345
487
|
"<audit-json>",
|
|
346
488
|
"Path to the JSON file as output by the --json flag in the audit-usages or audit-definitions CLI"
|
|
347
|
-
).option("--dry-run", "Print planned issue and comment changes without changing GitHub", !1).option("--offset <number>", "Skip the first number of issue plans",
|
|
489
|
+
).option("--dry-run", "Print planned issue and comment changes without changing GitHub", !1).option("--close-resolved", "Close stale managed issues after a complete, unfiltered repository-root audit", !1).option("--offset <number>", "Skip the first number of issue plans", Q, 0).option("--limit <number>", "Process at most this many issue plans", Q).option(
|
|
348
490
|
"--label <label>",
|
|
349
|
-
"Label to add to
|
|
350
|
-
|
|
491
|
+
"Label to add to managed issues. Can be specified multiple times. .github/labeler.yml config is applied by default",
|
|
492
|
+
j,
|
|
351
493
|
[]
|
|
352
494
|
).action(async (t, e) => {
|
|
353
|
-
const
|
|
354
|
-
if (!await
|
|
495
|
+
const o = r.resolve(t);
|
|
496
|
+
if (!await J(o) || !(await Y(o)).isFile()) {
|
|
355
497
|
g("error", "@arcgis/codemod", `Failed to find the audit JSON file: ${t}`), process.exitCode = 1;
|
|
356
498
|
return;
|
|
357
499
|
}
|
|
358
|
-
const { syncDeprecationIssues:
|
|
359
|
-
await o
|
|
360
|
-
|
|
361
|
-
e.
|
|
362
|
-
|
|
363
|
-
e.limit,
|
|
364
|
-
e.label
|
|
365
|
-
);
|
|
500
|
+
const { syncDeprecationIssues: s } = await import("./sync.js");
|
|
501
|
+
await s(await X(o), e.dryRun, e.offset, e.limit, {
|
|
502
|
+
labels: e.label,
|
|
503
|
+
closeResolved: e.closeResolved
|
|
504
|
+
});
|
|
366
505
|
});
|
|
367
|
-
function
|
|
506
|
+
function V(t) {
|
|
507
|
+
const e = new Date(t);
|
|
508
|
+
if (!Number.isFinite(e.getTime()))
|
|
509
|
+
throw new A("Expected an ISO date.");
|
|
510
|
+
return e.toISOString();
|
|
511
|
+
}
|
|
512
|
+
function j(t, e) {
|
|
368
513
|
return [...e, t];
|
|
369
514
|
}
|
|
370
|
-
function
|
|
515
|
+
function Q(t) {
|
|
371
516
|
const e = Number(t);
|
|
372
517
|
if (!Number.isSafeInteger(e) || e < 0)
|
|
373
|
-
throw new
|
|
518
|
+
throw new A("Expected a non-negative integer.");
|
|
374
519
|
return e;
|
|
375
520
|
}
|
|
376
|
-
function
|
|
377
|
-
if (!Object.hasOwn(
|
|
378
|
-
throw new
|
|
521
|
+
function ne(t) {
|
|
522
|
+
if (!Object.hasOwn(R, t))
|
|
523
|
+
throw new A(`Expected one of: ${Object.keys(R).join(", ")}.`);
|
|
379
524
|
return t;
|
|
380
525
|
}
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
const
|
|
385
|
-
|
|
386
|
-
}
|
|
387
|
-
|
|
526
|
+
C.command("sync-markdown").description(
|
|
527
|
+
"Update managed Markdown comments on an existing issue, leaving its body untouched. Requires authenticated gh cli."
|
|
528
|
+
).argument("<markdown-file>", "Path to the Markdown report").requiredOption("--issue <url>", "HTTPS URL of the existing GitHub issue").option("--dry-run", "Print planned comment changes without changing GitHub", !1).action(async (t, e) => {
|
|
529
|
+
const { syncMarkdown: o } = await import("./syncMarkdown.js");
|
|
530
|
+
await o(r.resolve(t), e.issue, e.dryRun);
|
|
531
|
+
});
|
|
532
|
+
F.parse();
|
|
388
533
|
export {
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
534
|
+
$ as a,
|
|
535
|
+
Pe as b,
|
|
536
|
+
Le as c,
|
|
537
|
+
R as d,
|
|
538
|
+
Be as e,
|
|
539
|
+
Me as f,
|
|
540
|
+
S as g,
|
|
541
|
+
ze as h,
|
|
542
|
+
Ue as i,
|
|
543
|
+
Ke as j,
|
|
544
|
+
_e as k,
|
|
545
|
+
He as l,
|
|
546
|
+
qe as m,
|
|
547
|
+
ye as p,
|
|
548
|
+
ve as r,
|
|
549
|
+
Ve as s
|
|
394
550
|
};
|