-
Notifications
You must be signed in to change notification settings - Fork 3.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor: make node-bundle tests executable using ts-jest (#32022)
Make `node-bundle` easier to test (in-process instead of using a subcommand that requires `.js` to have been compiled), and fix a bug in the tests that used `--license` instead of `--allowed-license` (configure `yargs` to be `strict`). ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
- Loading branch information
Showing
7 changed files
with
167 additions
and
138 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,115 @@ | ||
| import * as path from 'path'; | ||
| import * as fs from 'fs-extra'; | ||
| import * as yargs from 'yargs'; | ||
| import { Bundle, BundleProps, BundleValidateOptions } from './api'; | ||
|
|
||
| function versionNumber(): string { | ||
| return fs.readJSONSync(path.join(__dirname, '..', 'package.json')).version; | ||
| } | ||
|
|
||
| export async function cliMain(cliArgs: string[]) { | ||
| const argv = await yargs | ||
| .usage('Usage: node-bundle COMMAND') | ||
| .option('entrypoint', { type: 'array', nargs: 1, desc: 'List of entrypoints to bundle' }) | ||
| .option('external', { type: 'array', nargs: 1, default: [], desc: 'Packages in this list will be excluded from the bundle and added as dependencies (example: fsevents:optional)' }) | ||
| .option('allowed-license', { type: 'array', nargs: 1, default: [], desc: 'List of valid licenses' }) | ||
| .option('resource', { type: 'array', nargs: 1, default: [], desc: 'List of resources that need to be explicitly copied to the bundle (example: node_modules/proxy-agent/contextify.js:bin/contextify.js)' }) | ||
| .option('dont-attribute', { type: 'string', desc: 'Dependencies matching this regular expressions wont be added to the notice file' }) | ||
| .option('test', { type: 'string', desc: 'Validation command to sanity test the bundle after its created' }) | ||
| .command('validate', 'Validate the package is ready for bundling', args => args | ||
| .option('fix', { type: 'boolean', default: false, alias: 'f', desc: 'Fix any fixable violations' }), | ||
| ) | ||
| .command('write', 'Write the bundled version of the project to a temp directory') | ||
| .command('pack', 'Write the bundle and create the tarball') | ||
| .demandCommand() // require a subcommand | ||
| .strict() // require a VALID subcommand, and only supported options | ||
| .fail((msg, err) => { | ||
| // Throw an error in test mode, exit with an error code otherwise | ||
| if (err) { throw err; } | ||
| if (process.env.NODE_ENV === 'test') { | ||
| throw new Error(msg); | ||
| } | ||
| console.error(msg); | ||
| process.exit(1); // exit() not exitCode, we must not return. | ||
| }) | ||
| .help() | ||
| .version(versionNumber()) | ||
| .parse(cliArgs); | ||
|
|
||
| const command = argv._[0]; | ||
|
|
||
| function undefinedIfEmpty(arr?: any[]): string[] | undefined { | ||
| if (!arr || arr.length === 0) return undefined; | ||
| return arr as string[]; | ||
| } | ||
|
|
||
| const resources: any = {}; | ||
| for (const resource of (argv.resource as string[])) { | ||
| const parts = resource.split(':'); | ||
| resources[parts[0]] = parts[1]; | ||
| } | ||
|
|
||
| const optionalExternals = []; | ||
| const runtimeExternals = []; | ||
|
|
||
| for (const external of (argv.external as string[])) { | ||
| const parts = external.split(':'); | ||
| const name = parts[0]; | ||
| const type = parts[1]; | ||
| switch (type) { | ||
| case 'optional': | ||
| optionalExternals.push(name); | ||
| break; | ||
| case 'runtime': | ||
| runtimeExternals.push(name); | ||
| break; | ||
| default: | ||
| throw new Error(`Unsupported dependency type '${type}' for external package '${name}'. Supported types are: ['optional', 'runtime']`); | ||
| } | ||
| } | ||
|
|
||
| const props: BundleProps = { | ||
| packageDir: process.cwd(), | ||
| entryPoints: undefinedIfEmpty(argv.entrypoint), | ||
| externals: { dependencies: runtimeExternals, optionalDependencies: optionalExternals }, | ||
| allowedLicenses: undefinedIfEmpty(argv['allowed-license']), | ||
| resources: resources, | ||
| dontAttribute: argv['dont-attribute'], | ||
| test: argv.test, | ||
| }; | ||
|
|
||
| const bundle = new Bundle(props); | ||
|
|
||
| switch (command) { | ||
| case 'validate': | ||
| // When using `yargs.command(command, builder [, handler])` without the handler | ||
| // as we do here, there is no typing for command-specific options. So force a cast. | ||
| const fix = argv.fix as boolean | undefined; | ||
| validate(bundle, { fix }); | ||
| break; | ||
| case 'write': | ||
| write(bundle); | ||
| break; | ||
| case 'pack': | ||
| pack(bundle); | ||
| break; | ||
| default: | ||
| throw new Error(`Unknown command: ${command}`); | ||
| } | ||
| } | ||
|
|
||
| function write(bundle: Bundle) { | ||
| const bundleDir = bundle.write(); | ||
| console.log(bundleDir); | ||
| } | ||
|
|
||
| function validate(bundle: Bundle, options: BundleValidateOptions = {}) { | ||
| const report = bundle.validate(options); | ||
| if (!report.success) { | ||
| throw new Error(report.summary); | ||
| } | ||
| } | ||
|
|
||
| function pack(bundle: Bundle) { | ||
| bundle.pack(); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.