trezor-suite/scripts/updateProjectReferences.ts

import fs from 'fs';
import path from 'path';
import prettier from 'prettier';
import { minimatch } from 'minimatch';
import yargs from 'yargs';
import { hideBin } from 'yargs/helpers';
import chalk from 'chalk';

import { getWorkspacesList } from './utils/getWorkspacesList';
import { getPrettierConfig } from './utils/getPrettierConfig';

const rootTsConfigLocation = path.join(__dirname, '..', 'tsconfig.json');

(async () => {
    const { argv } = yargs(hideBin(process.argv))
        .array('read-only')
        .array('ignore')
        .array('typings')
        .boolean('test') as any;

    const readOnlyGlobs = argv.readOnly || [];
    const ignoreGlobs = argv.ignore || [];
    const typingPaths = argv.typings || [];
    const isTesting = argv.test || false;

    const rootConfig = JSON.parse(fs.readFileSync(rootTsConfigLocation).toString());
    const nextRootReferences: { path: string }[] = [];

    const prettierConfig = await getPrettierConfig();

    const serializeConfig = (config: any, stringifySpaces?: number) => {
        try {
            return prettier.format(
                JSON.stringify(config, null, stringifySpaces).replace(/\\\\/g, '/'),
                prettierConfig,
            );
        } catch (error) {
            console.error(error);
            process.exit(1);
        }
    };

    const workspaces = getWorkspacesList();

    // NOTE: Workspace keys must be sorted due to file systems being a part of the equation...
    Object.keys(workspaces)
        .sort()
        .forEach(async workspaceName => {
            const workspace = workspaces[workspaceName];

            if (workspace.location === '.') {
                // Skip root workspace
                return;
            }

            if (ignoreGlobs.some((path: string) => minimatch(workspace.location, path))) {
                return;
            }

            nextRootReferences.push({
                path: workspace.location,
            });

            const workspacePath = path.resolve(process.cwd(), workspace.location);
            const workspaceConfigPath = path.resolve(workspacePath, 'tsconfig.json');

            const defaultWorkspaceConfig = {
                extends: path.relative(workspacePath, path.resolve(process.cwd(), 'tsconfig.json')),
                compilerOptions: { outDir: './libDev' },
                include: ['.'],
            };

            let workspaceConfig;
            try {
                workspaceConfig = fs.existsSync(workspaceConfigPath)
                    ? JSON.parse(fs.readFileSync(workspaceConfigPath).toString())
                    : defaultWorkspaceConfig;
            } catch {
                console.error(chalk.bold.red('Error while parsing file: '), workspaceConfigPath);
                process.exit(1);
            }

            const nextWorkspaceReferences = typingPaths.map((typingPath: string) => ({
                path: path.relative(workspacePath, path.resolve(process.cwd(), typingPath)),
            }));

            Object.values(workspace.workspaceDependencies).forEach(dependencyLocation => {
                const dependencyPath = path.resolve(process.cwd(), dependencyLocation);
                const relativeDependencyPath = path.relative(workspacePath, dependencyPath);

                if (relativeDependencyPath) {
                    nextWorkspaceReferences.push({ path: relativeDependencyPath });
                } else {
                    console.warn(
                        chalk.yellow(
                            `${dependencyLocation} might be referencing itself in package.json#dependencies.`,
                        ),
                    );
                }
            });

            if (isTesting) {
                if (
                    (await serializeConfig(workspaceConfig.references ?? [])) !==
                    (await serializeConfig(nextWorkspaceReferences))
                ) {
                    console.error(
                        chalk.red(
                            `TypeScript project references in ${workspace.location} are inconsistent with package.json#dependencies.`,
                        ),
                        chalk.red.bold(`Run "yarn update-project-references" to fix them.`),
                    );

                    process.exit(1);
                }

                return;
            }

            workspaceConfig.references = nextWorkspaceReferences;

            if (!readOnlyGlobs.some((path: string) => minimatch(workspace.location, path))) {
                fs.writeFileSync(workspaceConfigPath, await serializeConfig(workspaceConfig));
            }

            // Copy references also to tsconfig.lib.json if exists
            const workspaceLibConfigPath = path.resolve(workspacePath, 'tsconfig.lib.json');
            if (fs.existsSync(workspaceLibConfigPath)) {
                try {
                    const workspaceLibConfig = JSON.parse(
                        fs.readFileSync(workspaceLibConfigPath).toString(),
                    );

                    workspaceLibConfig.references = nextWorkspaceReferences;

                    if (
                        !readOnlyGlobs.some((path: string) => minimatch(workspace.location, path))
                    ) {
                        fs.writeFileSync(
                            workspaceLibConfigPath,
                            await serializeConfig(workspaceLibConfig, 2),
                        );
                    }
                } catch {
                    console.error(
                        chalk.bold.red('Error while parsing file: '),
                        workspaceLibConfigPath,
                    );
                    process.exit(1);
                }
            }
        });

    if (isTesting) {
        if (
            (await serializeConfig(rootConfig.references)) !==
            (await serializeConfig(nextRootReferences))
        ) {
            console.error(
                `TypeScript project references in root tsconfig.json are inconsistent.`,
                `Run "yarn update-project-references" to fix them.`,
            );

            process.exit(1);
        }

        return;
    }

    rootConfig.references = nextRootReferences;

    fs.writeFileSync(rootTsConfigLocation, await serializeConfig(rootConfig));
})();