packages/angular_devkit/schematics/src/tree/null.ts - main - githubmirror/angular-cli

packages/angular_devkit/schematics/src/tree/null.ts
122 строки3 KB
Charles Lyding
refactor(@angular-devkit/schematics): support `isolatedDeclarations` for tree classes
20 янв 2026, 20:59
20 янв 2026, 20:59ecc0797
/**
 * @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 {
  BaseException,
  JsonValue,
  Path,
  PathFragment,
  dirname,
  join,
  normalize,
} from '@angular-devkit/core';
import { FileDoesNotExistException } from '../exception/exception';
import { Action } from './action';
import { DirEntry, MergeStrategy, Tree, TreeSymbol, UpdateRecorder } from './interface';
import { UpdateRecorderBase } from './recorder';

export class CannotCreateFileException extends BaseException {
  constructor(path: string) {
    super(`Cannot create file "${path}".`);
  }
}

export class NullTreeDirEntry implements DirEntry {
  get parent(): DirEntry | null {
    return this.path == '/' ? null : new NullTreeDirEntry(dirname(this.path));
  }

  constructor(public readonly path: Path) {}

  readonly subdirs: PathFragment[] = [];
  readonly subfiles: PathFragment[] = [];

  dir(name: PathFragment): DirEntry {
    return new NullTreeDirEntry(join(this.path, name));
  }
  file(_name: PathFragment) {
    return null;
  }

  visit(): void {}
}

// Workaround for "error TS9038: Computed property names on class or object literals cannot be inferred with --isolatedDeclarations."
// When this is fixed within TypeScript, the method can be added back directly to the class.
// See: https://github.com/microsoft/TypeScript/issues/61892
// eslint-disable-next-line @typescript-eslint/no-unsafe-declaration-merging
export interface NullTree {
  [TreeSymbol](): NullTree;
}

// eslint-disable-next-line @typescript-eslint/no-unsafe-declaration-merging
export class NullTree implements Tree {
  constructor() {
    this[TreeSymbol] = () => this;
  }

  branch(): Tree {
    return new NullTree();
  }
  merge(_other: Tree, _strategy?: MergeStrategy): void {}

  readonly root: DirEntry = new NullTreeDirEntry(normalize('/'));

  // Simple readonly file system operations.
  exists(_path: string) {
    return false;
  }
  read(_path: string) {
    return null;
  }
  readText(path: string): string {
    throw new FileDoesNotExistException(path);
  }
  readJson(path: string): JsonValue {
    throw new FileDoesNotExistException(path);
  }
  get(_path: string) {
    return null;
  }
  getDir(path: string): NullTreeDirEntry {
    return new NullTreeDirEntry(normalize('/' + path));
  }
  visit(): void {}

  // Change content of host files.
  beginUpdate(path: string): never {
    throw new FileDoesNotExistException(path);
  }
  commitUpdate(record: UpdateRecorder): never {
    throw new FileDoesNotExistException(
      record instanceof UpdateRecorderBase ? record.path : '<unknown>',
    );
  }

  // Change structure of the host.
  copy(path: string, _to: string): never {
    throw new FileDoesNotExistException(path);
  }
  delete(path: string): never {
    throw new FileDoesNotExistException(path);
  }
  create(path: string, _content: Buffer | string): never {
    throw new CannotCreateFileException(path);
  }
  rename(path: string, _to: string): never {
    throw new FileDoesNotExistException(path);
  }
  overwrite(path: string, _content: Buffer | string): never {
    throw new FileDoesNotExistException(path);
  }

  apply(_action: Action, _strategy?: MergeStrategy): void {}
  get actions(): Action[] {
    return [];
  }
}