src/cdk/schematics/utils/schematic-options.ts - main - githubmirror/components

src/cdk/schematics/utils/schematic-options.ts
88 строк4 KB
Charles Lyding
refactor(cdk/schematics): use `@schematics/angular/utility` for workspace helpers
25 апр 2025, 08:49
25 апр 2025, 08:4993e2aab
/**
 * @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.dev/license
 */

import {isJsonObject, JsonObject} from '@angular-devkit/core';
import {Schema, Style} from '@schematics/angular/component/schema';
import {isStandaloneApp} from '@schematics/angular/utility/ng-ast-utils';
import {getProjectMainFile} from './project-main-file';
import {ProjectDefinition, readWorkspace} from '@schematics/angular/utility';
import {getProjectFromWorkspace} from './get-project';
import {Tree} from '@angular-devkit/schematics';

/**
 * Returns the default options for the `@schematics/angular:component` schematic which would
 * have been specified at project initialization (ng new or ng init).
 *
 * This is necessary because the Angular CLI only exposes the default values for the "--style",
 * "--inlineStyle", "--skipTests" and "--inlineTemplate" options to the "component" schematic.
 */
export function getDefaultComponentOptions(project: ProjectDefinition): Partial<Schema> {
  // Note: Not all options which are available when running "ng new" will be stored in the
  // workspace config. List of options which will be available in the configuration:
  // angular/angular-cli/blob/main/packages/schematics/angular/application/index.ts#L109-L131
  let skipTests = getDefaultComponentOption<boolean | null>(project, ['skipTests'], null);

  // In case "skipTests" is not set explicitly, also look for the "spec" option. The "spec"
  // option has been deprecated but can be still used in older Angular CLI projects.
  // See: https://github.com/angular/angular-cli/commit/a12a4e02a4689b5bdbc6e740c0d9865afb55671a
  if (skipTests === null) {
    skipTests = !getDefaultComponentOption(project, ['spec'], true);
  }

  return {
    style: getDefaultComponentOption<Style>(project, ['style', 'styleext'], Style.Css),
    inlineStyle: getDefaultComponentOption(project, ['inlineStyle'], false),
    inlineTemplate: getDefaultComponentOption(project, ['inlineTemplate'], false),
    skipTests: skipTests,
  };
}

/** Determines whether the schematic is configured to be standalone. */
export async function isStandaloneSchematic(host: Tree, options: Schema): Promise<boolean> {
  if (options.standalone != null) {
    return options.standalone;
  }

  // If the `--standalone` flag isn't passed and there isn't a default, infer based on the project.
  const workspace = await readWorkspace(host);
  const project = getProjectFromWorkspace(workspace, options.project);

  // Legacy projects might not have a `build` target, but they're likely
  // not on an Angular version that supports standalone either.
  if (!project.targets?.has('build')) {
    return false;
  }

  return isStandaloneApp(host, getProjectMainFile(project));
}

/**
 * Gets the default value for the specified option. The default options will be determined
 * by looking at the stored schematic options for `@schematics/angular:component` in the
 * CLI workspace configuration.
 */
function getDefaultComponentOption<T>(
  project: ProjectDefinition,
  optionNames: string[],
  fallbackValue: T,
): T {
  const schematicOptions = isJsonObject(project.extensions['schematics'] || null)
    ? (project.extensions['schematics'] as JsonObject)
    : null;
  const defaultSchematic = schematicOptions
    ? (schematicOptions['@schematics/angular:component'] as JsonObject | null)
    : null;

  for (const optionName of optionNames) {
    if (defaultSchematic && defaultSchematic[optionName] != null) {
      return defaultSchematic[optionName] as unknown as T;
    }
  }

  return fallbackValue;
}