b0cb134815
`ngcc` adds marker files to each folder that has been compiled, containing the version of the ngcc used. When compiling, it will ignore folders that contain these marker files, as long as the version matches. PR Close #25557
112 lines
4.1 KiB
TypeScript
112 lines
4.1 KiB
TypeScript
/**
|
|
* @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 {existsSync, readFileSync, writeFileSync} from 'fs';
|
|
import {dirname, resolve} from 'path';
|
|
import {find} from 'shelljs';
|
|
|
|
import {isDefined} from '../utils';
|
|
|
|
export const NGCC_VERSION = '0.0.0-PLACEHOLDER';
|
|
|
|
/**
|
|
* Represents an entry point to a package or sub-package.
|
|
*
|
|
* It exposes the absolute path to the entry point file and a method to get the `.d.ts` file that
|
|
* corresponds to any source file that belongs to the package (assuming source files and `.d.ts`
|
|
* files have the same directory layout).
|
|
*/
|
|
export class EntryPoint {
|
|
entryFileName: string;
|
|
entryRoot: string;
|
|
dtsEntryRoot: string;
|
|
|
|
/**
|
|
* @param packageRoot The absolute path to the root directory that contains the package.
|
|
* @param relativeEntryPath The relative path to the entry point file.
|
|
* @param relativeDtsEntryPath The relative path to the `.d.ts` entry point file.
|
|
*/
|
|
constructor(public packageRoot: string, relativeEntryPath: string, relativeDtsEntryPath: string) {
|
|
this.entryFileName = resolve(packageRoot, relativeEntryPath);
|
|
this.entryRoot = dirname(this.entryFileName);
|
|
const dtsEntryFileName = resolve(packageRoot, relativeDtsEntryPath);
|
|
this.dtsEntryRoot = dirname(dtsEntryFileName);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Match paths to `package.json` files.
|
|
*/
|
|
const PACKAGE_JSON_REGEX = /\/package\.json$/;
|
|
|
|
/**
|
|
* Match paths that have a `node_modules` segment at the start or in the middle.
|
|
*/
|
|
const NODE_MODULES_REGEX = /(?:^|\/)node_modules\//;
|
|
|
|
/**
|
|
* Search the `rootDirectory` and its subdirectories to find `package.json` files.
|
|
* It ignores node dependencies, i.e. those under `node_modules` directories.
|
|
*
|
|
* @param rootDirectory The directory in which we should search.
|
|
*/
|
|
export function findAllPackageJsonFiles(rootDirectory: string): string[] {
|
|
// TODO(gkalpak): Investigate whether skipping `node_modules/` directories (instead of traversing
|
|
// them and filtering out the results later) makes a noticeable difference.
|
|
const paths = Array.from(find(rootDirectory));
|
|
return paths.filter(
|
|
path => PACKAGE_JSON_REGEX.test(path) &&
|
|
!NODE_MODULES_REGEX.test(path.slice(rootDirectory.length)));
|
|
}
|
|
|
|
/**
|
|
* Identify the entry points of a collection of package.json files.
|
|
*
|
|
* @param packageJsonPaths A collection of absolute paths to the package.json files.
|
|
* @param format The format of the entry points to look for within the package.
|
|
*
|
|
* @returns A collection of `EntryPoint`s that correspond to entry points for the package.
|
|
*/
|
|
export function getEntryPoints(packageJsonPaths: string[], format: string): EntryPoint[] {
|
|
const entryPoints =
|
|
packageJsonPaths
|
|
.map(packageJsonPath => {
|
|
const entryPointPackageJson = JSON.parse(readFileSync(packageJsonPath, 'utf8'));
|
|
const entryPointPath: string|undefined = entryPointPackageJson[format];
|
|
if (!entryPointPath) {
|
|
return undefined;
|
|
}
|
|
const dtsEntryPointPath = entryPointPackageJson.typings || entryPointPath;
|
|
return new EntryPoint(dirname(packageJsonPath), entryPointPath, dtsEntryPointPath);
|
|
})
|
|
.filter(isDefined);
|
|
return entryPoints;
|
|
}
|
|
|
|
function getMarkerPath(packageJsonPath: string, format: string) {
|
|
return resolve(dirname(packageJsonPath), `__modified_by_ngcc_for_${format}__`);
|
|
}
|
|
|
|
export function checkMarkerFile(packageJsonPath: string, format: string) {
|
|
const markerPath = getMarkerPath(packageJsonPath, format);
|
|
const markerExists = existsSync(markerPath);
|
|
if (markerExists) {
|
|
const previousVersion = readFileSync(markerPath, 'utf8');
|
|
if (previousVersion !== NGCC_VERSION) {
|
|
throw new Error(
|
|
'The ngcc compiler has changed since the last ngcc build.\n' +
|
|
'Please completely remove `node_modules` and try again.');
|
|
}
|
|
}
|
|
return markerExists;
|
|
}
|
|
|
|
export function writeMarkerFile(packageJsonPath: string, format: string) {
|
|
const markerPath = getMarkerPath(packageJsonPath, format);
|
|
writeFileSync(markerPath, NGCC_VERSION, 'utf8');
|
|
} |