From 7e62aa0c6e611c78703a5cd04cebb12e13087577 Mon Sep 17 00:00:00 2001 From: Pete Bacon Darwin Date: Mon, 30 Mar 2020 11:12:54 +0100 Subject: [PATCH] refactor(ngcc): rename INVALID_ENTRY_POINT to INCOMPATIBLE_ENTRY_POINT (#36305) This name better reflects its meaning. PR Close #36305 --- .../directory_walker_entry_point_finder.ts | 6 +++--- .../targeted_entry_point_finder.ts | 4 ++-- .../ngcc/src/packages/entry_point.ts | 16 +++++++++------- .../ngcc/src/packages/entry_point_manifest.ts | 4 ++-- .../ngcc/test/packages/entry_point_spec.ts | 16 ++++++++-------- .../writing/new_entry_point_file_writer_spec.ts | 8 ++++---- 6 files changed, 28 insertions(+), 26 deletions(-) diff --git a/packages/compiler-cli/ngcc/src/entry_point_finder/directory_walker_entry_point_finder.ts b/packages/compiler-cli/ngcc/src/entry_point_finder/directory_walker_entry_point_finder.ts index 50a67e8100..a63cadf270 100644 --- a/packages/compiler-cli/ngcc/src/entry_point_finder/directory_walker_entry_point_finder.ts +++ b/packages/compiler-cli/ngcc/src/entry_point_finder/directory_walker_entry_point_finder.ts @@ -9,7 +9,7 @@ import {AbsoluteFsPath, FileSystem, join, resolve} from '../../../src/ngtsc/file import {DependencyResolver, SortedEntryPointsInfo} from '../dependencies/dependency_resolver'; import {Logger} from '../logging/logger'; import {NgccConfiguration} from '../packages/configuration'; -import {EntryPoint, INVALID_ENTRY_POINT, NO_ENTRY_POINT, getEntryPointInfo} from '../packages/entry_point'; +import {EntryPoint, INCOMPATIBLE_ENTRY_POINT, NO_ENTRY_POINT, getEntryPointInfo} from '../packages/entry_point'; import {EntryPointManifest} from '../packages/entry_point_manifest'; import {PathMappings} from '../utils'; import {NGCC_DIRECTORY} from '../writing/new_entry_point_file_writer'; @@ -111,7 +111,7 @@ export class DirectoryWalkerEntryPointFinder implements EntryPointFinder { return []; } - if (topLevelEntryPoint === INVALID_ENTRY_POINT) { + if (topLevelEntryPoint === INCOMPATIBLE_ENTRY_POINT) { return null; } @@ -126,7 +126,7 @@ export class DirectoryWalkerEntryPointFinder implements EntryPointFinder { const possibleEntryPointPath = isDirectory ? path : stripJsExtension(path); const subEntryPoint = getEntryPointInfo(this.fs, this.config, this.logger, packagePath, possibleEntryPointPath); - if (subEntryPoint === NO_ENTRY_POINT || subEntryPoint === INVALID_ENTRY_POINT) { + if (subEntryPoint === NO_ENTRY_POINT || subEntryPoint === INCOMPATIBLE_ENTRY_POINT) { return false; } entryPoints.push(subEntryPoint); diff --git a/packages/compiler-cli/ngcc/src/entry_point_finder/targeted_entry_point_finder.ts b/packages/compiler-cli/ngcc/src/entry_point_finder/targeted_entry_point_finder.ts index 2dcffe8942..7014c247cf 100644 --- a/packages/compiler-cli/ngcc/src/entry_point_finder/targeted_entry_point_finder.ts +++ b/packages/compiler-cli/ngcc/src/entry_point_finder/targeted_entry_point_finder.ts @@ -10,7 +10,7 @@ import {DependencyResolver, SortedEntryPointsInfo} from '../dependencies/depende import {Logger} from '../logging/logger'; import {hasBeenProcessed} from '../packages/build_marker'; import {NgccConfiguration} from '../packages/configuration'; -import {EntryPoint, EntryPointJsonProperty, INVALID_ENTRY_POINT, NO_ENTRY_POINT, getEntryPointInfo} from '../packages/entry_point'; +import {EntryPoint, EntryPointJsonProperty, INCOMPATIBLE_ENTRY_POINT, NO_ENTRY_POINT, getEntryPointInfo} from '../packages/entry_point'; import {PathMappings} from '../utils'; import {EntryPointFinder} from './interface'; import {getBasePaths} from './utils'; @@ -94,7 +94,7 @@ export class TargetedEntryPointFinder implements EntryPointFinder { const packagePath = this.computePackagePath(entryPointPath); const entryPoint = getEntryPointInfo(this.fs, this.config, this.logger, packagePath, entryPointPath); - if (entryPoint === NO_ENTRY_POINT || entryPoint === INVALID_ENTRY_POINT) { + if (entryPoint === NO_ENTRY_POINT || entryPoint === INCOMPATIBLE_ENTRY_POINT) { return null; } return entryPoint; diff --git a/packages/compiler-cli/ngcc/src/packages/entry_point.ts b/packages/compiler-cli/ngcc/src/packages/entry_point.ts index ea64e05ed2..08bcf8e4f1 100644 --- a/packages/compiler-cli/ngcc/src/packages/entry_point.ts +++ b/packages/compiler-cli/ngcc/src/packages/entry_point.ts @@ -86,7 +86,7 @@ export const NO_ENTRY_POINT = 'no-entry-point'; /** * The path has a package.json, but it is not a valid entry-point for ngcc processing. */ -export const INVALID_ENTRY_POINT = 'invalid-entry-point'; +export const INCOMPATIBLE_ENTRY_POINT = 'incompatible-entry-point'; /** * The result of calling `getEntryPointInfo()`. @@ -94,10 +94,11 @@ export const INVALID_ENTRY_POINT = 'invalid-entry-point'; * This will be an `EntryPoint` object if an Angular entry-point was identified; * Otherwise it will be a flag indicating one of: * * NO_ENTRY_POINT - the path is not an entry-point or ngcc is configured to ignore it - * * INVALID_ENTRY_POINT - the path was a non-processable entry-point that should be searched + * * INCOMPATIBLE_ENTRY_POINT - the path was a non-processable entry-point that should be searched * for sub-entry-points */ -export type GetEntryPointResult = EntryPoint | typeof INVALID_ENTRY_POINT | typeof NO_ENTRY_POINT; +export type GetEntryPointResult = + EntryPoint | typeof INCOMPATIBLE_ENTRY_POINT | typeof NO_ENTRY_POINT; /** @@ -107,9 +108,10 @@ export type GetEntryPointResult = EntryPoint | typeof INVALID_ENTRY_POINT | type * @param entryPointPath the absolute path to the potential entry-point. * @returns * - An entry-point if it is valid. - * - `undefined` when there is no package.json at the path and there is no config to force an + * - `NO_ENTRY_POINT` when there is no package.json at the path and there is no config to force an * entry-point or the entrypoint is `ignored`. - * - `null` there is a package.json but it is not a valid Angular compiled entry-point. + * - `INCOMPATIBLE_ENTRY_POINT` there is a package.json but it is not a valid Angular compiled + * entry-point. */ export function getEntryPointInfo( fs: FileSystem, config: NgccConfiguration, logger: Logger, packagePath: AbsoluteFsPath, @@ -138,14 +140,14 @@ export function getEntryPointInfo( if (entryPointPackageJson === null) { // package.json exists but could not be parsed and there was no redeeming config - return INVALID_ENTRY_POINT; + return INCOMPATIBLE_ENTRY_POINT; } const typings = entryPointPackageJson.typings || entryPointPackageJson.types || guessTypingsFromPackageJson(fs, entryPointPath, entryPointPackageJson); if (typeof typings !== 'string') { // Missing the required `typings` property - return INVALID_ENTRY_POINT; + return INCOMPATIBLE_ENTRY_POINT; } // An entry-point is assumed to be compiled by Angular if there is either: diff --git a/packages/compiler-cli/ngcc/src/packages/entry_point_manifest.ts b/packages/compiler-cli/ngcc/src/packages/entry_point_manifest.ts index 7cfdf8ca90..ab9c3cc669 100644 --- a/packages/compiler-cli/ngcc/src/packages/entry_point_manifest.ts +++ b/packages/compiler-cli/ngcc/src/packages/entry_point_manifest.ts @@ -12,7 +12,7 @@ import {Logger} from '../logging/logger'; import {NGCC_VERSION} from './build_marker'; import {NgccConfiguration} from './configuration'; -import {EntryPoint, INVALID_ENTRY_POINT, NO_ENTRY_POINT, getEntryPointInfo} from './entry_point'; +import {EntryPoint, INCOMPATIBLE_ENTRY_POINT, NO_ENTRY_POINT, getEntryPointInfo} from './entry_point'; /** * Manages reading and writing a manifest file that contains a list of all the entry-points that @@ -71,7 +71,7 @@ export class EntryPointManifest { for (const [packagePath, entryPointPath] of entryPointPaths) { const result = getEntryPointInfo(this.fs, this.config, this.logger, packagePath, entryPointPath); - if (result === NO_ENTRY_POINT || result === INVALID_ENTRY_POINT) { + if (result === NO_ENTRY_POINT || result === INCOMPATIBLE_ENTRY_POINT) { throw new Error( `The entry-point manifest at ${manifestPath} contained an invalid pair of package paths: [${packagePath}, ${entryPointPath}]`); } else { diff --git a/packages/compiler-cli/ngcc/test/packages/entry_point_spec.ts b/packages/compiler-cli/ngcc/test/packages/entry_point_spec.ts index f3917ff773..9a0e7957b7 100644 --- a/packages/compiler-cli/ngcc/test/packages/entry_point_spec.ts +++ b/packages/compiler-cli/ngcc/test/packages/entry_point_spec.ts @@ -10,7 +10,7 @@ import {AbsoluteFsPath, FileSystem, absoluteFrom, getFileSystem} from '../../../ import {runInEachFileSystem} from '../../../src/ngtsc/file_system/testing'; import {loadTestFiles} from '../../../test/helpers'; import {NgccConfiguration} from '../../src/packages/configuration'; -import {EntryPoint, INVALID_ENTRY_POINT, NO_ENTRY_POINT, SUPPORTED_FORMAT_PROPERTIES, getEntryPointFormat, getEntryPointInfo} from '../../src/packages/entry_point'; +import {EntryPoint, INCOMPATIBLE_ENTRY_POINT, NO_ENTRY_POINT, SUPPORTED_FORMAT_PROPERTIES, getEntryPointFormat, getEntryPointInfo} from '../../src/packages/entry_point'; import {MockLogger} from '../helpers/mock_logger'; runInEachFileSystem(() => { @@ -165,7 +165,7 @@ runInEachFileSystem(() => { }); - it('should return `INVALID_ENTRY_POINT` if there is no typings or types field in the package.json', + it('should return `INCOMPATIBLE_ENTRY_POINT` if there is no typings or types field in the package.json', () => { loadTestFiles([ { @@ -182,10 +182,10 @@ runInEachFileSystem(() => { const entryPoint = getEntryPointInfo( fs, config, new MockLogger(), SOME_PACKAGE, _('/project/node_modules/some_package/missing_typings')); - expect(entryPoint).toBe(INVALID_ENTRY_POINT); + expect(entryPoint).toBe(INCOMPATIBLE_ENTRY_POINT); }); - it('should return `INVALID_ENTRY_POINT` if the typings or types field is not a string in the package.json', + it('should return `INCOMPATIBLE_ENTRY_POINT` if the typings or types field is not a string in the package.json', () => { loadTestFiles([ { @@ -202,7 +202,7 @@ runInEachFileSystem(() => { const entryPoint = getEntryPointInfo( fs, config, new MockLogger(), SOME_PACKAGE, _('/project/node_modules/some_package/typings_array')); - expect(entryPoint).toBe(INVALID_ENTRY_POINT); + expect(entryPoint).toBe(INCOMPATIBLE_ENTRY_POINT); }); for (let prop of SUPPORTED_FORMAT_PROPERTIES) { @@ -359,7 +359,7 @@ runInEachFileSystem(() => { }); }); - it('should return `INVALID_ENTRY_POINT` if the package.json is not valid JSON', () => { + it('should return `INCOMPATIBLE_ENTRY_POINT` if the package.json is not valid JSON', () => { loadTestFiles([ // package.json might not be a valid JSON // for example, @schematics/angular contains a package.json blueprint @@ -373,7 +373,7 @@ runInEachFileSystem(() => { const entryPoint = getEntryPointInfo( fs, config, new MockLogger(), SOME_PACKAGE, _('/project/node_modules/some_package/unexpected_symbols')); - expect(entryPoint).toBe(INVALID_ENTRY_POINT); + expect(entryPoint).toBe(INCOMPATIBLE_ENTRY_POINT); }); }); @@ -395,7 +395,7 @@ runInEachFileSystem(() => { const result = getEntryPointInfo( fs, config, new MockLogger(), SOME_PACKAGE, _('/project/node_modules/some_package/valid_entry_point')); - if (result === NO_ENTRY_POINT || result === INVALID_ENTRY_POINT) { + if (result === NO_ENTRY_POINT || result === INCOMPATIBLE_ENTRY_POINT) { return fail(`Expected an entry point but got ${result}`); } entryPoint = result; diff --git a/packages/compiler-cli/ngcc/test/writing/new_entry_point_file_writer_spec.ts b/packages/compiler-cli/ngcc/test/writing/new_entry_point_file_writer_spec.ts index f8e1e77d42..a0a01c0911 100644 --- a/packages/compiler-cli/ngcc/test/writing/new_entry_point_file_writer_spec.ts +++ b/packages/compiler-cli/ngcc/test/writing/new_entry_point_file_writer_spec.ts @@ -9,7 +9,7 @@ import {FileSystem, absoluteFrom, getFileSystem} from '../../../src/ngtsc/file_s import {runInEachFileSystem} from '../../../src/ngtsc/file_system/testing'; import {loadTestFiles} from '../../../test/helpers'; import {NgccConfiguration} from '../../src/packages/configuration'; -import {EntryPoint, EntryPointFormat, EntryPointJsonProperty, INVALID_ENTRY_POINT, NO_ENTRY_POINT, getEntryPointInfo} from '../../src/packages/entry_point'; +import {EntryPoint, EntryPointFormat, EntryPointJsonProperty, INCOMPATIBLE_ENTRY_POINT, NO_ENTRY_POINT, getEntryPointInfo} from '../../src/packages/entry_point'; import {EntryPointBundle, makeEntryPointBundle} from '../../src/packages/entry_point_bundle'; import {FileWriter} from '../../src/writing/file_writer'; import {NewEntryPointFileWriter} from '../../src/writing/new_entry_point_file_writer'; @@ -108,7 +108,7 @@ runInEachFileSystem(() => { const config = new NgccConfiguration(fs, _('/')); const result = getEntryPointInfo( fs, config, logger, _('/node_modules/test'), _('/node_modules/test')) !; - if (result === NO_ENTRY_POINT || result === INVALID_ENTRY_POINT) { + if (result === NO_ENTRY_POINT || result === INCOMPATIBLE_ENTRY_POINT) { return fail(`Expected an entry point but got ${result}`); } entryPoint = result; @@ -248,7 +248,7 @@ runInEachFileSystem(() => { const config = new NgccConfiguration(fs, _('/')); const result = getEntryPointInfo( fs, config, logger, _('/node_modules/test'), _('/node_modules/test/a')) !; - if (result === NO_ENTRY_POINT || result === INVALID_ENTRY_POINT) { + if (result === NO_ENTRY_POINT || result === INCOMPATIBLE_ENTRY_POINT) { return fail(`Expected an entry point but got ${result}`); } entryPoint = result; @@ -377,7 +377,7 @@ runInEachFileSystem(() => { const config = new NgccConfiguration(fs, _('/')); const result = getEntryPointInfo( fs, config, new MockLogger(), _('/node_modules/test'), _('/node_modules/test/b')) !; - if (result === NO_ENTRY_POINT || result === INVALID_ENTRY_POINT) { + if (result === NO_ENTRY_POINT || result === INCOMPATIBLE_ENTRY_POINT) { return fail(`Expected an entry point but got ${result}`); } entryPoint = result;