2018-06-05 18:50:06 -07:00

54 lines
1.6 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 { JsonObject } from '@angular-devkit/core';
import {
Collection,
CollectionDescription,
RuleFactory,
SchematicDescription,
TypedSchematicContext,
} from '../src';
export interface FileSystemCollectionDescription {
readonly path: string;
readonly version?: string;
readonly schematics: { [name: string]: FileSystemSchematicDesc };
}
export interface FileSystemSchematicJsonDescription {
readonly aliases?: string[];
readonly factory: string;
readonly description: string;
readonly schema?: string;
readonly extends?: string;
}
export interface FileSystemSchematicDescription extends FileSystemSchematicJsonDescription {
// Processed by the EngineHost.
readonly path: string;
readonly schemaJson?: JsonObject;
// Using `any` here is okay because the type isn't resolved when we read this value,
// but rather when the Engine asks for it.
readonly factoryFn: RuleFactory<{}>;
}
/**
* Used to simplify typings.
*/
export declare type FileSystemCollection
= Collection<FileSystemCollectionDescription, FileSystemSchematicDescription>;
export declare type FileSystemCollectionDesc
= CollectionDescription<FileSystemCollectionDescription>;
export declare type FileSystemSchematicDesc
= SchematicDescription<FileSystemCollectionDescription, FileSystemSchematicDescription>;
export declare type FileSystemSchematicContext
= TypedSchematicContext<FileSystemCollectionDescription, FileSystemSchematicDescription>;