generate --help ignores custom collections

[micalevisk]

Is there an existing issue for this?

• I have searched the existing issues

Current behavior

nest generate --help always outputs this:

(a list of available schematics) even when the schematics from @nestjs/schematics aren't available. For instance, using a custom collection

$  cat nest-cli.json 
{
  "collection": "../my-collection-that-doesnt-extends-nestjs-schematics",
  "sourceRoot": "src"
}

then we can't run, for instance, nest generate application

---

basically this is due to the following:

nest-cli/commands/generate.command.ts

Lines 77 to 83 in 35df7f8

	private buildDescription(): string {
	return (
	'Generate a Nest element.\n' +
	' Available schematics:\n' +
	this.buildSchematicsListAsTable()
	);
	}

nest-cli/commands/generate.command.ts

Line 100 in 35df7f8

for (const schematic of NestCollection.getSchematics()) {

nest-cli/lib/schematics/nest.collection.ts

Lines 124 to 128 in 35df7f8

	public static getSchematics(): Schematic[] {
	return NestCollection.schematics.filter(
	(item) => item.name !== 'angular-app',
	);
	}

which doesn't take in count the collection option from nest-cli.json config file

Expected behavior

nest generate --help should list the schematics available in the loaded collection

But I see three problems here:

• can we fetch all schematics available of a collection programmatically?
• the config file must be parsed every time someone uses --help, to retrieve the collection name. Which I think will degraded DX (without thinking of caching things around)
• I don't think we can load the value of --collection option on GenerateCommand#buildDescription method

So, looks like listing the right set of schematics is not possible.

Then what we could do is indicate that the table lists schematics from the collection @nestjs/schematics, not just "Available schematics". This should avoid misusages of NestJS's CLI. Maybe "Schematics available on @nestjs/schematics collection" will be enough?

Package version

8.1.5

NestJS version

8.2.3

[kamilmysliwiec]

Then what we could do is indicate that the table lists schematics from the collection @nestjs/schematics, not just "Available schematics". This should avoid misusages of NestJS's CLI. Maybe "Schematics available on @nestjs/schematics collection" will be enough?

Sounds good! Would you like to create a PR for this issue?