functions:kits:list

[Berlioz]

No description provided.

[gemini-code-assist]

Code Review

This pull request introduces the functions:kits:list command to list installed kits from firebase.json when the 'kits' experiment is enabled. The feedback recommends improving robustness by handling scenarios where the command is run outside of a Firebase project directory (checking for options.config and throwing a FirebaseError) and gracefully returning an empty array if no functions configuration is present in firebase.json.

[gemini-code-assist]

Import FirebaseError to handle the case where the command is run outside of a Firebase project directory.

Suggested change

	import { Command } from "../command";
	import { listKitConfigs } from "../functions/kits/config";
	import { Options } from "../options";
	import { logLabeledBullet } from "../utils";
	import { logger } from "../logger";
	import * as Table from "cli-table3";
	import { Command } from "../command";
	import { listKitConfigs } from "../functions/kits/config";
	import { Options } from "../options";
	import { logLabeledBullet } from "../utils";
	import { logger } from "../logger";
	import * as Table from "cli-table3";
	import { FirebaseError } from "../error";

[gemini-code-assist]

If the command is run outside of a Firebase project directory, options.config will be undefined. Accessing options.config.src will throw a TypeError. We should explicitly check if options.config is defined and throw a FirebaseError if it is not, adhering to the repository style guide on strict null checks and throwing user-facing errors.

Suggested change

	.action((options: Options) => {
	const firebaseConfig = options.config;
	const validatedConfig = firebaseConfig.src;
	const kitConfigs = listKitConfigs(validatedConfig);
	.action((options: Options) => {
	const firebaseConfig = options.config;
	if (!firebaseConfig) {
	throw new FirebaseError(
	"No active project configuration found. Please run this command from within a Firebase project directory."
	);
	}
	const validatedConfig = firebaseConfig.src;
	const kitConfigs = listKitConfigs(validatedConfig);

References

1. Use strict null checks and handle undefined/null explicitly. Throw FirebaseError for expected, user-facing errors. ^(link)

[gemini-code-assist]

If firebase.json does not contain a functions section, config.functions will be undefined. Calling normalizeAndValidate(undefined) will throw a FirebaseError stating "No valid functions configuration detected in firebase.json". For a list command, it is better to gracefully return an empty array so the command can print "there are no kits in firebase.json" instead of throwing an error.

Suggested change

	export function listKitConfigs(config: FirebaseConfig): ValidatedKitSingle[] {
	const normalized = normalizeAndValidate(config.functions);
	return normalized.filter((s) => isKitConfig(s));
	}
	export function listKitConfigs(config: FirebaseConfig): ValidatedKitSingle[] {
	if (!config.functions) {
	return [];
	}
	const normalized = normalizeAndValidate(config.functions);
	return normalized.filter((s) => isKitConfig(s));
	}

References

1. Use strict null checks and handle undefined/null explicitly. ^(link)

[inlined]

Fix errors obviously.

Looking at src/commands/deploy.ts it looks like the standard way of ensuring there's a firebase config is .before(requireConfig)

[wandamora]

Agree with Thomas. LGTM % gemini feedback.