interfaces.ts

/**
 * @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 { logging, virtualFs } from '@angular-devkit/core';
import { CompilerOptions } from '@angular/compiler-cli';
import * as fs from 'fs';
import * as ts from 'typescript';

export enum PLATFORM {
  Browser,
  Server,
}

export interface ContextElementDependency { }

export interface ContextElementDependencyConstructor {
  new(modulePath: string, name: string): ContextElementDependency;
}

/**
 * Option Constants
 */
export interface AngularCompilerPluginOptions {
  sourceMap?: boolean;
  tsConfigPath: string;
  basePath?: string;
  entryModule?: string;
  mainPath?: string;
  skipCodeGeneration?: boolean;
  hostReplacementPaths?: { [path: string]: string } | ((path: string) => string);
  forkTypeChecker?: boolean;
  i18nInFile?: string;
  i18nInFormat?: string;
  i18nOutFile?: string;
  i18nOutFormat?: string;
  locale?: string;
  missingTranslation?: string;
  platform?: PLATFORM;
  nameLazyFiles?: boolean;
  logger?: logging.Logger;
  directTemplateLoading?: boolean;

  /**
   * When using the loadChildren string syntax, @ngtools/webpack must query @angular/compiler-cli
   * via a private API to know which lazy routes exist. This increases build and rebuild time.
   * When using Ivy, the string syntax is not supported at all. Thus we shouldn't attempt that
   * This option is also used for when the compilation doesn't need this sort of processing at all.
   * @deprecated SystemJsNgModuleLoader is deprecated, and this is part of its usage.
   */
  discoverLazyRoutes?: boolean;

  /** added to the list of lazy routes
   * @deprecated SystemJsNgModuleLoader is deprecated, and this is part of its usage.
   */
  additionalLazyModules?: { [module: string]: string };
  /**
   * @deprecated SystemJsNgModuleLoader is deprecated, and this is part of its usage.
   */
  additionalLazyModuleResources?: string[];

  // The ContextElementDependency of correct Webpack compilation.
  // This is needed when there are multiple Webpack installs.
  contextElementDependencyConstructor?: ContextElementDependencyConstructor;

  // Use tsconfig to include path globs.
  compilerOptions?: CompilerOptions;

  host?: virtualFs.Host<fs.Stats>;
  platformTransformers?: ts.TransformerFactory<ts.SourceFile>[];
}