@deploid/plugin-doctor 2.0.1 → 2.0.2
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/index.d.ts +27 -9
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +494 -135
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
- package/src/index.ts +705 -172
package/src/index.ts
CHANGED
|
@@ -3,14 +3,35 @@ import fs from 'node:fs';
|
|
|
3
3
|
import path from 'node:path';
|
|
4
4
|
|
|
5
5
|
type CheckStatus = 'pass' | 'warn' | 'fail';
|
|
6
|
+
type CheckCategory = 'project' | 'workflows' | 'tooling' | 'plugins' | 'release';
|
|
7
|
+
type WorkflowId = 'init' | 'build' | 'release' | 'deploy' | 'desktop';
|
|
8
|
+
type FixStatus = 'applied' | 'skipped' | 'failed';
|
|
6
9
|
|
|
7
10
|
interface CheckResult {
|
|
8
11
|
id: string;
|
|
9
|
-
category:
|
|
12
|
+
category: CheckCategory;
|
|
10
13
|
title: string;
|
|
11
14
|
status: CheckStatus;
|
|
12
15
|
message: string;
|
|
13
16
|
details?: string;
|
|
17
|
+
workflows: WorkflowId[];
|
|
18
|
+
fixable?: boolean;
|
|
19
|
+
}
|
|
20
|
+
|
|
21
|
+
interface WorkflowReadiness {
|
|
22
|
+
id: WorkflowId;
|
|
23
|
+
title: string;
|
|
24
|
+
status: CheckStatus;
|
|
25
|
+
score: number;
|
|
26
|
+
totals: Record<CheckStatus, number>;
|
|
27
|
+
nextAction?: string;
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
interface FixResult {
|
|
31
|
+
id: string;
|
|
32
|
+
title: string;
|
|
33
|
+
status: FixStatus;
|
|
34
|
+
message: string;
|
|
14
35
|
}
|
|
15
36
|
|
|
16
37
|
interface DoctorSummary {
|
|
@@ -18,11 +39,41 @@ interface DoctorSummary {
|
|
|
18
39
|
cwd: string;
|
|
19
40
|
checks: CheckResult[];
|
|
20
41
|
totals: Record<CheckStatus, number>;
|
|
42
|
+
workflows: WorkflowReadiness[];
|
|
43
|
+
fixes: FixResult[];
|
|
21
44
|
}
|
|
22
45
|
|
|
23
46
|
interface DoctorOptions {
|
|
24
47
|
json?: boolean;
|
|
48
|
+
markdown?: boolean;
|
|
49
|
+
ci?: boolean;
|
|
50
|
+
summary?: boolean;
|
|
51
|
+
verbose?: boolean;
|
|
25
52
|
projectOnly?: boolean;
|
|
53
|
+
fix?: boolean;
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
interface DeploidConfigShape {
|
|
57
|
+
appName?: string;
|
|
58
|
+
appId?: string;
|
|
59
|
+
web?: { framework?: string; buildCommand?: string; webDir?: string };
|
|
60
|
+
android?: {
|
|
61
|
+
packaging?: string;
|
|
62
|
+
signing?: {
|
|
63
|
+
keystorePath?: string;
|
|
64
|
+
alias?: string;
|
|
65
|
+
storePasswordEnv?: string;
|
|
66
|
+
keyPasswordEnv?: string;
|
|
67
|
+
};
|
|
68
|
+
version?: { code?: number; name?: string };
|
|
69
|
+
build?: { buildType?: 'apk' | 'aab' | 'both' };
|
|
70
|
+
};
|
|
71
|
+
assets?: { source?: string; output?: string };
|
|
72
|
+
publish?: {
|
|
73
|
+
play?: { track?: string; serviceAccountJson?: string };
|
|
74
|
+
github?: { repo?: string; draft?: boolean };
|
|
75
|
+
};
|
|
76
|
+
plugins?: string[];
|
|
26
77
|
}
|
|
27
78
|
|
|
28
79
|
interface PipelineContext {
|
|
@@ -36,44 +87,57 @@ interface PipelineContext {
|
|
|
36
87
|
appName: string;
|
|
37
88
|
appId: string;
|
|
38
89
|
web: { framework: string; buildCommand: string; webDir: string };
|
|
39
|
-
android: {
|
|
40
|
-
packaging: string;
|
|
41
|
-
signing?: {
|
|
42
|
-
keystorePath?: string;
|
|
43
|
-
storePasswordEnv?: string;
|
|
44
|
-
keyPasswordEnv?: string;
|
|
45
|
-
};
|
|
46
|
-
};
|
|
47
|
-
assets?: { source: string };
|
|
90
|
+
android: { packaging: string };
|
|
48
91
|
};
|
|
49
92
|
cwd: string;
|
|
50
93
|
doctorOptions?: DoctorOptions;
|
|
51
94
|
}
|
|
52
95
|
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
96
|
+
interface ProjectState {
|
|
97
|
+
cwd: string;
|
|
98
|
+
packageJsonPath: string;
|
|
99
|
+
packageJson: Record<string, unknown> | null;
|
|
100
|
+
configPath: string | null;
|
|
101
|
+
config: DeploidConfigShape | null;
|
|
102
|
+
capacitorConfigPath: string;
|
|
103
|
+
capacitorConfig: Record<string, unknown> | null;
|
|
104
|
+
androidDir: string;
|
|
105
|
+
androidBuildGradlePath: string;
|
|
106
|
+
packageDeps: Record<string, unknown>;
|
|
107
|
+
packageScripts: Record<string, unknown>;
|
|
108
|
+
}
|
|
109
|
+
|
|
110
|
+
const CONFIG_CANDIDATES = ['deploid.config.ts', 'deploid.config.js', 'deploid.config.mjs', 'deploid.config.cjs'];
|
|
111
|
+
const WORKFLOW_TITLES: Record<WorkflowId, string> = {
|
|
112
|
+
init: 'Project setup',
|
|
113
|
+
build: 'Android build',
|
|
114
|
+
release: 'Release readiness',
|
|
115
|
+
deploy: 'Device deploy',
|
|
116
|
+
desktop: 'Desktop packaging'
|
|
117
|
+
};
|
|
59
118
|
|
|
60
119
|
const plugin = {
|
|
61
120
|
name: 'doctor',
|
|
62
121
|
plan: () => [
|
|
63
|
-
'Inspect project files and
|
|
64
|
-
'
|
|
65
|
-
'
|
|
122
|
+
'Inspect project files and config consistency',
|
|
123
|
+
'Assess workflow readiness for setup, build, release, deploy, and desktop packaging',
|
|
124
|
+
'Offer machine-readable output and safe auto-fixes'
|
|
66
125
|
],
|
|
67
126
|
run: runDoctor
|
|
68
127
|
};
|
|
69
128
|
|
|
70
129
|
async function runDoctor(ctx: PipelineContext): Promise<void> {
|
|
71
|
-
const
|
|
130
|
+
const options = ctx.doctorOptions ?? {};
|
|
131
|
+
const summary = await inspectProject(ctx.cwd, options);
|
|
72
132
|
|
|
73
|
-
if (
|
|
133
|
+
if (options.json) {
|
|
74
134
|
console.log(JSON.stringify(summary, null, 2));
|
|
135
|
+
} else if (options.markdown) {
|
|
136
|
+
console.log(renderMarkdown(summary, options));
|
|
137
|
+
} else if (options.ci) {
|
|
138
|
+
console.log(renderCi(summary));
|
|
75
139
|
} else {
|
|
76
|
-
printSummary(
|
|
140
|
+
printSummary(summary, options);
|
|
77
141
|
}
|
|
78
142
|
|
|
79
143
|
if (!summary.ok) {
|
|
@@ -81,208 +145,512 @@ async function runDoctor(ctx: PipelineContext): Promise<void> {
|
|
|
81
145
|
}
|
|
82
146
|
}
|
|
83
147
|
|
|
84
|
-
async function inspectProject(cwd: string, options
|
|
148
|
+
async function inspectProject(cwd: string, options: DoctorOptions = {}): Promise<DoctorSummary> {
|
|
149
|
+
const state = await loadProjectState(cwd);
|
|
85
150
|
const checks: CheckResult[] = [];
|
|
86
|
-
const
|
|
87
|
-
const configPath = findExistingPath(cwd, CONFIG_CANDIDATES);
|
|
88
|
-
const packageJson = readJson<Record<string, unknown>>(packageJsonPath);
|
|
89
|
-
const config = configPath ? await loadProjectConfig(configPath) : null;
|
|
151
|
+
const fixes: FixResult[] = [];
|
|
90
152
|
|
|
91
|
-
checks.push(
|
|
92
|
-
fs.existsSync(packageJsonPath)
|
|
93
|
-
? pass('package-json', 'package.json', 'Found package.json in project root.')
|
|
94
|
-
: fail('package-json', 'package.json', 'package.json is missing from the project root.')
|
|
95
|
-
);
|
|
153
|
+
checks.push(...collectProjectChecks(state));
|
|
96
154
|
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
if (config) {
|
|
104
|
-
checks.push(checkWebDir(cwd, config.web?.webDir));
|
|
105
|
-
checks.push(checkAssetsSource(cwd, config.assets?.source));
|
|
106
|
-
checks.push(checkSigning(cwd, config.android?.signing));
|
|
107
|
-
checks.push(checkCapacitorConfig(cwd, config.android?.packaging));
|
|
108
|
-
checks.push(checkAndroidProject(cwd));
|
|
155
|
+
if (state.config) {
|
|
156
|
+
checks.push(...collectConfigChecks(state));
|
|
157
|
+
checks.push(...collectConsistencyChecks(state));
|
|
158
|
+
checks.push(...collectReleaseChecks(state));
|
|
159
|
+
checks.push(...collectPluginChecks(state));
|
|
109
160
|
} else {
|
|
110
|
-
checks.push(
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
161
|
+
checks.push(
|
|
162
|
+
warn('web-output', 'Web output directory', 'Skipped because no Deploid config was loaded.', ['init', 'build']),
|
|
163
|
+
warn('assets-source', 'Asset source', 'Skipped because no Deploid config was loaded.', ['init'], undefined, true),
|
|
164
|
+
warn('android-signing', 'Android signing', 'Skipped because no Deploid config was loaded.', ['release']),
|
|
165
|
+
warn('capacitor-config', 'Capacitor config', 'Skipped because no Deploid config was loaded.', ['build'], undefined, true),
|
|
166
|
+
warn('android-project', 'Android project', 'Skipped because no Deploid config was loaded.', ['build', 'deploy']),
|
|
167
|
+
warn('versioning', 'Version metadata', 'Skipped because no Deploid config was loaded.', ['release']),
|
|
168
|
+
warn('publish-config', 'Publish config', 'Skipped because no Deploid config was loaded.', ['release']),
|
|
169
|
+
warn('plugin-state', 'Plugin surface', 'Skipped because no Deploid config was loaded.', ['init', 'desktop'])
|
|
170
|
+
);
|
|
115
171
|
}
|
|
116
172
|
|
|
117
|
-
if (!options
|
|
118
|
-
checks.push(
|
|
119
|
-
checks.push(await checkCommand('npm', ['--version'], 'npm', 'Used by init, plugin setup, and Capacitor workflows.'));
|
|
120
|
-
checks.push(await checkCommand('npx', ['--version'], 'npx', 'Used to invoke Capacitor CLI commands.'));
|
|
121
|
-
checks.push(await checkCommand('java', ['-version'], 'Java', 'Required for Android builds.'));
|
|
122
|
-
checks.push(await checkCommand('adb', ['version'], 'ADB', 'Required for device listing, deploy, and logs.'));
|
|
123
|
-
checks.push(await checkAndroidSdk());
|
|
124
|
-
checks.push(checkCapacitorDependency(packageJson));
|
|
173
|
+
if (!options.projectOnly) {
|
|
174
|
+
checks.push(...collectToolingChecks(state));
|
|
125
175
|
}
|
|
126
176
|
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
177
|
+
if (options.fix) {
|
|
178
|
+
fixes.push(...applyFixes(state, checks));
|
|
179
|
+
if (fixes.some((fix) => fix.status === 'applied')) {
|
|
180
|
+
const refreshed = await inspectProject(cwd, { ...options, fix: false });
|
|
181
|
+
return { ...refreshed, fixes };
|
|
182
|
+
}
|
|
183
|
+
}
|
|
184
|
+
|
|
185
|
+
const totals = countStatuses(checks);
|
|
186
|
+
const workflows = buildWorkflowReadiness(checks);
|
|
132
187
|
|
|
133
188
|
return {
|
|
134
189
|
ok: totals.fail === 0,
|
|
135
190
|
cwd,
|
|
136
191
|
checks,
|
|
137
|
-
totals
|
|
192
|
+
totals,
|
|
193
|
+
workflows,
|
|
194
|
+
fixes
|
|
138
195
|
};
|
|
139
196
|
}
|
|
140
197
|
|
|
141
|
-
function
|
|
142
|
-
const
|
|
143
|
-
const
|
|
144
|
-
|
|
145
|
-
|
|
198
|
+
async function loadProjectState(cwd: string): Promise<ProjectState> {
|
|
199
|
+
const packageJsonPath = path.join(cwd, 'package.json');
|
|
200
|
+
const packageJson = readJson<Record<string, unknown>>(packageJsonPath);
|
|
201
|
+
const configPath = findExistingPath(cwd, CONFIG_CANDIDATES);
|
|
202
|
+
const config = configPath ? await loadProjectConfig(configPath) : null;
|
|
203
|
+
const capacitorConfigPath = path.join(cwd, 'capacitor.config.json');
|
|
204
|
+
const capacitorConfig = readJson<Record<string, unknown>>(capacitorConfigPath);
|
|
205
|
+
|
|
206
|
+
return {
|
|
207
|
+
cwd,
|
|
208
|
+
packageJsonPath,
|
|
209
|
+
packageJson,
|
|
210
|
+
configPath,
|
|
211
|
+
config,
|
|
212
|
+
capacitorConfigPath,
|
|
213
|
+
capacitorConfig,
|
|
214
|
+
androidDir: path.join(cwd, 'android'),
|
|
215
|
+
androidBuildGradlePath: path.join(cwd, 'android', 'app', 'build.gradle'),
|
|
216
|
+
packageDeps: {
|
|
217
|
+
...(asRecord(packageJson?.dependencies)),
|
|
218
|
+
...(asRecord(packageJson?.devDependencies))
|
|
219
|
+
},
|
|
220
|
+
packageScripts: asRecord(packageJson?.scripts)
|
|
221
|
+
};
|
|
222
|
+
}
|
|
223
|
+
|
|
224
|
+
function collectProjectChecks(state: ProjectState): CheckResult[] {
|
|
225
|
+
return [
|
|
226
|
+
fs.existsSync(state.packageJsonPath)
|
|
227
|
+
? pass('package-json', 'package.json', 'Found package.json in project root.', ['init'])
|
|
228
|
+
: fail('package-json', 'package.json', 'package.json is missing from the project root.', ['init']),
|
|
229
|
+
state.configPath
|
|
230
|
+
? pass('deploid-config', 'Deploid config', `Found ${path.basename(state.configPath)}.`, ['init', 'build', 'release'])
|
|
231
|
+
: fail('deploid-config', 'Deploid config', 'No Deploid config file was found.', ['init', 'build', 'release'])
|
|
232
|
+
];
|
|
233
|
+
}
|
|
234
|
+
|
|
235
|
+
function collectConfigChecks(state: ProjectState): CheckResult[] {
|
|
236
|
+
const config = state.config;
|
|
237
|
+
const checks: CheckResult[] = [];
|
|
238
|
+
checks.push(checkBuildCommand(state));
|
|
239
|
+
checks.push(checkWebDir(state));
|
|
240
|
+
checks.push(checkAssetsSource(state));
|
|
241
|
+
checks.push(checkCapacitorConfig(state));
|
|
242
|
+
checks.push(checkAndroidProject(state));
|
|
243
|
+
checks.push(checkSigning(state));
|
|
244
|
+
checks.push(checkVersioning(state));
|
|
245
|
+
return checks;
|
|
246
|
+
}
|
|
247
|
+
|
|
248
|
+
function collectConsistencyChecks(state: ProjectState): CheckResult[] {
|
|
249
|
+
const checks: CheckResult[] = [];
|
|
250
|
+
const config = state.config;
|
|
251
|
+
const capacitorConfig = state.capacitorConfig;
|
|
252
|
+
|
|
253
|
+
if (config?.android?.packaging === 'capacitor' && capacitorConfig) {
|
|
254
|
+
const mismatches: string[] = [];
|
|
255
|
+
if (capacitorConfig.appId && capacitorConfig.appId !== config.appId) mismatches.push(`appId=${String(capacitorConfig.appId)}`);
|
|
256
|
+
if (capacitorConfig.appName && capacitorConfig.appName !== config.appName) mismatches.push(`appName=${String(capacitorConfig.appName)}`);
|
|
257
|
+
if (capacitorConfig.webDir && capacitorConfig.webDir !== config.web?.webDir) mismatches.push(`webDir=${String(capacitorConfig.webDir)}`);
|
|
258
|
+
|
|
259
|
+
checks.push(
|
|
260
|
+
mismatches.length === 0
|
|
261
|
+
? pass('capacitor-sync', 'Capacitor sync', 'Capacitor metadata matches Deploid config.', ['build', 'release'])
|
|
262
|
+
: warn(
|
|
263
|
+
'capacitor-sync',
|
|
264
|
+
'Capacitor sync',
|
|
265
|
+
`Capacitor metadata differs from Deploid config (${mismatches.join(', ')}).`,
|
|
266
|
+
['build', 'release'],
|
|
267
|
+
'Run `deploid package` to resync generated native metadata.'
|
|
268
|
+
)
|
|
269
|
+
);
|
|
270
|
+
}
|
|
271
|
+
|
|
272
|
+
const packageBuild = asRecord(state.packageJson?.build);
|
|
273
|
+
if (Object.keys(packageBuild).length > 0 && config) {
|
|
274
|
+
const mismatches: string[] = [];
|
|
275
|
+
if (packageBuild.appId && packageBuild.appId !== config.appId) mismatches.push('build.appId');
|
|
276
|
+
if (packageBuild.productName && packageBuild.productName !== config.appName) mismatches.push('build.productName');
|
|
277
|
+
checks.push(
|
|
278
|
+
mismatches.length === 0
|
|
279
|
+
? pass('package-build-meta', 'Package metadata', 'package.json build metadata matches config.', ['desktop', 'release'])
|
|
280
|
+
: warn(
|
|
281
|
+
'package-build-meta',
|
|
282
|
+
'Package metadata',
|
|
283
|
+
`package.json metadata differs from config (${mismatches.join(', ')}).`,
|
|
284
|
+
['desktop', 'release'],
|
|
285
|
+
'Align package.json and deploid.config.ts to avoid release drift.'
|
|
286
|
+
)
|
|
287
|
+
);
|
|
288
|
+
}
|
|
289
|
+
|
|
290
|
+
if (fs.existsSync(state.androidBuildGradlePath) && config?.appId) {
|
|
291
|
+
const buildGradle = safeRead(state.androidBuildGradlePath);
|
|
292
|
+
const appIdMatch = buildGradle.match(/applicationId\s+"([^"]+)"/);
|
|
293
|
+
if (appIdMatch?.[1] === config.appId) {
|
|
294
|
+
checks.push(pass('android-app-id', 'Android appId', 'Gradle applicationId matches config.', ['build', 'release']));
|
|
295
|
+
} else if (appIdMatch?.[1]) {
|
|
296
|
+
checks.push(
|
|
297
|
+
warn(
|
|
298
|
+
'android-app-id',
|
|
299
|
+
'Android appId',
|
|
300
|
+
`Gradle applicationId is ${appIdMatch[1]} but config uses ${config.appId}.`,
|
|
301
|
+
['build', 'release'],
|
|
302
|
+
'Run `deploid package` before your next build.'
|
|
303
|
+
)
|
|
304
|
+
);
|
|
305
|
+
}
|
|
306
|
+
}
|
|
307
|
+
|
|
308
|
+
return checks;
|
|
309
|
+
}
|
|
310
|
+
|
|
311
|
+
function collectReleaseChecks(state: ProjectState): CheckResult[] {
|
|
312
|
+
const config = state.config;
|
|
313
|
+
if (!config) return [];
|
|
314
|
+
|
|
315
|
+
const checks: CheckResult[] = [];
|
|
316
|
+
const playConfig = config.publish?.play;
|
|
317
|
+
const githubConfig = config.publish?.github;
|
|
318
|
+
|
|
319
|
+
if (playConfig?.serviceAccountJson) {
|
|
320
|
+
const fullPath = path.join(state.cwd, playConfig.serviceAccountJson);
|
|
321
|
+
checks.push(
|
|
322
|
+
fs.existsSync(fullPath)
|
|
323
|
+
? pass('play-service-account', 'Play credentials', `Found ${playConfig.serviceAccountJson}.`, ['release'])
|
|
324
|
+
: fail(
|
|
325
|
+
'play-service-account',
|
|
326
|
+
'Play credentials',
|
|
327
|
+
`${playConfig.serviceAccountJson} does not exist.`,
|
|
328
|
+
['release'],
|
|
329
|
+
'Add the Play service account JSON before automating Play uploads.'
|
|
330
|
+
)
|
|
331
|
+
);
|
|
332
|
+
} else {
|
|
333
|
+
checks.push(warn('play-service-account', 'Play credentials', 'No Play service account configured.', ['release']));
|
|
334
|
+
}
|
|
335
|
+
|
|
336
|
+
checks.push(
|
|
337
|
+
githubConfig?.repo
|
|
338
|
+
? pass('github-release', 'GitHub release target', `Configured for ${githubConfig.repo}.`, ['release'])
|
|
339
|
+
: warn('github-release', 'GitHub release target', 'No GitHub release repo configured.', ['release'])
|
|
340
|
+
);
|
|
341
|
+
|
|
342
|
+
return checks;
|
|
343
|
+
}
|
|
344
|
+
|
|
345
|
+
function collectPluginChecks(state: ProjectState): CheckResult[] {
|
|
346
|
+
const checks: CheckResult[] = [];
|
|
347
|
+
const config = state.config;
|
|
348
|
+
const deps = state.packageDeps;
|
|
349
|
+
const hasElectronFiles = fs.existsSync(path.join(state.cwd, 'electron'));
|
|
350
|
+
const hasDesktopScripts = ['electron:build', 'electron:build:win', 'electron:build:mac'].some((key) => typeof state.packageScripts[key] === 'string');
|
|
351
|
+
const usesCapacitor = config?.android?.packaging === 'capacitor';
|
|
352
|
+
|
|
353
|
+
if (usesCapacitor) {
|
|
354
|
+
checks.push(
|
|
355
|
+
typeof deps['@capacitor/core'] === 'string' && typeof deps['@capacitor/cli'] === 'string'
|
|
356
|
+
? pass('capacitor-dependency', 'Capacitor packages', 'Capacitor dependencies are present.', ['build', 'deploy'])
|
|
357
|
+
: warn(
|
|
358
|
+
'capacitor-dependency',
|
|
359
|
+
'Capacitor packages',
|
|
360
|
+
'Capacitor dependencies are incomplete in package.json.',
|
|
361
|
+
['build', 'deploy'],
|
|
362
|
+
'Install @capacitor/core and @capacitor/cli in the app project.'
|
|
363
|
+
)
|
|
364
|
+
);
|
|
365
|
+
}
|
|
366
|
+
|
|
367
|
+
if (hasElectronFiles || hasDesktopScripts) {
|
|
368
|
+
checks.push(
|
|
369
|
+
typeof deps.electron === 'string' && typeof deps['electron-builder'] === 'string'
|
|
370
|
+
? pass('electron-dependency', 'Electron packages', 'Electron dependencies are present.', ['desktop'])
|
|
371
|
+
: warn(
|
|
372
|
+
'electron-dependency',
|
|
373
|
+
'Electron packages',
|
|
374
|
+
'Desktop packaging files exist but Electron dependencies are incomplete.',
|
|
375
|
+
['desktop'],
|
|
376
|
+
'Run `deploid electron` or install electron and electron-builder.'
|
|
377
|
+
)
|
|
378
|
+
);
|
|
379
|
+
} else {
|
|
380
|
+
checks.push(warn('electron-dependency', 'Electron packages', 'Desktop packaging is not configured.', ['desktop']));
|
|
381
|
+
}
|
|
382
|
+
|
|
383
|
+
return checks;
|
|
384
|
+
}
|
|
385
|
+
|
|
386
|
+
function collectToolingChecks(state: ProjectState): CheckResult[] {
|
|
387
|
+
return [
|
|
388
|
+
checkCommand('node', ['--version'], 'Node.js', 'Required to run Deploid.', ['init', 'build', 'release', 'deploy', 'desktop']),
|
|
389
|
+
checkNpm(),
|
|
390
|
+
checkCommand('npx', ['--version'], 'npx', 'Used to invoke Capacitor CLI commands.', ['build', 'release']),
|
|
391
|
+
checkJava(),
|
|
392
|
+
checkAdb(),
|
|
393
|
+
checkAndroidSdk(),
|
|
394
|
+
checkGradleWrapper(state)
|
|
146
395
|
];
|
|
396
|
+
}
|
|
397
|
+
|
|
398
|
+
function buildWorkflowReadiness(checks: CheckResult[]): WorkflowReadiness[] {
|
|
399
|
+
return (Object.keys(WORKFLOW_TITLES) as WorkflowId[]).map((workflow) => {
|
|
400
|
+
const relevant = checks.filter((check) => check.workflows.includes(workflow));
|
|
401
|
+
const totals = countStatuses(relevant);
|
|
402
|
+
const total = relevant.length || 1;
|
|
403
|
+
const score = Math.max(0, Math.round(((totals.pass + totals.warn * 0.5) / total) * 100));
|
|
404
|
+
const status: CheckStatus =
|
|
405
|
+
totals.fail > 0 ? 'fail' : totals.warn > 0 ? 'warn' : 'pass';
|
|
406
|
+
const nextAction = relevant.find((check) => check.status !== 'pass')?.details || relevant.find((check) => check.status !== 'pass')?.message;
|
|
407
|
+
|
|
408
|
+
return {
|
|
409
|
+
id: workflow,
|
|
410
|
+
title: WORKFLOW_TITLES[workflow],
|
|
411
|
+
status,
|
|
412
|
+
score,
|
|
413
|
+
totals,
|
|
414
|
+
nextAction
|
|
415
|
+
};
|
|
416
|
+
});
|
|
417
|
+
}
|
|
418
|
+
|
|
419
|
+
function applyFixes(state: ProjectState, checks: CheckResult[]): FixResult[] {
|
|
420
|
+
const fixes: FixResult[] = [];
|
|
421
|
+
const missingAssetsSource = checks.find((check) => check.id === 'assets-source' && check.status === 'fail');
|
|
422
|
+
if (missingAssetsSource) {
|
|
423
|
+
const source = state.config?.assets?.source;
|
|
424
|
+
if (source) {
|
|
425
|
+
const dir = path.join(state.cwd, path.dirname(source));
|
|
426
|
+
if (!fs.existsSync(dir)) {
|
|
427
|
+
fs.mkdirSync(dir, { recursive: true });
|
|
428
|
+
fixes.push({ id: 'assets-dir', title: 'Asset directory', status: 'applied', message: `Created ${path.relative(state.cwd, dir)}.` });
|
|
429
|
+
} else {
|
|
430
|
+
fixes.push({ id: 'assets-dir', title: 'Asset directory', status: 'skipped', message: 'Asset directory already exists.' });
|
|
431
|
+
}
|
|
432
|
+
}
|
|
433
|
+
}
|
|
434
|
+
|
|
435
|
+
const capacitorMissing = checks.find((check) => check.id === 'capacitor-config' && check.fixable && state.config?.android?.packaging === 'capacitor');
|
|
436
|
+
if (capacitorMissing && state.config) {
|
|
437
|
+
const webDir = state.config.web?.webDir || 'dist';
|
|
438
|
+
const nextConfig = {
|
|
439
|
+
appId: state.config.appId || 'com.example.myapp',
|
|
440
|
+
appName: state.config.appName || 'MyApp',
|
|
441
|
+
webDir,
|
|
442
|
+
bundledWebRuntime: false
|
|
443
|
+
};
|
|
444
|
+
if (!fs.existsSync(state.capacitorConfigPath)) {
|
|
445
|
+
fs.writeFileSync(state.capacitorConfigPath, `${JSON.stringify(nextConfig, null, 2)}\n`);
|
|
446
|
+
fixes.push({ id: 'capacitor-config', title: 'Capacitor config', status: 'applied', message: 'Created capacitor.config.json.' });
|
|
447
|
+
}
|
|
448
|
+
}
|
|
449
|
+
|
|
450
|
+
const signingWarn = checks.find((check) => check.id === 'android-signing' && check.status === 'warn' && state.config?.android?.signing);
|
|
451
|
+
if (signingWarn && state.config?.android?.signing) {
|
|
452
|
+
const envExamplePath = path.join(state.cwd, '.env.deploid.example');
|
|
453
|
+
const lines = [
|
|
454
|
+
'# Deploid signing placeholders',
|
|
455
|
+
state.config.android.signing.storePasswordEnv ? `${state.config.android.signing.storePasswordEnv}=replace-me` : null,
|
|
456
|
+
state.config.android.signing.keyPasswordEnv ? `${state.config.android.signing.keyPasswordEnv}=replace-me` : null
|
|
457
|
+
].filter((value): value is string => Boolean(value));
|
|
458
|
+
if (lines.length > 1 && !fs.existsSync(envExamplePath)) {
|
|
459
|
+
fs.writeFileSync(envExamplePath, `${lines.join('\n')}\n`);
|
|
460
|
+
fixes.push({ id: 'signing-env-example', title: 'Signing env template', status: 'applied', message: 'Created .env.deploid.example.' });
|
|
461
|
+
}
|
|
462
|
+
}
|
|
463
|
+
|
|
464
|
+
if (fixes.length === 0) {
|
|
465
|
+
fixes.push({ id: 'noop', title: 'Auto-fix', status: 'skipped', message: 'No safe automatic fixes were available.' });
|
|
466
|
+
}
|
|
467
|
+
|
|
468
|
+
return fixes;
|
|
469
|
+
}
|
|
470
|
+
|
|
471
|
+
function printSummary(summary: DoctorSummary, options: DoctorOptions): void {
|
|
472
|
+
const showPasses = options.verbose && !options.summary;
|
|
473
|
+
const showDetails = !options.summary;
|
|
147
474
|
|
|
148
475
|
console.log('Deploid Doctor');
|
|
149
476
|
console.log(`Project: ${summary.cwd}`);
|
|
150
477
|
console.log(
|
|
151
|
-
`Status: ${
|
|
478
|
+
`Status: ${summary.ok ? 'OK' : 'ACTION NEEDED'} (${summary.totals.pass} passed, ${summary.totals.warn} warnings, ${summary.totals.fail} failures)`
|
|
152
479
|
);
|
|
153
480
|
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
481
|
+
console.log('');
|
|
482
|
+
console.log('Workflow readiness:');
|
|
483
|
+
for (const workflow of summary.workflows) {
|
|
484
|
+
console.log(` ${workflow.status.toUpperCase().padEnd(4, ' ')} ${workflow.title.padEnd(20, ' ')} ${String(workflow.score).padStart(3, ' ')}%`);
|
|
485
|
+
if (workflow.nextAction && showDetails) {
|
|
486
|
+
console.log(` ${workflow.nextAction}`);
|
|
487
|
+
}
|
|
488
|
+
}
|
|
157
489
|
|
|
158
|
-
|
|
159
|
-
|
|
490
|
+
const categories: Array<{ key: CheckCategory; title: string }> = [
|
|
491
|
+
{ key: 'project', title: 'Project' },
|
|
492
|
+
{ key: 'release', title: 'Release' },
|
|
493
|
+
{ key: 'plugins', title: 'Plugins' },
|
|
494
|
+
{ key: 'tooling', title: 'Tooling' }
|
|
495
|
+
];
|
|
160
496
|
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
497
|
+
for (const category of categories) {
|
|
498
|
+
const rows = summary.checks.filter((check) => check.category === category.key && (showPasses || check.status !== 'pass'));
|
|
499
|
+
if (rows.length === 0) continue;
|
|
500
|
+
console.log('');
|
|
501
|
+
console.log(`${category.title}:`);
|
|
502
|
+
for (const check of rows) {
|
|
503
|
+
console.log(` ${check.status.toUpperCase().padEnd(4, ' ')} ${check.title.padEnd(22, ' ')} ${check.message}`);
|
|
504
|
+
if (check.details && showDetails) {
|
|
168
505
|
console.log(` ${check.details}`);
|
|
169
506
|
}
|
|
170
507
|
}
|
|
171
508
|
}
|
|
172
509
|
|
|
510
|
+
if (summary.fixes.length > 0) {
|
|
511
|
+
console.log('');
|
|
512
|
+
console.log('Fixes:');
|
|
513
|
+
for (const fix of summary.fixes) {
|
|
514
|
+
console.log(` ${fix.status.toUpperCase().padEnd(7, ' ')} ${fix.title}: ${fix.message}`);
|
|
515
|
+
}
|
|
516
|
+
}
|
|
517
|
+
|
|
173
518
|
if (!summary.ok) {
|
|
174
|
-
const actions = summary.checks.filter((check) => check.status !== 'pass');
|
|
175
519
|
console.log('');
|
|
176
520
|
console.log('Next actions:');
|
|
177
|
-
for (const check of
|
|
521
|
+
for (const check of summary.checks.filter((item) => item.status !== 'pass').slice(0, 6)) {
|
|
178
522
|
console.log(` - ${check.title}: ${check.details || check.message}`);
|
|
179
523
|
}
|
|
180
524
|
}
|
|
181
525
|
}
|
|
182
526
|
|
|
183
|
-
|
|
184
|
-
const
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
527
|
+
function renderMarkdown(summary: DoctorSummary, options: DoctorOptions): string {
|
|
528
|
+
const lines: string[] = [];
|
|
529
|
+
lines.push('# Deploid Doctor');
|
|
530
|
+
lines.push('');
|
|
531
|
+
lines.push(`- Project: \`${summary.cwd}\``);
|
|
532
|
+
lines.push(`- Status: **${summary.ok ? 'OK' : 'ACTION NEEDED'}**`);
|
|
533
|
+
lines.push(`- Totals: ${summary.totals.pass} passed, ${summary.totals.warn} warnings, ${summary.totals.fail} failures`);
|
|
534
|
+
lines.push('');
|
|
535
|
+
lines.push('## Workflow Readiness');
|
|
536
|
+
for (const workflow of summary.workflows) {
|
|
537
|
+
lines.push(`- ${workflow.title}: ${workflow.status.toUpperCase()} (${workflow.score}%)`);
|
|
538
|
+
if (workflow.nextAction && !options.summary) lines.push(` ${workflow.nextAction}`);
|
|
188
539
|
}
|
|
189
540
|
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
'Android SDK',
|
|
201
|
-
'Android SDK directory was not found.',
|
|
202
|
-
'Set ANDROID_HOME or ANDROID_SDK_ROOT, or install the SDK in ~/Android/Sdk.'
|
|
203
|
-
);
|
|
541
|
+
const sections: CheckCategory[] = ['project', 'release', 'plugins', 'tooling'];
|
|
542
|
+
for (const section of sections) {
|
|
543
|
+
const rows = summary.checks.filter((check) => check.category === section && (!options.summary || check.status !== 'pass'));
|
|
544
|
+
if (rows.length === 0) continue;
|
|
545
|
+
lines.push('');
|
|
546
|
+
lines.push(`## ${capitalize(section)}`);
|
|
547
|
+
for (const row of rows) {
|
|
548
|
+
lines.push(`- ${row.status.toUpperCase()} ${row.title}: ${row.message}`);
|
|
549
|
+
if (row.details && !options.summary) lines.push(` ${row.details}`);
|
|
550
|
+
}
|
|
204
551
|
}
|
|
205
552
|
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
'Android SDK',
|
|
211
|
-
`SDK found at ${sdkPath}, but platform-tools is missing.`,
|
|
212
|
-
'Install Android SDK Platform Tools to enable adb-based workflows.'
|
|
213
|
-
);
|
|
553
|
+
if (summary.fixes.length > 0) {
|
|
554
|
+
lines.push('');
|
|
555
|
+
lines.push('## Fixes');
|
|
556
|
+
for (const fix of summary.fixes) lines.push(`- ${fix.status.toUpperCase()} ${fix.title}: ${fix.message}`);
|
|
214
557
|
}
|
|
215
558
|
|
|
216
|
-
return
|
|
559
|
+
return lines.join('\n');
|
|
217
560
|
}
|
|
218
561
|
|
|
219
|
-
function
|
|
220
|
-
|
|
221
|
-
|
|
562
|
+
function renderCi(summary: DoctorSummary): string {
|
|
563
|
+
const lines = [
|
|
564
|
+
`DOCTOR_STATUS=${summary.ok ? 'ok' : 'action-needed'}`,
|
|
565
|
+
`DOCTOR_PASSED=${summary.totals.pass}`,
|
|
566
|
+
`DOCTOR_WARNINGS=${summary.totals.warn}`,
|
|
567
|
+
`DOCTOR_FAILURES=${summary.totals.fail}`
|
|
568
|
+
];
|
|
569
|
+
for (const workflow of summary.workflows) {
|
|
570
|
+
lines.push(`WORKFLOW_${workflow.id.toUpperCase()}=${workflow.status}:${workflow.score}`);
|
|
222
571
|
}
|
|
572
|
+
return lines.join('\n');
|
|
573
|
+
}
|
|
223
574
|
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
575
|
+
function checkBuildCommand(state: ProjectState): CheckResult {
|
|
576
|
+
const buildCommand = state.config?.web?.buildCommand;
|
|
577
|
+
if (!buildCommand) {
|
|
578
|
+
return fail('build-command', 'Build command', 'No `web.buildCommand` configured.', ['init', 'build']);
|
|
579
|
+
}
|
|
228
580
|
|
|
229
|
-
|
|
230
|
-
|
|
581
|
+
const scriptName = inferScriptName(buildCommand);
|
|
582
|
+
if (scriptName && typeof state.packageScripts[scriptName] !== 'string') {
|
|
583
|
+
return warn(
|
|
584
|
+
'build-command',
|
|
585
|
+
'Build command',
|
|
586
|
+
`Configured build command references missing script "${scriptName}".`,
|
|
587
|
+
['init', 'build'],
|
|
588
|
+
'Add the script to package.json or update `web.buildCommand`.'
|
|
589
|
+
);
|
|
231
590
|
}
|
|
232
591
|
|
|
233
|
-
return
|
|
234
|
-
'capacitor-dependency',
|
|
235
|
-
'Capacitor dependency',
|
|
236
|
-
'No Capacitor dependency found in package.json.',
|
|
237
|
-
'Run `deploid init` or install @capacitor/core and @capacitor/cli if this project targets Android.'
|
|
238
|
-
);
|
|
592
|
+
return pass('build-command', 'Build command', `Configured build command: ${buildCommand}.`, ['init', 'build']);
|
|
239
593
|
}
|
|
240
594
|
|
|
241
|
-
function checkWebDir(
|
|
595
|
+
function checkWebDir(state: ProjectState): CheckResult {
|
|
596
|
+
const webDir = state.config?.web?.webDir;
|
|
242
597
|
if (!webDir) {
|
|
243
|
-
return
|
|
598
|
+
return fail('web-output', 'Web output directory', 'No `web.webDir` configured.', ['init', 'build']);
|
|
244
599
|
}
|
|
245
600
|
|
|
246
|
-
const fullPath = path.join(cwd, webDir);
|
|
247
|
-
if (fs.existsSync(fullPath)) {
|
|
248
|
-
return
|
|
601
|
+
const fullPath = path.join(state.cwd, webDir);
|
|
602
|
+
if (!fs.existsSync(fullPath)) {
|
|
603
|
+
return warn(
|
|
604
|
+
'web-output',
|
|
605
|
+
'Web output directory',
|
|
606
|
+
`${webDir} does not exist yet.`,
|
|
607
|
+
['build'],
|
|
608
|
+
'Run your web build before packaging if you expect ready-to-sync assets.'
|
|
609
|
+
);
|
|
249
610
|
}
|
|
250
611
|
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
612
|
+
const indexPath = path.join(fullPath, 'index.html');
|
|
613
|
+
if (!fs.existsSync(indexPath)) {
|
|
614
|
+
return warn(
|
|
615
|
+
'web-output',
|
|
616
|
+
'Web output directory',
|
|
617
|
+
`${webDir} exists but index.html is missing.`,
|
|
618
|
+
['build'],
|
|
619
|
+
'Check `web.webDir` or your framework build output.'
|
|
620
|
+
);
|
|
621
|
+
}
|
|
622
|
+
|
|
623
|
+
return pass('web-output', 'Web output directory', `Found ${webDir}.`, ['build']);
|
|
257
624
|
}
|
|
258
625
|
|
|
259
|
-
function checkAssetsSource(
|
|
626
|
+
function checkAssetsSource(state: ProjectState): CheckResult {
|
|
627
|
+
const source = state.config?.assets?.source;
|
|
260
628
|
if (!source) {
|
|
261
|
-
return warn('assets-source', 'Asset source', 'No `assets.source` configured.');
|
|
629
|
+
return warn('assets-source', 'Asset source', 'No `assets.source` configured.', ['init'], undefined, true);
|
|
262
630
|
}
|
|
263
631
|
|
|
264
|
-
const sourcePath = path.join(cwd, source);
|
|
632
|
+
const sourcePath = path.join(state.cwd, source);
|
|
265
633
|
if (fs.existsSync(sourcePath)) {
|
|
266
|
-
return pass('assets-source', 'Asset source', `Found ${source}
|
|
634
|
+
return pass('assets-source', 'Asset source', `Found ${source}.`, ['init']);
|
|
267
635
|
}
|
|
268
636
|
|
|
269
637
|
return fail(
|
|
270
638
|
'assets-source',
|
|
271
639
|
'Asset source',
|
|
272
640
|
`${source} does not exist.`,
|
|
273
|
-
'
|
|
641
|
+
['init'],
|
|
642
|
+
'Add the source asset or update `assets.source` before running `deploid assets`.',
|
|
643
|
+
true
|
|
274
644
|
);
|
|
275
645
|
}
|
|
276
646
|
|
|
277
|
-
function checkSigning(
|
|
278
|
-
|
|
279
|
-
signing: { keystorePath?: string; storePasswordEnv?: string; keyPasswordEnv?: string } | undefined
|
|
280
|
-
): CheckResult {
|
|
647
|
+
function checkSigning(state: ProjectState): CheckResult {
|
|
648
|
+
const signing = state.config?.android?.signing;
|
|
281
649
|
if (!signing?.keystorePath) {
|
|
282
|
-
return warn('android-signing', 'Android signing', 'No Android signing config found.');
|
|
650
|
+
return warn('android-signing', 'Android signing', 'No Android signing config found.', ['release']);
|
|
283
651
|
}
|
|
284
652
|
|
|
285
|
-
const keystorePath = path.join(cwd, signing.keystorePath);
|
|
653
|
+
const keystorePath = path.join(state.cwd, signing.keystorePath);
|
|
286
654
|
const missingEnvVars = [signing.storePasswordEnv, signing.keyPasswordEnv]
|
|
287
655
|
.filter((name): name is string => Boolean(name))
|
|
288
656
|
.filter((name) => !process.env[name]);
|
|
@@ -292,6 +660,7 @@ function checkSigning(
|
|
|
292
660
|
'android-signing',
|
|
293
661
|
'Android signing',
|
|
294
662
|
`Keystore file is missing: ${signing.keystorePath}.`,
|
|
663
|
+
['release'],
|
|
295
664
|
'Create the keystore or fix `android.signing.keystorePath`.'
|
|
296
665
|
);
|
|
297
666
|
}
|
|
@@ -301,61 +670,213 @@ function checkSigning(
|
|
|
301
670
|
'android-signing',
|
|
302
671
|
'Android signing',
|
|
303
672
|
`Keystore found, but env vars are missing: ${missingEnvVars.join(', ')}.`,
|
|
673
|
+
['release'],
|
|
304
674
|
'Release builds will fail until those password env vars are exported.'
|
|
305
675
|
);
|
|
306
676
|
}
|
|
307
677
|
|
|
308
|
-
return pass('android-signing', 'Android signing', 'Signing keystore and env vars look ready.');
|
|
678
|
+
return pass('android-signing', 'Android signing', 'Signing keystore and env vars look ready.', ['release']);
|
|
309
679
|
}
|
|
310
680
|
|
|
311
|
-
function checkCapacitorConfig(
|
|
312
|
-
if (packaging !== 'capacitor') {
|
|
313
|
-
return warn('capacitor-config', 'Capacitor config', `Packaging engine is ${packaging || 'unknown'}
|
|
681
|
+
function checkCapacitorConfig(state: ProjectState): CheckResult {
|
|
682
|
+
if (state.config?.android?.packaging !== 'capacitor') {
|
|
683
|
+
return warn('capacitor-config', 'Capacitor config', `Packaging engine is ${state.config?.android?.packaging || 'unknown'}.`, ['build']);
|
|
314
684
|
}
|
|
315
685
|
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
return pass('capacitor-config', 'Capacitor config', 'Found capacitor.config.json.');
|
|
686
|
+
if (fs.existsSync(state.capacitorConfigPath)) {
|
|
687
|
+
return pass('capacitor-config', 'Capacitor config', 'Found capacitor.config.json.', ['build']);
|
|
319
688
|
}
|
|
320
689
|
|
|
321
690
|
return warn(
|
|
322
691
|
'capacitor-config',
|
|
323
692
|
'Capacitor config',
|
|
324
693
|
'capacitor.config.json is missing.',
|
|
325
|
-
'
|
|
694
|
+
['build'],
|
|
695
|
+
'Run `deploid init`, `deploid package`, or `deploid doctor --fix` to scaffold Capacitor configuration.',
|
|
696
|
+
true
|
|
326
697
|
);
|
|
327
698
|
}
|
|
328
699
|
|
|
329
|
-
function checkAndroidProject(
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
return pass('android-project', 'Android project', 'Found android/ project.');
|
|
700
|
+
function checkAndroidProject(state: ProjectState): CheckResult {
|
|
701
|
+
if (fs.existsSync(state.androidDir)) {
|
|
702
|
+
return pass('android-project', 'Android project', 'Found android/ project.', ['build', 'deploy']);
|
|
333
703
|
}
|
|
334
704
|
|
|
335
705
|
return warn(
|
|
336
706
|
'android-project',
|
|
337
707
|
'Android project',
|
|
338
708
|
'android/ project has not been generated yet.',
|
|
709
|
+
['build', 'deploy'],
|
|
339
710
|
'Run `deploid package` before building or deploying Android artifacts.'
|
|
340
711
|
);
|
|
341
712
|
}
|
|
342
713
|
|
|
343
|
-
function
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
714
|
+
function checkVersioning(state: ProjectState): CheckResult {
|
|
715
|
+
const version = state.config?.android?.version;
|
|
716
|
+
if (!version?.code || !version?.name) {
|
|
717
|
+
return warn('versioning', 'Version metadata', 'Android version code/name are incomplete.', ['release']);
|
|
718
|
+
}
|
|
719
|
+
|
|
720
|
+
if (version.code < 1) {
|
|
721
|
+
return fail('versioning', 'Version metadata', 'Android version code must be >= 1.', ['release']);
|
|
722
|
+
}
|
|
723
|
+
|
|
724
|
+
return pass('versioning', 'Version metadata', `Configured version ${version.name} (${version.code}).`, ['release']);
|
|
725
|
+
}
|
|
726
|
+
|
|
727
|
+
function checkCommand(command: string, args: string[], title: string, details: string, workflows: WorkflowId[]): CheckResult {
|
|
728
|
+
const result = spawnSync(command, args, { encoding: 'utf8' });
|
|
729
|
+
if (result.status === 0) {
|
|
730
|
+
const output = `${result.stdout || ''} ${result.stderr || ''}`.trim().split('\n')[0]?.trim();
|
|
731
|
+
return pass(command, title, `${command} is available.`, workflows, output || details);
|
|
732
|
+
}
|
|
733
|
+
|
|
734
|
+
return fail(command, title, `${command} is not available.`, workflows, result.error?.message || result.stderr?.trim() || details);
|
|
735
|
+
}
|
|
736
|
+
|
|
737
|
+
function checkNpm(): CheckResult {
|
|
738
|
+
const check = checkCommand('npm', ['--version'], 'npm', 'Used by init, plugin setup, and Capacitor workflows.', ['init', 'build', 'release', 'desktop']);
|
|
739
|
+
if (check.status === 'pass') {
|
|
740
|
+
const major = Number.parseInt((check.details || '').split('.')[0] || '0', 10);
|
|
741
|
+
if (major > 0 && major < 9) {
|
|
742
|
+
return warn('npm', 'npm', `npm ${check.details} is available but older than recommended.`, ['init', 'build', 'release', 'desktop']);
|
|
743
|
+
}
|
|
744
|
+
}
|
|
745
|
+
return check;
|
|
746
|
+
}
|
|
747
|
+
|
|
748
|
+
function checkJava(): CheckResult {
|
|
749
|
+
const result = spawnSync('java', ['-version'], { encoding: 'utf8' });
|
|
750
|
+
if (result.status !== 0) {
|
|
751
|
+
return fail('java', 'Java', 'java is not available.', ['build', 'release'], result.error?.message || 'Install Java 17+ for Android builds.');
|
|
752
|
+
}
|
|
753
|
+
const firstLine = `${result.stdout || ''} ${result.stderr || ''}`.trim().split('\n')[0]?.trim();
|
|
754
|
+
const match = firstLine.match(/version "(\d+)/);
|
|
755
|
+
const major = Number(match?.[1] || '0');
|
|
756
|
+
if (major > 0 && major < 17) {
|
|
757
|
+
return warn('java', 'Java', `Java ${major} is installed but Java 17+ is recommended.`, ['build', 'release'], firstLine);
|
|
758
|
+
}
|
|
759
|
+
return pass('java', 'Java', 'java is available.', ['build', 'release'], firstLine);
|
|
760
|
+
}
|
|
761
|
+
|
|
762
|
+
function checkAdb(): CheckResult {
|
|
763
|
+
const version = checkCommand('adb', ['version'], 'ADB', 'Required for device listing, deploy, and logs.', ['deploy']);
|
|
764
|
+
if (version.status !== 'pass') return version;
|
|
765
|
+
|
|
766
|
+
const devicesResult = spawnSync('adb', ['devices'], { encoding: 'utf8' });
|
|
767
|
+
const lines = `${devicesResult.stdout || ''}`.split('\n').filter((line) => /\t/.test(line));
|
|
768
|
+
const unauthorized = lines.filter((line) => line.includes('unauthorized') || line.includes('offline'));
|
|
769
|
+
if (unauthorized.length > 0) {
|
|
770
|
+
return warn('adb', 'ADB', `ADB is available but ${unauthorized.length} device(s) need attention.`, ['deploy'], unauthorized.join(', '));
|
|
771
|
+
}
|
|
772
|
+
if (lines.length === 0) {
|
|
773
|
+
return warn('adb', 'ADB', 'ADB is available but no devices are connected.', ['deploy']);
|
|
774
|
+
}
|
|
775
|
+
return pass('adb', 'ADB', `ADB is available with ${lines.length} connected device(s).`, ['deploy'], version.details);
|
|
776
|
+
}
|
|
777
|
+
|
|
778
|
+
function checkAndroidSdk(): CheckResult {
|
|
779
|
+
const envHome = process.env.ANDROID_HOME || process.env.ANDROID_SDK_ROOT;
|
|
780
|
+
const sdkPath = envHome || path.join(process.env.HOME || '', 'Android', 'Sdk');
|
|
781
|
+
|
|
782
|
+
if (!sdkPath || !fs.existsSync(sdkPath)) {
|
|
783
|
+
return fail(
|
|
784
|
+
'android-sdk',
|
|
785
|
+
'Android SDK',
|
|
786
|
+
'Android SDK directory was not found.',
|
|
787
|
+
['build', 'release', 'deploy'],
|
|
788
|
+
'Set ANDROID_HOME or ANDROID_SDK_ROOT, or install the SDK in ~/Android/Sdk.'
|
|
789
|
+
);
|
|
790
|
+
}
|
|
791
|
+
|
|
792
|
+
const platformToolsPath = path.join(sdkPath, 'platform-tools');
|
|
793
|
+
if (!fs.existsSync(platformToolsPath)) {
|
|
794
|
+
return warn(
|
|
795
|
+
'android-sdk',
|
|
796
|
+
'Android SDK',
|
|
797
|
+
`SDK found at ${sdkPath}, but platform-tools is missing.`,
|
|
798
|
+
['build', 'release', 'deploy'],
|
|
799
|
+
'Install Android SDK Platform Tools to enable adb-based workflows.'
|
|
800
|
+
);
|
|
801
|
+
}
|
|
802
|
+
|
|
803
|
+
const hasBuildTools = fs.existsSync(path.join(sdkPath, 'build-tools'));
|
|
804
|
+
if (!hasBuildTools) {
|
|
805
|
+
return warn('android-sdk', 'Android SDK', `SDK found at ${sdkPath}, but build-tools is missing.`, ['build', 'release']);
|
|
806
|
+
}
|
|
807
|
+
|
|
808
|
+
return pass('android-sdk', 'Android SDK', `SDK found at ${sdkPath}.`, ['build', 'release', 'deploy']);
|
|
809
|
+
}
|
|
810
|
+
|
|
811
|
+
function checkGradleWrapper(state: ProjectState): CheckResult {
|
|
812
|
+
if (!fs.existsSync(state.androidDir)) {
|
|
813
|
+
return warn('gradle-wrapper', 'Gradle wrapper', 'Skipped because android/ has not been generated yet.', ['build', 'release']);
|
|
814
|
+
}
|
|
815
|
+
const wrapper = path.join(state.androidDir, 'gradlew');
|
|
816
|
+
if (!fs.existsSync(wrapper)) {
|
|
817
|
+
return fail('gradle-wrapper', 'Gradle wrapper', 'android/ exists but gradlew is missing.', ['build', 'release']);
|
|
818
|
+
}
|
|
819
|
+
|
|
820
|
+
const result = spawnSync(wrapper, ['-v'], { cwd: state.androidDir, encoding: 'utf8' });
|
|
821
|
+
if (result.status !== 0) {
|
|
822
|
+
return warn('gradle-wrapper', 'Gradle wrapper', 'Gradle wrapper exists but did not respond cleanly.', ['build', 'release']);
|
|
823
|
+
}
|
|
824
|
+
const firstLine = `${result.stdout || ''}${result.stderr || ''}`.split('\n').find((line) => line.trim().length > 0)?.trim();
|
|
825
|
+
return pass('gradle-wrapper', 'Gradle wrapper', 'Gradle wrapper is present.', ['build', 'release'], firstLine);
|
|
826
|
+
}
|
|
827
|
+
|
|
828
|
+
function countStatuses(checks: CheckResult[]): Record<CheckStatus, number> {
|
|
829
|
+
return {
|
|
830
|
+
pass: checks.filter((check) => check.status === 'pass').length,
|
|
831
|
+
warn: checks.filter((check) => check.status === 'warn').length,
|
|
832
|
+
fail: checks.filter((check) => check.status === 'fail').length
|
|
833
|
+
};
|
|
834
|
+
}
|
|
835
|
+
|
|
836
|
+
function pass(
|
|
837
|
+
id: string,
|
|
838
|
+
title: string,
|
|
839
|
+
message: string,
|
|
840
|
+
workflows: WorkflowId[],
|
|
841
|
+
details?: string,
|
|
842
|
+
fixable = false
|
|
843
|
+
): CheckResult {
|
|
844
|
+
return { id, category: categoryFor(id), title, status: 'pass', message, details, workflows, fixable };
|
|
347
845
|
}
|
|
348
846
|
|
|
349
|
-
function
|
|
350
|
-
|
|
847
|
+
function warn(
|
|
848
|
+
id: string,
|
|
849
|
+
title: string,
|
|
850
|
+
message: string,
|
|
851
|
+
workflows: WorkflowId[],
|
|
852
|
+
details?: string,
|
|
853
|
+
fixable = false
|
|
854
|
+
): CheckResult {
|
|
855
|
+
return { id, category: categoryFor(id), title, status: 'warn', message, details, workflows, fixable };
|
|
856
|
+
}
|
|
857
|
+
|
|
858
|
+
function fail(
|
|
859
|
+
id: string,
|
|
860
|
+
title: string,
|
|
861
|
+
message: string,
|
|
862
|
+
workflows: WorkflowId[],
|
|
863
|
+
details?: string,
|
|
864
|
+
fixable = false
|
|
865
|
+
): CheckResult {
|
|
866
|
+
return { id, category: categoryFor(id), title, status: 'fail', message, details, workflows, fixable };
|
|
351
867
|
}
|
|
352
868
|
|
|
353
|
-
function
|
|
354
|
-
|
|
869
|
+
function categoryFor(id: string): CheckCategory {
|
|
870
|
+
if (['node', 'npm', 'npx', 'java', 'adb', 'android-sdk', 'gradle-wrapper'].includes(id)) return 'tooling';
|
|
871
|
+
if (['capacitor-dependency', 'electron-dependency', 'plugin-state'].includes(id)) return 'plugins';
|
|
872
|
+
if (['android-signing', 'versioning', 'play-service-account', 'github-release', 'package-build-meta'].includes(id)) return 'release';
|
|
873
|
+
if (['build-command', 'capacitor-sync'].includes(id)) return 'workflows';
|
|
874
|
+
return 'project';
|
|
355
875
|
}
|
|
356
876
|
|
|
357
|
-
function
|
|
358
|
-
|
|
877
|
+
function inferScriptName(command: string): string | null {
|
|
878
|
+
const match = command.match(/(?:npm|pnpm|bun)\s+run\s+([a-zA-Z0-9:_-]+)/) || command.match(/yarn\s+([a-zA-Z0-9:_-]+)/);
|
|
879
|
+
return match?.[1] || null;
|
|
359
880
|
}
|
|
360
881
|
|
|
361
882
|
function findExistingPath(cwd: string, candidates: string[]): string | null {
|
|
@@ -366,10 +887,10 @@ function findExistingPath(cwd: string, candidates: string[]): string | null {
|
|
|
366
887
|
return null;
|
|
367
888
|
}
|
|
368
889
|
|
|
369
|
-
async function loadProjectConfig(configPath: string): Promise<
|
|
890
|
+
async function loadProjectConfig(configPath: string): Promise<DeploidConfigShape | null> {
|
|
370
891
|
try {
|
|
371
892
|
const mod = await import(pathToFileUrl(configPath).href);
|
|
372
|
-
return (mod.default || mod) as
|
|
893
|
+
return (mod.default || mod) as DeploidConfigShape;
|
|
373
894
|
} catch {
|
|
374
895
|
return null;
|
|
375
896
|
}
|
|
@@ -390,9 +911,21 @@ function readJson<T>(filePath: string): T | null {
|
|
|
390
911
|
}
|
|
391
912
|
}
|
|
392
913
|
|
|
914
|
+
function safeRead(filePath: string): string {
|
|
915
|
+
try {
|
|
916
|
+
return fs.readFileSync(filePath, 'utf8');
|
|
917
|
+
} catch {
|
|
918
|
+
return '';
|
|
919
|
+
}
|
|
920
|
+
}
|
|
921
|
+
|
|
393
922
|
function asRecord(value: unknown): Record<string, unknown> {
|
|
394
923
|
return typeof value === 'object' && value !== null ? (value as Record<string, unknown>) : {};
|
|
395
924
|
}
|
|
396
925
|
|
|
926
|
+
function capitalize(value: string): string {
|
|
927
|
+
return value.charAt(0).toUpperCase() + value.slice(1);
|
|
928
|
+
}
|
|
929
|
+
|
|
397
930
|
export default plugin;
|
|
398
931
|
export { inspectProject, plugin };
|