feat(@angular-devkit/schematics): add parameter to listSchematicNames to allow returning hidden schematics.

The return value of `listSchematicNames` will include hidden schematics when is invoked with true as first parameter.

By default, hidden schematics are not returned.

Author: alan-agius4

goldens/public-api/angular_devkit/schematics/src/index.md

@@ -159,7 +159,7 @@ export interface Collection<CollectionMetadataT extends object, SchematicMetadat
     // (undocumented)
     readonly description: CollectionDescription<CollectionMetadataT>;
     // (undocumented)
-    listSchematicNames(): string[];
+    listSchematicNames(includeHidden?: boolean): string[];
 }
 
 // @public
@@ -178,7 +178,7 @@ export class CollectionImpl<CollectionT extends object, SchematicT extends objec
     // (undocumented)
     get description(): CollectionDescription<CollectionT>;
     // (undocumented)
-    listSchematicNames(): string[];
+    listSchematicNames(includeHidden?: boolean): string[];
     // (undocumented)
     get name(): string;
 }
@@ -380,7 +380,7 @@ export interface EngineHost<CollectionMetadataT extends object, SchematicMetadat
     // (undocumented)
     hasTaskExecutor(name: string): boolean;
     // (undocumented)
-    listSchematicNames(collection: CollectionDescription<CollectionMetadataT>): string[];
+    listSchematicNames(collection: CollectionDescription<CollectionMetadataT>, includeHidden?: boolean): string[];
     // (undocumented)
     transformContext(context: TypedSchematicContext<CollectionMetadataT, SchematicMetadataT>): TypedSchematicContext<CollectionMetadataT, SchematicMetadataT> | void;
     // (undocumented)
@@ -755,7 +755,7 @@ export class SchematicEngine<CollectionT extends object, SchematicT extends obje
     // (undocumented)
     executePostTasks(): Observable<void>;
     // (undocumented)
-    listSchematicNames(collection: Collection<CollectionT, SchematicT>): string[];
+    listSchematicNames(collection: Collection<CollectionT, SchematicT>, includeHidden?: boolean): string[];
     // (undocumented)
     transformOptions<OptionT extends object, ResultT extends object>(schematic: Schematic<CollectionT, SchematicT>, options: OptionT, context?: TypedSchematicContext<CollectionT, SchematicT>): Observable<ResultT>;
     // (undocumented)

goldens/public-api/angular_devkit/schematics/tools/index.md

@@ -111,7 +111,7 @@ export abstract class FileSystemEngineHostBase implements FileSystemEngineHost_2
     // (undocumented)
     hasTaskExecutor(name: string): boolean;
     // (undocumented)
-    listSchematicNames(collection: FileSystemCollectionDesc): string[];
+    listSchematicNames(collection: FileSystemCollectionDesc, includeHidden?: boolean): string[];
     // (undocumented)
     registerContextTransform(t: ContextTransform): void;
     // (undocumented)

packages/angular_devkit/schematics/src/engine/engine.ts

@@ -83,7 +83,8 @@ export class UnknownTaskDependencyException extends BaseException {
 }
 
 export class CollectionImpl<CollectionT extends object, SchematicT extends object>
