499300fd76
using `windowsHide: true` is causing an issue on windows: Ctrl + C handling isn't enabled and no `SIGINT` is sent to the child process when users exit the process. See https://github.com/nodejs/node/issues/29837 and https://github.com/nodejs/node-v0.x-archive/issues/5054 for reference. This will cause leftover processes throughout nx. This PR sets `windowsHide: false` everywhere except for the plugin workers and some short-lived utils. They `spawn` child processes but have explicit handling to make sure they kill themselves when the parent process dies, so the missing Ctrl + C handling doesn't cause issues. We will follow up to make sure any other culprits that still cause windows popups (especially when used through Nx Console) are handled. Leaving no leftover processes running is more important for now, though. Keep in mind the underlying tooling (like vite) might have some windows popups themselves that Nx will inherit.
105 lines
3.0 KiB
TypeScript
105 lines
3.0 KiB
TypeScript
import * as chalk from 'chalk';
|
|
import * as typedoc from 'typedoc';
|
|
import { execSync, ExecSyncOptions } from 'child_process';
|
|
import { cpSync, readFileSync, rmSync, unlinkSync, writeFileSync } from 'fs';
|
|
import { join } from 'path';
|
|
|
|
export async function generateDevkitDocumentation() {
|
|
console.log(`\n${chalk.blue('i')} Generating Documentation for Devkit\n`);
|
|
|
|
const execSyncOptions: ExecSyncOptions = {
|
|
stdio: 'true' === 'true' ? 'inherit' : 'ignore',
|
|
// stdio: process.env.CI === 'true' ? 'inherit' : 'ignore',
|
|
windowsHide: false,
|
|
};
|
|
|
|
execSync('nx run-many -t build -p devkit,typedoc-theme', execSyncOptions);
|
|
|
|
rmSync('node_modules/@nx/typedoc-theme', { recursive: true, force: true });
|
|
|
|
cpSync('dist/typedoc-theme', 'node_modules/@nx/typedoc-theme', {
|
|
recursive: true,
|
|
});
|
|
|
|
cpSync(
|
|
'packages/devkit/tsconfig.lib.json',
|
|
'build/packages/devkit/tsconfig.lib.json',
|
|
{ recursive: true }
|
|
);
|
|
|
|
writeFileSync(
|
|
'build/packages/devkit/tsconfig.lib.json',
|
|
readFileSync('build/packages/devkit/tsconfig.lib.json')
|
|
.toString()
|
|
.replace(
|
|
'"extends": "./tsconfig.json"',
|
|
'"extends": "../../../packages/devkit/tsconfig.json"'
|
|
)
|
|
);
|
|
|
|
rmSync('docs/generated/devkit', { recursive: true, force: true });
|
|
|
|
const commonTypedocOptions: Partial<typedoc.TypeDocOptions> & {
|
|
[key: string]: unknown;
|
|
} = {
|
|
plugin: ['typedoc-plugin-markdown', '@nx/typedoc-theme'],
|
|
disableSources: true,
|
|
theme: 'nx-markdown-theme',
|
|
readme: 'none',
|
|
hideBreadcrumbs: true,
|
|
allReflectionsHaveOwnDocument: true,
|
|
} as const;
|
|
|
|
await runTypedoc({
|
|
...commonTypedocOptions,
|
|
entryPoints: ['build/packages/devkit/index.d.ts'],
|
|
tsconfig: 'build/packages/devkit/tsconfig.lib.json',
|
|
out: 'docs/generated/devkit',
|
|
excludePrivate: true,
|
|
publicPath: '../../devkit/',
|
|
});
|
|
|
|
await runTypedoc({
|
|
...commonTypedocOptions,
|
|
entryPoints: ['build/packages/devkit/ngcli-adapter.d.ts'],
|
|
tsconfig: 'build/packages/devkit/tsconfig.lib.json',
|
|
out: 'docs/generated/devkit/ngcli_adapter',
|
|
publicPath: '../../devkit/ngcli_adapter/',
|
|
});
|
|
|
|
rmSync('build/packages/devkit/tsconfig.lib.json', {
|
|
recursive: true,
|
|
force: true,
|
|
});
|
|
rmSync('docs/generated/devkit/.nojekyll', { recursive: true, force: true });
|
|
|
|
execSync(
|
|
`pnpm prettier docs/generated/devkit --write --config ${join(
|
|
__dirname,
|
|
'..',
|
|
'..',
|
|
'..',
|
|
'.prettierrc'
|
|
)}`,
|
|
execSyncOptions
|
|
);
|
|
}
|
|
|
|
async function runTypedoc(
|
|
options: Partial<typedoc.TypeDocOptions> & { [key: string]: unknown }
|
|
) {
|
|
const app = await typedoc.Application.bootstrapWithPlugins(
|
|
options as Partial<typedoc.TypeDocOptions>,
|
|
[
|
|
new typedoc.TypeDocReader(),
|
|
new typedoc.PackageJsonReader(),
|
|
new typedoc.TSConfigReader(),
|
|
]
|
|
);
|
|
const project = await app.convert();
|
|
if (!project) {
|
|
throw new Error('Failed to convert the project');
|
|
}
|
|
await app.generateDocs(project, app.options.getValue('out'));
|
|
}
|