59 lines
2.8 KiB
TypeScript
59 lines
2.8 KiB
TypeScript
|
/**
|
||
|
|
* @license
|
||
|
|
* Copyright Google LLC 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
|
||
|
|
*/
|
||
|
|
/// <reference types="node" />
|
||
|
|
/// <reference types="@types/node/url" />
|
||
|
|
/// <reference types="@types/node/ts4.8/url" />
|
||
|
|
import { json, workspaces } from '@angular-devkit/core';
|
||
|
|
import { URL } from 'url';
|
||
|
|
import { BuilderInfo } from '../src';
|
||
|
|
import { Target } from '../src/input-schema';
|
||
|
|
import { ArchitectHost, Builder } from '../src/internal';
|
||
|
|
export type NodeModulesBuilderInfo = BuilderInfo & {
|
||
|
|
import: string;
|
||
|
|
};
|
||
|
|
export interface WorkspaceHost {
|
||
|
|
getBuilderName(project: string, target: string): Promise<string>;
|
||
|
|
getMetadata(project: string): Promise<json.JsonObject>;
|
||
|
|
getOptions(project: string, target: string, configuration?: string): Promise<json.JsonObject>;
|
||
|
|
hasTarget(project: string, target: string): Promise<boolean>;
|
||
|
|
getDefaultConfigurationName(project: string, target: string): Promise<string | undefined>;
|
||
|
|
}
|
||
|
|
export declare class WorkspaceNodeModulesArchitectHost implements ArchitectHost<NodeModulesBuilderInfo> {
|
||
|
|
protected _root: string;
|
||
|
|
private workspaceHost;
|
||
|
|
constructor(workspaceHost: WorkspaceHost, _root: string);
|
||
|
|
constructor(workspace: workspaces.WorkspaceDefinition, _root: string);
|
||
|
|
getBuilderNameForTarget(target: Target): Promise<string>;
|
||
|
|
/**
|
||
|
|
* Resolve a builder. This needs to be a string which will be used in a dynamic `import()`
|
||
|
|
* clause. This should throw if no builder can be found. The dynamic import will throw if
|
||
|
|
* it is unsupported.
|
||
|
|
* @param builderStr The name of the builder to be used.
|
||
|
|
* @returns All the info needed for the builder itself.
|
||
|
|
*/
|
||
|
|
resolveBuilder(builderStr: string): Promise<NodeModulesBuilderInfo>;
|
||
|
|
getCurrentDirectory(): Promise<string>;
|
||
|
|
getWorkspaceRoot(): Promise<string>;
|
||
|
|
getOptionsForTarget(target: Target): Promise<json.JsonObject | null>;
|
||
|
|
getProjectMetadata(target: Target | string): Promise<json.JsonObject | null>;
|
||
|
|
loadBuilder(info: NodeModulesBuilderInfo): Promise<Builder>;
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* This uses a dynamic import to load a module which may be ESM.
|
||
|
|
* CommonJS code can load ESM code via a dynamic import. Unfortunately, TypeScript
|
||
|
|
* will currently, unconditionally downlevel dynamic import into a require call.
|
||
|
|
* require calls cannot load ESM code and will result in a runtime error. To workaround
|
||
|
|
* this, a Function constructor is used to prevent TypeScript from changing the dynamic import.
|
||
|
|
* Once TypeScript provides support for keeping the dynamic import this workaround can
|
||
|
|
* be dropped.
|
||
|
|
*
|
||
|
|
* @param modulePath The path of the module to load.
|
||
|
|
* @returns A Promise that resolves to the dynamically imported module.
|
||
|
|
*/
|
||
|
|
export declare function loadEsmModule<T>(modulePath: string | URL): Promise<T>;
|