@arcgis/codemod 6.0.0-next.2 → 6.0.0-next.21
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/artifact.js +48 -0
- package/dist/chunks/classification.js +222 -0
- package/dist/chunks/cli.js +399 -220
- package/dist/chunks/codemod5.js +0 -1
- package/dist/chunks/componentAudit.js +258 -0
- package/dist/chunks/format.js +121 -188
- package/dist/chunks/github.js +124 -0
- package/dist/chunks/index.js +950 -284
- package/dist/chunks/index2.js +132 -102
- package/dist/chunks/index3.js +342 -0
- package/dist/chunks/sync.js +43 -142
- package/dist/chunks/syncMarkdown.js +32 -0
- package/dist/chunks/useProjectInstance.js +27 -24
- package/package.json +7 -5
- package/dist/chunks/hardcodedBehavior.js +0 -93
package/dist/chunks/cli.js
CHANGED
|
@@ -1,21 +1,22 @@
|
|
|
1
|
-
import { log as
|
|
2
|
-
import { Command as
|
|
3
|
-
import { stat as
|
|
4
|
-
import { path as
|
|
5
|
-
import { asyncFindPath as
|
|
1
|
+
import { log as u } from "@arcgis/toolkit/log";
|
|
2
|
+
import { Command as ae, InvalidArgumentError as R } from "@commander-js/extra-typings";
|
|
3
|
+
import { stat as X, realpath as Y } from "node:fs/promises";
|
|
4
|
+
import { path as r, getCwd as N, toPosixPathSeparators as q } from "@arcgis/node-toolkit/path";
|
|
5
|
+
import { asyncFindPath as T, existsAsync as $ } 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 ce } 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 H } from "@arcgis/toolkit/function";
|
|
12
|
+
import { styleText as J } from "node:util";
|
|
13
|
+
import { randomUUID as de } from "node:crypto";
|
|
14
|
+
const le = (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
|
+
}, Ge = {
|
|
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 me() {
|
|
52
|
+
const { ignorePatterns: t, globRoot: e, hasIgnoreFiles: o } = await ue(), s = await pe(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 ue() {
|
|
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 = N(), 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 p = r.join(n, ".gitignore");
|
|
64
|
+
if (await $(p)) {
|
|
65
|
+
e = !0, l = r.dirname(p);
|
|
66
|
+
const h = r.relative(l, N()).split("/"), F = ee(p);
|
|
67
|
+
for (const w of F) {
|
|
68
|
+
const y = w.startsWith("!") ? w.slice(1) : w, b = y.search(/[*?[]/u), P = b === -1 ? y : y.slice(0, b), g = P.split("/"), C = b !== -1 && !P.endsWith("/");
|
|
69
|
+
let v = !0;
|
|
70
|
+
const I = Math.min(h.length, g.length);
|
|
71
|
+
for (let i = 0; i < I; i++) {
|
|
72
|
+
const a = g[i];
|
|
73
|
+
if (!(C && i === g.length - 1 ? h[i].startsWith(a) : h[i] === a) && a !== "") {
|
|
74
|
+
v = !1;
|
|
65
75
|
break;
|
|
66
76
|
}
|
|
67
77
|
}
|
|
68
|
-
|
|
78
|
+
v && (w.startsWith("!") || t.push(w));
|
|
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 pe(t) {
|
|
86
|
+
const e = await Z("**/.gitignore", {
|
|
87
|
+
cwd: N(),
|
|
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)), n = H(s), l = [];
|
|
93
|
-
for (const w of n)
|
|
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 p of l)
|
|
98
|
+
p.startsWith("!") || f.push(r.join(n, p));
|
|
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"], ge = /* @__PURE__ */ new Set([...oe, ...se]), fe = ["json"], he = ["css", "scss", "sass", "html"];
|
|
103
|
+
async function we({
|
|
104
|
+
targetFilePath: t,
|
|
105
|
+
includeComponentFiles: e = !1,
|
|
106
|
+
includeTsConfigFiles: o = !1
|
|
107
|
+
} = {}) {
|
|
108
|
+
const s = await me(), l = `**/*.{${[
|
|
109
|
+
...oe,
|
|
110
|
+
...se,
|
|
111
|
+
...fe,
|
|
112
|
+
...e ? he : []
|
|
113
|
+
].join(",")}}`, f = r.join(process.cwd(), l), p = 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,142 +121,169 @@ async function re(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 || p + 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 F = p.length + h.length, w = [], y = [], b = /* @__PURE__ */ new Set();
|
|
129
|
+
for (const i of U) {
|
|
130
|
+
const a = p + i;
|
|
131
|
+
if (i.endsWith(".json")) {
|
|
132
|
+
const c = r.basename(i);
|
|
133
|
+
c === "package.json" ? w.push(a) : (c.startsWith("tsconfig.") || c.startsWith("jsconfig.")) && y.push(a);
|
|
121
134
|
} else {
|
|
122
|
-
const
|
|
123
|
-
|
|
135
|
+
const c = i.slice(h.length);
|
|
136
|
+
b.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 = q(P), y.push(P)), y.sort((i, a) => {
|
|
141
|
+
const c = a.split("/").length - i.split("/").length;
|
|
142
|
+
if (c !== 0)
|
|
143
|
+
return c;
|
|
144
|
+
const m = r.basename(i), k = r.basename(a);
|
|
145
|
+
return m === k ? 0 : m.endsWith("tsconfig.json") ? -1 : k.endsWith("tsconfig.json") ? 1 : m.endsWith("tsconfig.build.json") ? -1 : k.endsWith("tsconfig.build.json") ? 1 : m.localeCompare(k);
|
|
133
146
|
});
|
|
134
|
-
let
|
|
135
|
-
|
|
136
|
-
const
|
|
147
|
+
let g = await T("package.json");
|
|
148
|
+
g !== void 0 && (g = q(g));
|
|
149
|
+
const C = [
|
|
150
|
+
.../* @__PURE__ */ new Set([...w, ...g === void 0 ? [] : [g]])
|
|
151
|
+
].sort((i, a) => a.length - i.length), v = [], I = /* @__PURE__ */ new Set();
|
|
137
152
|
if (await Promise.all(
|
|
138
|
-
y.map(async (
|
|
139
|
-
const
|
|
140
|
-
if (
|
|
141
|
-
|
|
153
|
+
y.map(async (i) => {
|
|
154
|
+
const a = r.relative(process.cwd(), i), c = d.readConfigFile(i, d.sys.readFile);
|
|
155
|
+
if (c.error !== void 0) {
|
|
156
|
+
u(
|
|
142
157
|
"error",
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
getCanonicalFileName:
|
|
146
|
-
getCurrentDirectory:
|
|
147
|
-
getNewLine: () =>
|
|
158
|
+
a,
|
|
159
|
+
d.formatDiagnosticsWithColorAndContext([c.error], {
|
|
160
|
+
getCanonicalFileName: H,
|
|
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 m = d.parseJsonConfigFileContent(
|
|
168
|
+
c.config,
|
|
169
|
+
d.sys,
|
|
170
|
+
r.dirname(i),
|
|
156
171
|
void 0,
|
|
157
|
-
|
|
158
|
-
),
|
|
159
|
-
|
|
172
|
+
i
|
|
173
|
+
), k = 18003;
|
|
174
|
+
m.errors.filter((j) => j.code !== k).length > 0 && u(
|
|
160
175
|
"warn",
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
getCanonicalFileName:
|
|
164
|
-
getCurrentDirectory:
|
|
165
|
-
getNewLine: () =>
|
|
176
|
+
a,
|
|
177
|
+
d.formatDiagnosticsWithColorAndContext(m.errors, {
|
|
178
|
+
getCanonicalFileName: H,
|
|
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 = m.fileNames.filter((j) => {
|
|
184
|
+
if (t !== void 0 && j !== t)
|
|
170
185
|
return !1;
|
|
171
|
-
const
|
|
172
|
-
return
|
|
173
|
-
})
|
|
174
|
-
|
|
186
|
+
const D = j.slice(F);
|
|
187
|
+
return b.delete(D) ? (I.add(D), !0) : I.has(D) || D.endsWith(".json") || j.includes("node_modules") || L ? !1 : d.sys.fileExists(j);
|
|
188
|
+
}), ne = (
|
|
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 && !ne)
|
|
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: r,
|
|
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), re = z(_, C) ?? g;
|
|
197
|
+
v.push(
|
|
198
|
+
await B(K, _, re, {
|
|
199
|
+
filePath: i,
|
|
200
|
+
compilerOptions: m.options
|
|
201
|
+
})
|
|
202
|
+
);
|
|
200
203
|
})
|
|
201
|
-
),
|
|
202
|
-
const
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
packageJson: r,
|
|
209
|
-
cwd: process.cwd(),
|
|
210
|
-
logName: D("blue", r?.contents?.name ?? process.cwd()),
|
|
211
|
-
filePaths: Array.from(v).map((d) => i.join(process.cwd(), d))
|
|
212
|
-
});
|
|
204
|
+
), b.size > 0) {
|
|
205
|
+
const i = [...b].map((c) => r.join(process.cwd(), c)), a = Map.groupBy(i, (c) => z(c, C));
|
|
206
|
+
v.push(
|
|
207
|
+
...await Promise.all(
|
|
208
|
+
[...a].map(async ([c, m]) => await B(m, 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 $e(t) {
|
|
217
|
+
const e = r.extname(t).slice(1);
|
|
218
|
+
return ge.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
|
+
});
|
|
215
225
|
}
|
|
216
|
-
function
|
|
217
|
-
|
|
226
|
+
async function B(t, e, o, s) {
|
|
227
|
+
const n = o === void 0 ? void 0 : {
|
|
228
|
+
filePath: o,
|
|
229
|
+
contents: await ce(r.dirname(o))
|
|
230
|
+
};
|
|
231
|
+
return {
|
|
232
|
+
typeScriptConfig: s,
|
|
233
|
+
packageJson: n,
|
|
234
|
+
cwd: e,
|
|
235
|
+
filePaths: t.sort(),
|
|
236
|
+
logName: J("blue", n?.contents.name ?? e)
|
|
237
|
+
};
|
|
238
|
+
}
|
|
239
|
+
function ye() {
|
|
240
|
+
S.codemod.meta.needsFooter && (S.codemod.meta.needsFooter = !1, process.exitCode !== void 0 && process.exitCode !== 0 ? u(
|
|
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
|
+
) : u(
|
|
222
245
|
"info",
|
|
223
|
-
|
|
224
|
-
`${
|
|
246
|
+
S.codemodName,
|
|
247
|
+
`${J("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 be(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
|
+
u("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
|
-
const
|
|
268
|
+
const O = {
|
|
269
|
+
outdatedDependencies: {
|
|
270
|
+
label: "Outdated SDK dependencies - highest priority",
|
|
271
|
+
description: "Out of date SDK packages hide APIs that may be deprecated in the most recent version."
|
|
272
|
+
},
|
|
273
|
+
mismatchedDependencies: {
|
|
274
|
+
label: "Mismatched SDK dependency versions",
|
|
275
|
+
description: "Web GIS SDK packages within the same package.json must use the same exact version - that is the only tested combination."
|
|
276
|
+
},
|
|
277
|
+
coreViews: {
|
|
278
|
+
label: "@arcgis/core views and UI - highest priority",
|
|
279
|
+
description: "Use map components and slots instead. Directly constructed views will no longer include .ui (like zoom buttons) in 6.0."
|
|
280
|
+
},
|
|
241
281
|
coreWidgets: {
|
|
242
282
|
label: "@arcgis/core widgets - high priority",
|
|
243
283
|
description: "WebGIS platform priority"
|
|
244
284
|
},
|
|
245
285
|
coreGeometryEngine: {
|
|
246
|
-
label: "@arcgis/core geometry engine - high priority",
|
|
286
|
+
label: "@arcgis/core geometry engine and projection - high priority",
|
|
247
287
|
description: "WebGIS platform priority"
|
|
248
288
|
},
|
|
249
289
|
codemod: {
|
|
@@ -251,11 +291,17 @@ const W = {
|
|
|
251
291
|
description: "A codemod is available to automate these migrations."
|
|
252
292
|
},
|
|
253
293
|
calcite: {
|
|
254
|
-
label: "Calcite
|
|
294
|
+
label: "Calcite design system",
|
|
255
295
|
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"
|
|
256
296
|
},
|
|
257
|
-
|
|
297
|
+
arcgisCore: { label: "@arcgis/core" },
|
|
298
|
+
arcgisComponents: { label: "WebGIS SDK components" },
|
|
299
|
+
arcgisSupport: { label: "WebGIS SDK support packages" },
|
|
258
300
|
otherEsri: { label: "Other Esri and ArcGIS packages" },
|
|
301
|
+
outdatedTypeScriptConfig: {
|
|
302
|
+
label: "Outdated TypeScript configuration",
|
|
303
|
+
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."
|
|
304
|
+
},
|
|
259
305
|
coreIntl: {
|
|
260
306
|
label: "@arcgis/core translation utils",
|
|
261
307
|
description: "Use https://webgis.esri.com/references/toolkit/intl instead."
|
|
@@ -264,36 +310,88 @@ const W = {
|
|
|
264
310
|
label: "Non-Esri packages and web platform - low priority",
|
|
265
311
|
description: "These deprecations do not block updating Esri packages and are not tied to an ArcGIS release."
|
|
266
312
|
}
|
|
267
|
-
},
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
313
|
+
}, E = "https://webgis.esri.com/api/deprecations";
|
|
314
|
+
async function Je(t, e) {
|
|
315
|
+
const o = de();
|
|
316
|
+
process.stderr.write(`Submitting deprecation report (${o}).
|
|
317
|
+
`);
|
|
318
|
+
let s;
|
|
319
|
+
try {
|
|
320
|
+
s = await fetch(e, {
|
|
321
|
+
method: "POST",
|
|
322
|
+
headers: { "Content-Type": "application/json" },
|
|
323
|
+
body: JSON.stringify({
|
|
324
|
+
submissionId: o,
|
|
325
|
+
report: t
|
|
326
|
+
}),
|
|
327
|
+
signal: AbortSignal.timeout(12e4),
|
|
328
|
+
redirect: "error"
|
|
329
|
+
});
|
|
330
|
+
} catch (l) {
|
|
331
|
+
throw new Error(`Deprecation reporting failed; check submission ${o} before retrying.`, {
|
|
332
|
+
cause: l
|
|
333
|
+
});
|
|
334
|
+
}
|
|
335
|
+
if (!s.ok)
|
|
336
|
+
throw new Error(`Deprecation reporting failed: HTTP ${s.status}. Submission ID: ${o}`);
|
|
337
|
+
const n = await s.json();
|
|
338
|
+
if (typeof n != "object" || n === null || !("submissionId" in n) || n.submissionId !== o)
|
|
339
|
+
throw new Error(`Invalid collector acknowledgement. Check submission ${o} before retrying.`);
|
|
340
|
+
process.stderr.write(`Deprecation report submitted to ${e} (${o}).
|
|
341
|
+
`);
|
|
342
|
+
}
|
|
343
|
+
const Pe = /(?:esri|arcgis)/iu, W = ["all", "repositories", "apis", "unused-apis"], Me = "@arcgis/codemod", Ue = {
|
|
344
|
+
usages: "Refactor-out deprecated API usages",
|
|
345
|
+
definitions: "Remove deprecated APIs in next breaking changes release"
|
|
346
|
+
}, Le = {
|
|
347
|
+
usages: "The following deprecated APIs are used in files owned by assigned CODEOWNERS. Refactor them before the APIs are removed.",
|
|
348
|
+
definitions: "The following deprecated APIs are owned by assigned CODEOWNERS. Remove them in the next breaking changes release."
|
|
349
|
+
}, Ke = "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.", _e = "Task", qe = "deprecations sync-issues";
|
|
350
|
+
function He(t) {
|
|
351
|
+
return Pe.test(t);
|
|
352
|
+
}
|
|
353
|
+
const A = new ae();
|
|
354
|
+
A.name("@arcgis/codemod").description("Codemod for migrating or refactoring usages of ArcGIS Maps SDK for JavaScript");
|
|
355
|
+
A.command("run").description("Run a single codemod").argument(
|
|
356
|
+
"<codemodName>",
|
|
357
|
+
"Name of the codemod. See https://www.npmjs.com/package/@arcgis/codemod for a list of available codemods"
|
|
358
|
+
).argument("[path]", "Directory to transform", process.cwd()).action(async (t, e) => {
|
|
359
|
+
const o = await M(e);
|
|
360
|
+
let s;
|
|
272
361
|
try {
|
|
273
|
-
|
|
362
|
+
s = await le(/* @__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);
|
|
274
363
|
} catch (n) {
|
|
275
364
|
if (
|
|
276
365
|
// direct Node execution
|
|
277
366
|
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
|
|
278
367
|
String(n).includes("Unknown variable dynamic import:")
|
|
279
368
|
) {
|
|
280
|
-
|
|
369
|
+
u("error", "@arcgis/codemod", `Can't find codemod by name "${t}".`), process.exitCode = 1;
|
|
281
370
|
return;
|
|
282
371
|
} else
|
|
283
372
|
throw n;
|
|
284
373
|
}
|
|
285
|
-
if (typeof
|
|
286
|
-
|
|
374
|
+
if (typeof s.codemod != "object" || s.codemod === null) {
|
|
375
|
+
u("error", "@arcgis/codemod", `Can't find codemod by name "${t}".`), process.exitCode = 1;
|
|
287
376
|
return;
|
|
288
377
|
}
|
|
289
|
-
await
|
|
378
|
+
await be(s.codemod, J("blue", t), o);
|
|
290
379
|
});
|
|
291
|
-
const
|
|
292
|
-
|
|
380
|
+
const x = A.command("deprecations").description(
|
|
381
|
+
`Audit and report deprecated APIs.
|
|
382
|
+
|
|
383
|
+
Documentation: https://webgis.esri.com/references/codemod/deprecations`
|
|
384
|
+
);
|
|
385
|
+
x.command("audit-usages").description(
|
|
386
|
+
"Report deprecated API usages. Documentation: https://webgis.esri.com/references/codemod/deprecations#audit-usages"
|
|
387
|
+
).argument("[path]", "Directory to audit", process.cwd()).option("--esri-only", "Only report usages of deprecated APIs from Esri and ArcGIS packages", !1).option(
|
|
293
388
|
"--category <category>",
|
|
294
|
-
`Only report usages in a category. Available categories: ${Object.keys(
|
|
295
|
-
|
|
389
|
+
`Only report usages in a category. Available categories: ${Object.keys(O).join(", ")}`,
|
|
390
|
+
ie
|
|
296
391
|
).option("--package <package-name>", "Only report usages of deprecated APIs from this package").option(
|
|
392
|
+
"--report [url]",
|
|
393
|
+
`Submit a complete repository scan to the WebGIS collector (default: ${E})`
|
|
394
|
+
).option(
|
|
297
395
|
"--json",
|
|
298
396
|
"Output results as JSON. Example: npx @arcgis/codemod deprecations audit-usages --json > usages.json",
|
|
299
397
|
!1
|
|
@@ -303,26 +401,88 @@ J.command("audit-usages").description("Report deprecated API usages").argument("
|
|
|
303
401
|
!1
|
|
304
402
|
).action(async (t, e) => {
|
|
305
403
|
if (e.json && e.md) {
|
|
306
|
-
|
|
404
|
+
u("error", "@arcgis/codemod", "The --json and --md options cannot be used together."), process.exitCode = 1;
|
|
307
405
|
return;
|
|
308
406
|
}
|
|
309
|
-
const
|
|
310
|
-
await o
|
|
407
|
+
const o = await M(t), { auditDeprecatedUsages: s } = await import("./index.js"), n = e.md ? "md" : e.json ? "json" : "text";
|
|
408
|
+
await s(o, {
|
|
311
409
|
esriOnly: e.esriOnly,
|
|
312
410
|
outputFormat: n,
|
|
313
411
|
category: e.category,
|
|
314
|
-
packageName: e.package
|
|
412
|
+
packageName: e.package,
|
|
413
|
+
reportingUrl: e.report === !0 ? E : e.report || void 0
|
|
315
414
|
});
|
|
316
415
|
});
|
|
317
|
-
|
|
416
|
+
x.command("audit-definitions").description(
|
|
417
|
+
"Report exported APIs marked as deprecated. Documentation: https://webgis.esri.com/references/codemod/deprecations#audit-definitions"
|
|
418
|
+
).argument("[path]", "Directory to audit", process.cwd()).option(
|
|
318
419
|
"--json",
|
|
319
420
|
"Output results as JSON. Example: npx @arcgis/codemod deprecations audit-definitions --json > definitions.json",
|
|
320
421
|
!1
|
|
321
422
|
).action(async (t, e) => {
|
|
322
|
-
const
|
|
323
|
-
await o
|
|
423
|
+
const o = await M(t), { auditDeprecatedDefinitions: s } = await import("./index2.js");
|
|
424
|
+
await s(o, e.json);
|
|
425
|
+
});
|
|
426
|
+
x.command("aggregate-usages").description(
|
|
427
|
+
"Aggregate audit-usages reports into repository summaries and an API usage tree. Documentation: https://webgis.esri.com/references/codemod/deprecations#analyze-the-ecosystem"
|
|
428
|
+
).argument("[reports...]", "Paths to audit-usages JSON files").option(
|
|
429
|
+
"--section <section>",
|
|
430
|
+
`Reports to include in the markdown report: ${W.join(", ")}`,
|
|
431
|
+
ve,
|
|
432
|
+
"all"
|
|
433
|
+
).option(
|
|
434
|
+
"--remote [url]",
|
|
435
|
+
`Read the latest stored audit per repository from the WebGIS collector (default: ${E})`
|
|
436
|
+
).option(
|
|
437
|
+
"--repository <repository>",
|
|
438
|
+
"Select a remote repository (host/owner/repo); repeat to select multiple",
|
|
439
|
+
G,
|
|
440
|
+
[]
|
|
441
|
+
).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(
|
|
442
|
+
"--definitions <report>",
|
|
443
|
+
"Compare an audit-definitions JSON report to list APIs with zero detected usages. Can be specified multiple times.",
|
|
444
|
+
G,
|
|
445
|
+
[]
|
|
446
|
+
).option("--esri-only", "Only report usages of deprecated APIs from Esri and ArcGIS packages", !1).option(
|
|
447
|
+
"--category <category>",
|
|
448
|
+
`Only report usages in a category. Available categories: ${Object.keys(O).join(", ")}`,
|
|
449
|
+
ie
|
|
450
|
+
).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) => {
|
|
451
|
+
if (!t.length && !e.remote || !e.remote && (e.repository.length || e.branch || e.since || e.until))
|
|
452
|
+
throw new Error("Provide report files or --remote. Repository, branch, and date selection require --remote.");
|
|
453
|
+
if (e.since && e.until && e.since > e.until)
|
|
454
|
+
throw new Error("--since must not be after --until.");
|
|
455
|
+
if (e.json && e.md) {
|
|
456
|
+
u("error", "@arcgis/codemod", "The --json and --md options cannot be used together."), process.exitCode = 1;
|
|
457
|
+
return;
|
|
458
|
+
}
|
|
459
|
+
const { aggregateUsagesFromFiles: o } = await import("./index3.js");
|
|
460
|
+
await o(
|
|
461
|
+
t,
|
|
462
|
+
e.md ? "md" : e.json ? "json" : "text",
|
|
463
|
+
{
|
|
464
|
+
esriOnly: e.esriOnly,
|
|
465
|
+
category: e.category,
|
|
466
|
+
packageName: e.package,
|
|
467
|
+
section: e.section
|
|
468
|
+
},
|
|
469
|
+
e.definitions,
|
|
470
|
+
e.remote ? {
|
|
471
|
+
url: e.remote === !0 ? E : e.remote,
|
|
472
|
+
repositories: e.repository,
|
|
473
|
+
branch: e.branch,
|
|
474
|
+
since: e.since,
|
|
475
|
+
until: e.until
|
|
476
|
+
} : void 0
|
|
477
|
+
);
|
|
324
478
|
});
|
|
325
|
-
|
|
479
|
+
function ve(t) {
|
|
480
|
+
const e = W.find((o) => o === t);
|
|
481
|
+
if (e !== void 0)
|
|
482
|
+
return e;
|
|
483
|
+
throw new R(`Expected one of: ${W.join(", ")}.`);
|
|
484
|
+
}
|
|
485
|
+
x.command("sync-issues").description(
|
|
326
486
|
`Create or update deprecation audit issues. Requires authenticated gh cli.
|
|
327
487
|
|
|
328
488
|
Existing open issues are updated if out of date (matched by title and invisible comment inside).
|
|
@@ -330,51 +490,70 @@ Otherwise, a new issue is created. Assignees are determined based on CODEOWNERS.
|
|
|
330
490
|
).argument(
|
|
331
491
|
"<audit-json>",
|
|
332
492
|
"Path to the JSON file as output by the --json flag in the audit-usages or audit-definitions CLI"
|
|
333
|
-
).option("--dry-run", "Print planned issue and comment changes without changing GitHub", !1).option("--offset <number>", "Skip the first number of issue plans",
|
|
493
|
+
).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(
|
|
334
494
|
"--label <label>",
|
|
335
495
|
"Label to add to newly created issues. Can be specified multiple times.",
|
|
336
|
-
|
|
496
|
+
G,
|
|
337
497
|
[]
|
|
338
498
|
).action(async (t, e) => {
|
|
339
|
-
const
|
|
340
|
-
if (!await
|
|
341
|
-
|
|
499
|
+
const o = r.resolve(t);
|
|
500
|
+
if (!await $(o) || !(await X(o)).isFile()) {
|
|
501
|
+
u("error", "@arcgis/codemod", `Failed to find the audit JSON file: ${t}`), process.exitCode = 1;
|
|
342
502
|
return;
|
|
343
503
|
}
|
|
344
|
-
const { syncDeprecationIssues:
|
|
345
|
-
await o
|
|
346
|
-
|
|
347
|
-
e.
|
|
348
|
-
|
|
349
|
-
e.limit,
|
|
350
|
-
e.label
|
|
351
|
-
);
|
|
504
|
+
const { syncDeprecationIssues: s } = await import("./sync.js");
|
|
505
|
+
await s(await Y(o), e.dryRun, e.offset, e.limit, {
|
|
506
|
+
labels: e.label,
|
|
507
|
+
closeResolved: e.closeResolved
|
|
508
|
+
});
|
|
352
509
|
});
|
|
353
|
-
function
|
|
510
|
+
function V(t) {
|
|
511
|
+
const e = new Date(t);
|
|
512
|
+
if (!Number.isFinite(e.getTime()))
|
|
513
|
+
throw new R("Expected an ISO date.");
|
|
514
|
+
return e.toISOString();
|
|
515
|
+
}
|
|
516
|
+
function G(t, e) {
|
|
354
517
|
return [...e, t];
|
|
355
518
|
}
|
|
356
|
-
function
|
|
519
|
+
function Q(t) {
|
|
357
520
|
const e = Number(t);
|
|
358
521
|
if (!Number.isSafeInteger(e) || e < 0)
|
|
359
|
-
throw new
|
|
522
|
+
throw new R("Expected a non-negative integer.");
|
|
360
523
|
return e;
|
|
361
524
|
}
|
|
362
|
-
function
|
|
363
|
-
if (!Object.hasOwn(
|
|
364
|
-
throw new
|
|
525
|
+
function ie(t) {
|
|
526
|
+
if (!Object.hasOwn(O, t))
|
|
527
|
+
throw new R(`Expected one of: ${Object.keys(O).join(", ")}.`);
|
|
365
528
|
return t;
|
|
366
529
|
}
|
|
367
|
-
async function
|
|
368
|
-
const e =
|
|
369
|
-
await
|
|
370
|
-
const
|
|
371
|
-
return process.chdir(
|
|
530
|
+
async function M(t) {
|
|
531
|
+
const e = r.resolve(t);
|
|
532
|
+
await $(e) || (u("error", "@arcgis/codemod", `Failed to find the target path: ${t}`), process.exit(1));
|
|
533
|
+
const o = await Y(e), s = (await X(o)).isFile();
|
|
534
|
+
return process.chdir(s ? r.dirname(o) : o), s ? o : void 0;
|
|
372
535
|
}
|
|
373
|
-
|
|
536
|
+
x.command("sync-markdown").description(
|
|
537
|
+
"Update managed Markdown comments on an existing issue, leaving its body untouched. Requires authenticated gh cli."
|
|
538
|
+
).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) => {
|
|
539
|
+
const { syncMarkdown: o } = await import("./syncMarkdown.js");
|
|
540
|
+
await o(r.resolve(t), e.issue, e.dryRun);
|
|
541
|
+
});
|
|
542
|
+
A.parse();
|
|
374
543
|
export {
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
544
|
+
Je as a,
|
|
545
|
+
He as b,
|
|
546
|
+
Ge as c,
|
|
547
|
+
O as d,
|
|
548
|
+
E as e,
|
|
549
|
+
qe as f,
|
|
550
|
+
S as g,
|
|
551
|
+
Ue as h,
|
|
552
|
+
$e as i,
|
|
553
|
+
_e as j,
|
|
554
|
+
Me as k,
|
|
555
|
+
Le as l,
|
|
556
|
+
Ke as m,
|
|
557
|
+
ye as p,
|
|
558
|
+
be as r
|
|
380
559
|
};
|