Currently, when running the ngcc binary directly and provide an invalid option ngcc will not error out and the user might have a hard time telling why ngcc is behaving not as expected.
With this change we now output an actionable error:
```
yarn ngcc --unknown-option
Options:
--version Show version number [boolean]
-s, --source A path (relative to the working directory)
of the `node_modules` folder to process.
[default: "./node_modules"]
-p, --properties An array of names of properties in
package.json to compile (e.g. `module` or
`es2015`)
Each of these properties should hold the
path to a bundle-format.
If provided, only the specified properties
are considered for processing.
If not provided, all the supported format
properties (e.g. fesm2015, fesm5, es2015,
esm2015, esm5, main, module) in the
package.json are considered. [array]
-t, --target A relative path (from the `source` path) to
a single entry-point to process (plus its
dependencies).
--first-only If specified then only the first matching
package.json property will be compiled.
[boolean]
--create-ivy-entry-points If specified then new `*_ivy_ngcc`
entry-points will be added to package.json
rather than modifying the ones in-place.
For this to work you need to have custom
resolution set up (e.g. in webpack) to look
for these new entry-points.
The Angular CLI does this already, so it is
safe to use this option if the project is
being built via the CLI. [boolean]
--legacy-message-ids Render `$localize` messages with legacy
format ids.
The default value is `true`. Only set this
to `false` if you do not want legacy
message ids to
be rendered. For example, if you are not
using legacy message ids in your
translation files
AND are not doing compile-time inlining of
translations, in which case the extra
message ids
would add unwanted size to the final source
bundle.
It is safe to leave this set to true if you
are doing compile-time inlining because the
extra
legacy message ids will all be stripped
during translation.
[boolean] [default: true]
--async Whether to compile asynchronously. This is
enabled by default as it allows
compilations to be parallelized.
Disabling asynchronous compilation may be
useful for debugging.
[boolean] [default: true]
-l, --loglevel The lowest severity logging message that
should be output.
[choices: "debug", "info", "warn", "error"]
--invalidate-entry-point-manifest If this is set then ngcc will not read an
entry-point manifest file from disk.
Instead it will walking the directory tree
as normal looking for entry-points, and
then write a new manifest file.
[boolean] [default: false]
--help Show help [boolean]
Unknown arguments: unknown-option, unknownOption
```
PR Close #36010
126 lines
5.1 KiB
JavaScript
126 lines
5.1 KiB
JavaScript
#!/usr/bin/env node
|
||
/**
|
||
* @license
|
||
* Copyright Google Inc. 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.io/license
|
||
*/
|
||
import * as yargs from 'yargs';
|
||
|
||
import {resolve, setFileSystem, CachedFileSystem, NodeJSFileSystem} from '../src/ngtsc/file_system';
|
||
import {mainNgcc} from './src/main';
|
||
import {ConsoleLogger} from './src/logging/console_logger';
|
||
import {LogLevel} from './src/logging/logger';
|
||
|
||
// CLI entry point
|
||
if (require.main === module) {
|
||
const startTime = Date.now();
|
||
|
||
const args = process.argv.slice(2);
|
||
const options =
|
||
yargs
|
||
.option('s', {
|
||
alias: 'source',
|
||
describe:
|
||
'A path (relative to the working directory) of the `node_modules` folder to process.',
|
||
default: './node_modules'
|
||
})
|
||
.option('f', {alias: 'formats', hidden: true, array: true})
|
||
.option('p', {
|
||
alias: 'properties',
|
||
array: true,
|
||
describe:
|
||
'An array of names of properties in package.json to compile (e.g. `module` or `es2015`)\n' +
|
||
'Each of these properties should hold the path to a bundle-format.\n' +
|
||
'If provided, only the specified properties are considered for processing.\n' +
|
||
'If not provided, all the supported format properties (e.g. fesm2015, fesm5, es2015, esm2015, esm5, main, module) in the package.json are considered.'
|
||
})
|
||
.option('t', {
|
||
alias: 'target',
|
||
describe:
|
||
'A relative path (from the `source` path) to a single entry-point to process (plus its dependencies).',
|
||
})
|
||
.option('first-only', {
|
||
describe:
|
||
'If specified then only the first matching package.json property will be compiled.',
|
||
type: 'boolean'
|
||
})
|
||
.option('create-ivy-entry-points', {
|
||
describe:
|
||
'If specified then new `*_ivy_ngcc` entry-points will be added to package.json rather than modifying the ones in-place.\n' +
|
||
'For this to work you need to have custom resolution set up (e.g. in webpack) to look for these new entry-points.\n' +
|
||
'The Angular CLI does this already, so it is safe to use this option if the project is being built via the CLI.',
|
||
type: 'boolean',
|
||
})
|
||
.option('legacy-message-ids', {
|
||
describe: 'Render `$localize` messages with legacy format ids.\n' +
|
||
'The default value is `true`. Only set this to `false` if you do not want legacy message ids to\n' +
|
||
'be rendered. For example, if you are not using legacy message ids in your translation files\n' +
|
||
'AND are not doing compile-time inlining of translations, in which case the extra message ids\n' +
|
||
'would add unwanted size to the final source bundle.\n' +
|
||
'It is safe to leave this set to true if you are doing compile-time inlining because the extra\n' +
|
||
'legacy message ids will all be stripped during translation.',
|
||
type: 'boolean',
|
||
default: true,
|
||
})
|
||
.option('async', {
|
||
describe:
|
||
'Whether to compile asynchronously. This is enabled by default as it allows compilations to be parallelized.\n' +
|
||
'Disabling asynchronous compilation may be useful for debugging.',
|
||
type: 'boolean',
|
||
default: true,
|
||
})
|
||
.option('l', {
|
||
alias: 'loglevel',
|
||
describe: 'The lowest severity logging message that should be output.',
|
||
choices: ['debug', 'info', 'warn', 'error'],
|
||
})
|
||
.strict()
|
||
.help()
|
||
.parse(args);
|
||
|
||
if (options['f'] && options['f'].length) {
|
||
console.error(
|
||
'The formats option (-f/--formats) has been removed. Consider the properties option (-p/--properties) instead.');
|
||
process.exit(1);
|
||
}
|
||
|
||
setFileSystem(new CachedFileSystem(new NodeJSFileSystem()));
|
||
|
||
const baseSourcePath = resolve(options['s'] || './node_modules');
|
||
const propertiesToConsider: string[] = options['p'];
|
||
const targetEntryPointPath = options['t'] ? options['t'] : undefined;
|
||
const compileAllFormats = !options['first-only'];
|
||
const createNewEntryPointFormats = options['create-ivy-entry-points'];
|
||
const logLevel = options['l'] as keyof typeof LogLevel | undefined;
|
||
const enableI18nLegacyMessageIdFormat = options['legacy-message-ids'];
|
||
|
||
(async() => {
|
||
try {
|
||
const logger = logLevel && new ConsoleLogger(LogLevel[logLevel]);
|
||
|
||
await mainNgcc({
|
||
basePath: baseSourcePath,
|
||
propertiesToConsider,
|
||
targetEntryPointPath,
|
||
compileAllFormats,
|
||
createNewEntryPointFormats,
|
||
logger,
|
||
enableI18nLegacyMessageIdFormat,
|
||
async: options['async'],
|
||
});
|
||
|
||
if (logger) {
|
||
const duration = Math.round((Date.now() - startTime) / 1000);
|
||
logger.debug(`Run ngcc in ${duration}s.`);
|
||
}
|
||
|
||
process.exitCode = 0;
|
||
} catch (e) {
|
||
console.error(e.stack || e.message);
|
||
process.exitCode = 1;
|
||
}
|
||
})();
|
||
}
|