@rhtml/schematics 0.0.132 → 0.0.134

package/src/utils/name.parser.ts

@@ -11,6 +11,12 @@ export interface Location {
 }
 
 export class NameParser {
+  /**
+   * Parses the provided options to extract the name and path.
+   *
+   * @param options - The options containing the name and path.
+   * @returns An object containing the parsed name and normalized path.
+   */
   public parse(options: ParseOptions): Location {
     const nameWithoutPath: string = basename(options.name as Path);
     const namePath: string = dirname(

package/src/utils/path.solver.ts

@@ -1,6 +1,13 @@
 import { basename, dirname, Path, relative } from '@angular-devkit/core';
 
 export class PathSolver {
+  /**
+   * Computes the relative path between two paths.
+   *
+   * @param from - The source path.
+   * @param to - The target path.
+   * @returns The relative path between the two paths.
+   */
   public relative(from: Path, to: Path): string {
     const placeholder = '/placeholder';
     const relativeDir = relative(

package/src/utils/source-root.helpers.ts

@@ -3,16 +3,28 @@ import { Rule, Tree } from '@angular-devkit/schematics';
 
 import { DEFAULT_PATH_NAME } from '../lib/defaults';
 
+/**
+ * Checks if the current directory is the root directory.
+ *
+ * @param host - The file tree representing the project.
+ * @param extraFiles - Additional files to check for in the root directory.
+ * @returns True if the current directory is the root directory, otherwise false.
+ */
 export function isInRootDirectory(
   host: Tree,
   extraFiles: string[] = []
 ): boolean {
-  const files = ['nest-cli.json', 'nest.json'].concat(extraFiles || []);
+  const files = [].concat(extraFiles || []);
   return files.map((file) => host.exists(file)).some((isPresent) => isPresent);
 }
 
+/**
+ * Merges the source root with the provided options.
+ * @param options - The options to merge with the source root.
+ * @returns A rule to merge the source root with the provided options.
+ */
 export function mergeSourceRoot<
-  T extends { sourceRoot?: string; path?: string } = unknown
+  T extends { sourceRoot?: string; path?: string } = never
 >(options: T): Rule {
   return (host: Tree) => {
     const isInRoot = isInRootDirectory(host, ['tsconfig.json', 'package.json']);