json-help.mts

/**
 * @license
 * Copyright Google LLC All Rights Reserved.
 *
 * Use of this source code is governed by an MIT-style license that can be
 * found in the LICENSE file at https://angular.dev/license
 */

import{spawnSync}from'node:child_process';
import{promisesasfs}from'node:fs';
import*asosfrom'node:os';
import*aspathfrom'node:path';
import{fileURLToPath}from'node:url';
importcreatefrom'./create.mjs';

const__dirname=path.dirname(fileURLToPath(import.meta.url));

exportasyncfunctioncreateTemporaryProject(): Promise<string>{
console.info('Creating temporary project...');
constnewProjectTempRoot=awaitfs.mkdtemp(path.join(os.tmpdir(),'angular-cli-create-'));
constnewProjectName='help-project';
constnewProjectRoot=path.join(newProjectTempRoot,newProjectName);
awaitcreate({_: [newProjectName]},newProjectTempRoot);

returnnewProjectRoot;
}

exportinterfaceJsonHelpOptions{
temporaryProjectRoot?: string;
}

exportdefaultasyncfunction({ temporaryProjectRoot }: JsonHelpOptions){
console.info('Gathering JSON Help...');

constnewProjectRoot=temporaryProjectRoot??(awaitcreateTemporaryProject());
constngPath=path.join(newProjectRoot,'node_modules/.bin/ng');
consthelpOutputRoot=path.join(__dirname,'../dist/@angular/cli/help');

awaitfs.mkdir(helpOutputRoot);

// eslint-disable-next-line @typescript-eslint/no-explicit-any
construnNgCommandJsonHelp=async(args: string[]): Promise<any>=>{
const{ stdout, status }=spawnSync(ngPath,[...args,'--json-help','--help'],{
cwd: newProjectRoot,
maxBuffer: 200_0000,
stdio: ['ignore','pipe','inherit'],
});

if(status===0){
try{
returnJSON.parse(stdout.toString().trim());
}catch(e){
console.error(`${e}`);
}
}

thrownewError(`Command failed: ${ngPath}${args.map((x)=>JSON.stringify(x)).join(', ')}.`);
};

const{subcommands: commands=[]}=awaitrunNgCommandJsonHelp([]);
// eslint-disable-next-line @typescript-eslint/no-explicit-any
constcommandsHelp=commands.map((command: any)=>
runNgCommandJsonHelp([command.name]).then((c)=>({
 ...command,
 ...c,
})),
);

forawait(constcommandofcommandsHelp){
constcommandName=command.name;
constcommandOptionNames=newSet([
 ...command.options.map(({ name }: {name: string})=>name),
]);
// eslint-disable-next-line @typescript-eslint/no-explicit-any
constsubCommandsHelp=command.subcommands?.map((subcommand: any)=>
runNgCommandJsonHelp([command.name,subcommand.name]).then((s)=>({
 ...s,
 ...subcommand,
// Filter options which are inherited from the parent command.
// Ex: `interactive` in `ng generate lib`.
// eslint-disable-next-line @typescript-eslint/no-explicit-any
options: s.options.filter((o: any)=>!commandOptionNames.has(o.name)),
})),
);

constjsonOutput=JSON.stringify(
{
 ...command,
subcommands: subCommandsHelp ? awaitPromise.all(subCommandsHelp) : undefined,
},
undefined,
2,
);

constfilePath=path.join(helpOutputRoot,commandName+'.json');
awaitfs.writeFile(filePath,jsonOutput);
console.info(filePath);
}
}