| 6dd74de | | | 1 | /** |
| 6dd74de | | | 2 | * Verify the as-built tarballs can be imported into a fresh, out-of-tree TypeScript project. |
| 6dd74de | | | 3 | */ |
| 6dd74de | | | 4 | |
| 6dd74de | | | 5 | /* eslint-disable no-console */ |
| 6dd74de | | | 6 | import { mkdtemp, mkdir, writeFile, readFile, readdir, copyFile, rm } from 'node:fs/promises'; |
| 6dd74de | | | 7 | import { execFileSync } from 'child_process'; |
| 6dd74de | | | 8 | import * as path from 'path'; |
| 6dd74de | | | 9 | import { fileURLToPath } from 'url'; |
| 6dd74de | | | 10 | import { tmpdir } from 'node:os'; |
| 6dd74de | | | 11 | |
| 6dd74de | | | 12 | const __filename = fileURLToPath(import.meta.url); // get the resolved path to the file |
| 6dd74de | | | 13 | const __dirname = path.dirname(__filename); // get the name of the directory |
| 6dd74de | | | 14 | |
| 6dd74de | | | 15 | /** |
| 6dd74de | | | 16 | * Packages to build and import |
| 6dd74de | | | 17 | */ |
| 6dd74de | | | 18 | const PACKAGES = { |
| 6dd74de | | | 19 | mermaid: 'mermaid', |
| 6dd74de | | | 20 | '@mermaid-js/layout-elk': 'mermaid-layout-elk', |
| 6dd74de | | | 21 | // TODO: these don't import cleanly yet due to exotic tsconfig.json requirements |
| 6dd74de | | | 22 | // '@mermaid-js/mermaid-zenuml': 'mermaid-zenuml', |
| 6dd74de | | | 23 | // '@mermaid-js/parser': 'parser', |
| 6dd74de | | | 24 | }; |
| 6dd74de | | | 25 | |
| 6dd74de | | | 26 | /** |
| 6dd74de | | | 27 | * Files to create in the temporary package. |
| 6dd74de | | | 28 | */ |
| 6dd74de | | | 29 | const SRC = { |
| 6dd74de | | | 30 | // a minimal description of a buildable package |
| 6dd74de | | | 31 | 'package.json': (tarballs: Record<string, string>) => |
| 6dd74de | | | 32 | JSON.stringify( |
| 6dd74de | | | 33 | { |
| 6dd74de | | | 34 | dependencies: tarballs, |
| 6dd74de | | | 35 | scripts: { build: 'tsc -b --verbose' }, |
| 6dd74de | | | 36 | devDependencies: { |
| 6dd74de | | | 37 | // these are somewhat-unexpectedly required, and a downstream would need |
| 6dd74de | | | 38 | // to match the real `package.json` values |
| 6dd74de | | | 39 | 'type-fest': '*', |
| 6dd74de | | | 40 | '@types/d3': '^7.4.3', |
| 6dd74de | | | 41 | typescript: '*', |
| 6dd74de | | | 42 | }, |
| 6dd74de | | | 43 | }, |
| 6dd74de | | | 44 | null, |
| 6dd74de | | | 45 | 2 |
| 6dd74de | | | 46 | ), |
| 6dd74de | | | 47 | // a fairly strict TypeScript configuration |
| 6dd74de | | | 48 | 'tsconfig.json': () => |
| 6dd74de | | | 49 | JSON.stringify( |
| 6dd74de | | | 50 | { |
| 6dd74de | | | 51 | compilerOptions: { |
| 6dd74de | | | 52 | allowSyntheticDefaultImports: true, |
| 6dd74de | | | 53 | composite: true, |
| 6dd74de | | | 54 | declaration: true, |
| 6dd74de | | | 55 | esModuleInterop: true, |
| 6dd74de | | | 56 | incremental: true, |
| 6dd74de | | | 57 | lib: ['dom', 'es2020'], |
| 6dd74de | | | 58 | module: 'esnext', |
| 6dd74de | | | 59 | moduleResolution: 'node', |
| 6dd74de | | | 60 | noEmitOnError: true, |
| 6dd74de | | | 61 | noImplicitAny: true, |
| 6dd74de | | | 62 | noUnusedLocals: true, |
| 6dd74de | | | 63 | sourceMap: true, |
| 6dd74de | | | 64 | target: 'es2020', |
| 6dd74de | | | 65 | rootDir: './src', |
| 6dd74de | | | 66 | outDir: './lib', |
| 6dd74de | | | 67 | strict: true, |
| 6dd74de | | | 68 | tsBuildInfoFile: 'lib/.tsbuildinfo', |
| 6dd74de | | | 69 | }, |
| 6dd74de | | | 70 | }, |
| 6dd74de | | | 71 | null, |
| 6dd74de | | | 72 | 2 |
| 6dd74de | | | 73 | ), |
| 6dd74de | | | 74 | // the simplest possible script: will everything even import? |
| 6dd74de | | | 75 | 'src/index.ts': (tarballs) => { |
| 6dd74de | | | 76 | const imports: string[] = []; |
| 6dd74de | | | 77 | const outputs: string[] = []; |
| 6dd74de | | | 78 | let i = 0; |
| 6dd74de | | | 79 | for (const pkg of Object.keys(tarballs)) { |
| 6dd74de | | | 80 | imports.push(`import * as pkg_${i} from '${pkg}';`); |
| 6dd74de | | | 81 | outputs.push(`console.log(pkg_${i});`); |
| 6dd74de | | | 82 | i++; |
| 6dd74de | | | 83 | } |
| 6dd74de | | | 84 | return [...imports, ...outputs].join('\n'); |
| 6dd74de | | | 85 | }, |
| 6dd74de | | | 86 | }; |
| 6dd74de | | | 87 | |
| 6dd74de | | | 88 | /** |
| 6dd74de | | | 89 | * Commands to run after source files are created. |
| 6dd74de | | | 90 | * |
| 6dd74de | | | 91 | * `npm` is used to detect any unwanted `pnpm`-specific runtime "features". |
| 6dd74de | | | 92 | */ |
| 6dd74de | | | 93 | const COMMANDS = [ |
| 6dd74de | | | 94 | ['npm', 'install'], |
| 6dd74de | | | 95 | ['npm', 'run', 'build'], |
| 6dd74de | | | 96 | ]; |
| 6dd74de | | | 97 | |
| 6dd74de | | | 98 | /** |
| 6dd74de | | | 99 | * Built files to expect after commands are executed. |
| 6dd74de | | | 100 | */ |
| 6dd74de | | | 101 | const LIB = ['lib/index.js', 'lib/index.js.map', 'lib/index.d.ts', 'lib/.tsbuildinfo']; |
| 6dd74de | | | 102 | |
| 6dd74de | | | 103 | /** |
| 6dd74de | | | 104 | * Run a small out-of-tree build. |
| 6dd74de | | | 105 | */ |
| 6dd74de | | | 106 | async function main() { |
| 6dd74de | | | 107 | console.warn('Checking out-of-tree TypeScript build using', Object.keys(PACKAGES).join('\n')); |
| 6dd74de | | | 108 | const cwd = await mkdtemp(path.join(tmpdir(), 'mermaid-tsc-check-')); |
| 6dd74de | | | 109 | console.warn('... creating temporary folder', cwd); |
| 6dd74de | | | 110 | const tarballs = await buildTarballs(cwd); |
| 6dd74de | | | 111 | |
| 6dd74de | | | 112 | for (const [filename, generate] of Object.entries(SRC)) { |
| 6dd74de | | | 113 | const dest = path.join(cwd, filename); |
| 6dd74de | | | 114 | await mkdir(path.dirname(dest), { recursive: true }); |
| 6dd74de | | | 115 | console.warn('... creating', dest); |
| 6dd74de | | | 116 | const text = generate(tarballs); |
| 6dd74de | | | 117 | await writeFile(dest, text); |
| 6dd74de | | | 118 | console.info(text); |
| 6dd74de | | | 119 | } |
| 6dd74de | | | 120 | |
| 6dd74de | | | 121 | for (const argv of COMMANDS) { |
| 6dd74de | | | 122 | console.warn('... in', cwd); |
| 6dd74de | | | 123 | console.warn('>>>', ...argv); |
| 6dd74de | | | 124 | execFileSync(argv[0], argv.slice(1), { cwd }); |
| 6dd74de | | | 125 | } |
| 6dd74de | | | 126 | |
| 6dd74de | | | 127 | for (const lib of LIB) { |
| 6dd74de | | | 128 | const checkLib = path.join(cwd, lib); |
| 6dd74de | | | 129 | console.warn('... checking built file', checkLib); |
| 6dd74de | | | 130 | await readFile(checkLib, 'utf-8'); |
| 6dd74de | | | 131 | } |
| 6dd74de | | | 132 | |
| 6dd74de | | | 133 | console.warn('... deleting', cwd); |
| 6dd74de | | | 134 | await rm(cwd, { recursive: true, force: true }); |
| 6dd74de | | | 135 | console.warn('... tsc-check OK for\n', Object.keys(PACKAGES).join('\n')); |
| 6dd74de | | | 136 | } |
| 6dd74de | | | 137 | |
| 6dd74de | | | 138 | /** Build all the tarballs. */ |
| 6dd74de | | | 139 | async function buildTarballs(tmp: string): Promise<Record<string, string>> { |
| 6dd74de | | | 140 | const dist = path.join(tmp, 'dist'); |
| 6dd74de | | | 141 | await mkdir(dist); |
| 6dd74de | | | 142 | const promises: Promise<void>[] = []; |
| 6dd74de | | | 143 | const tarballs: Record<string, string> = {}; |
| 6dd74de | | | 144 | for (const [pkg, srcPath] of Object.entries(PACKAGES)) { |
| 6dd74de | | | 145 | promises.push(buildOneTarball(pkg, srcPath, dist, tarballs)); |
| 6dd74de | | | 146 | } |
| 6dd74de | | | 147 | await Promise.all(promises); |
| 6dd74de | | | 148 | return tarballs; |
| 6dd74de | | | 149 | } |
| 6dd74de | | | 150 | |
| 6dd74de | | | 151 | /** Build a single tarball. */ |
| 6dd74de | | | 152 | async function buildOneTarball( |
| 6dd74de | | | 153 | pkg: string, |
| 6dd74de | | | 154 | srcPath: string, |
| 6dd74de | | | 155 | dist: string, |
| 6dd74de | | | 156 | tarballs: Record<string, string> |
| 6dd74de | | | 157 | ): Promise<void> { |
| 6dd74de | | | 158 | const cwd = await mkdtemp(path.join(dist, 'pack-')); |
| 6dd74de | | | 159 | const pkgDir = path.join(__dirname, '../packages', srcPath); |
| 6dd74de | | | 160 | const argv = ['pnpm', 'pack', '--pack-destination', cwd]; |
| 6dd74de | | | 161 | console.warn('>>>', ...argv); |
| 6dd74de | | | 162 | execFileSync(argv[0], argv.slice(1), { cwd: pkgDir }); |
| 6dd74de | | | 163 | const built = await readdir(cwd); |
| 6dd74de | | | 164 | const dest = path.join(dist, built[0]); |
| 6dd74de | | | 165 | await copyFile(path.join(cwd, built[0]), dest); |
| 6dd74de | | | 166 | await rm(cwd, { recursive: true, force: true }); |
| 6dd74de | | | 167 | tarballs[pkg] = dest; |
| 6dd74de | | | 168 | } |
| 6dd74de | | | 169 | |
| 6dd74de | | | 170 | void main().catch((err) => { |
| 6dd74de | | | 171 | console.error(err); |
| 6dd74de | | | 172 | console.error('!!! tsc-check FAIL: temp folder left in place. see logs above for failure notes'); |
| 6dd74de | | | 173 | process.exit(1); |
| 6dd74de | | | 174 | }); |