-  implements Collection<CollectionT, SchematicT> {
+  implements Collection<CollectionT, SchematicT>
+{
   constructor(
     private _description: CollectionDescription<CollectionT>,
     private _engine: SchematicEngine<CollectionT, SchematicT>,
@@ -101,8 +102,8 @@ export class CollectionImpl<CollectionT extends object, SchematicT extends objec
     return this._engine.createSchematic(name, this, allowPrivate);
   }
 
-  listSchematicNames(): string[] {
-    return this._engine.listSchematicNames(this);
+  listSchematicNames(includeHidden?: boolean): string[] {
+    return this._engine.listSchematicNames(this, includeHidden);
   }
 }
 
@@ -169,7 +170,8 @@ export class TaskScheduler {
 }
 
 export class SchematicEngine<CollectionT extends object, SchematicT extends object>
-  implements Engine<CollectionT, SchematicT> {
+  implements Engine<CollectionT, SchematicT>
+{
   private _collectionCache = new Map<string, CollectionImpl<CollectionT, SchematicT>>();
   private _schematicCache = new WeakMap<
     Collection<CollectionT, SchematicT>,
@@ -333,12 +335,15 @@ export class SchematicEngine<CollectionT extends object, SchematicT extends obje
     return schematic;
   }
 
-  listSchematicNames(collection: Collection<CollectionT, SchematicT>): string[] {
-    const names = this._host.listSchematicNames(collection.description);
+  listSchematicNames(
+    collection: Collection<CollectionT, SchematicT>,
+    includeHidden?: boolean,
+  ): string[] {
+    const names = this._host.listSchematicNames(collection.description, includeHidden);
 
     if (collection.baseDescriptions) {
       for (const base of collection.baseDescriptions) {
-        names.push(...this._host.listSchematicNames(base));
+        names.push(...this._host.listSchematicNames(base, includeHidden));
       }
     }
 

packages/angular_devkit/schematics/src/engine/interface.ts

@@ -83,7 +83,10 @@ export interface EngineHost<CollectionMetadataT extends object, SchematicMetadat
     name: string,
     requester?: CollectionDescription<CollectionMetadataT>,
   ): CollectionDescription<CollectionMetadataT>;
-  listSchematicNames(collection: CollectionDescription<CollectionMetadataT>): string[];
+  listSchematicNames(
+    collection: CollectionDescription<CollectionMetadataT>,
+    includeHidden?: boolean,
+  ): string[];
 
   createSchematicDescription(
     name: string,
@@ -162,7 +165,7 @@ export interface Collection<CollectionMetadataT extends object, SchematicMetadat
     name: string,
     allowPrivate?: boolean,
   ): Schematic<CollectionMetadataT, SchematicMetadataT>;
-  listSchematicNames(): string[];
+  listSchematicNames(includeHidden?: boolean): string[];
 }
 
 /**

packages/angular_devkit/schematics/tools/fallback-engine-host.ts

@@ -90,11 +90,11 @@ export class FallbackEngineHost implements EngineHost<{}, {}> {
     context?: FallbackContext,
   ): Observable<ResultT> {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    return ((observableOf(options) as any).pipe(
+    return (observableOf(options) as any).pipe(
       ...this._hosts.map((host) =>
         mergeMap((opt: {}) => host.transformOptions(schematic, opt, context)),
       ),
-    ) as {}) as Observable<ResultT>;
+    ) as {} as Observable<ResultT>;
   }
 
   transformContext(context: FallbackContext): FallbackContext {
@@ -107,11 +107,16 @@ export class FallbackEngineHost implements EngineHost<{}, {}> {
     return result;
   }
 
-  listSchematicNames(collection: CollectionDescription<FallbackCollectionDescription>): string[] {
+  listSchematicNames(
+    collection: CollectionDescription<FallbackCollectionDescription>,
+    includeHidden?: boolean,
+  ): string[] {
     const allNames = new Set<string>();
     this._hosts.forEach((host) => {
       try {
-        host.listSchematicNames(collection.description).forEach((name) => allNames.add(name));
+        host
+          .listSchematicNames(collection.description, includeHidden)
+          .forEach((name) => allNames.add(name));
       } catch (_) {}
     });
 

packages/angular_devkit/schematics/tools/file-system-engine-host-base.ts

@@ -118,12 +118,12 @@ export abstract class FileSystemEngineHostBase implements FileSystemEngineHost {
   private _contextTransforms: ContextTransform[] = [];
   private _taskFactories = new Map<string, () => Observable<TaskExecutor>>();
 
-  listSchematicNames(collection: FileSystemCollectionDesc) {
+  listSchematicNames(collection: FileSystemCollectionDesc, includeHidden?: boolean) {
     const schematics: string[] = [];
     for (const key of Object.keys(collection.schematics)) {
       const schematic = collection.schematics[key];
 
-      if (schematic.hidden || schematic.private) {
+      if ((schematic.hidden && !includeHidden) || schematic.private) {
         continue;
       }
 

packages/angular_devkit/schematics/tools/file-system-engine-host_spec.ts

@@ -245,12 +245,38 @@ describe('FileSystemEngineHost', () => {
     expect(() => engine.createCollection('invalid-aliases-2')).toThrow();
   });
 
-  it('does not list hidden schematics', () => {
+  it(`does not list hidden schematics when 'includeHidden' is not specified`, () => {
     const engineHost = new FileSystemEngineHost(root);
     const engine = new SchematicEngine(engineHost);
     const collection = engine.createCollection('hidden-schematics');
 
-    expect(collection.listSchematicNames()).toEqual(['schematic-1', 'schematic-2']);
+    expect(collection.listSchematicNames(/** includeHidden */)).toEqual([
+      'schematic-1',
+      'schematic-2',
+    ]);
+  });
+
+  it(`does not list hidden schematics when 'includeHidden' is false`, () => {
+    const engineHost = new FileSystemEngineHost(root);
+    const engine = new SchematicEngine(engineHost);
+    const collection = engine.createCollection('hidden-schematics');
+
+    expect(collection.listSchematicNames(false /** includeHidden */)).toEqual([
+      'schematic-1',
+      'schematic-2',
+    ]);
+  });
+
+  it(`does list hidden schematics when 'includeHidden' is true`, () => {
+    const engineHost = new FileSystemEngineHost(root);
+    const engine = new SchematicEngine(engineHost);
+    const collection = engine.createCollection('hidden-schematics');
+
+    expect(collection.listSchematicNames(true /** includeHidden */)).toEqual([
+      'hidden-schematic',
+      'schematic-1',
+      'schematic-2',
+    ]);
   });
 
   it('does not list private schematics', () => {