Enhancement: Improve message of invalid option in a Zod schema

[MartinM85]

Priority

(Low) Something is a little off

Description

When the command defines options in a Zod schema and the user type specify wrong option the output is

Error: : Unrecognized key(s) in object: 'xxx'

I would expect the message

Error: Invalid option: 'xxx'

Steps to reproduce

Run the command

m365 login --tenant <tenantId> --appId <appId> --xxx

Expected results

Error: Invalid option: 'xxx'
Run 'm365 login -h' for help.

Actual results

Error: : Unrecognized key(s) in object: 'xxx'
Run 'm365 login -h' for help.

Diagnostics

No response

CLI for Microsoft 365 version

v10.1.0

nodejs version

v20.8.1

Operating system (environment)

Windows

Shell

PowerShell

cli doctor

No response

Additional Info

No response

[waldekmastykarz]

Thanks for bringing this up, @MartinM85. I wouldn't say it's a bug, because it's the default zod's behavior. That said, I agree that it could be clearer. Let's look for ways to improve it.

[MartinM85]

@waldekmastykarz Yes, enhancement makes more sense.

Maybe off topic, but does zod support unknown option?

Alternative to

public allowUnknownOptions(): boolean | undefined {
  return true;
}

[waldekmastykarz]

Yes, it does. By default, schema allows unknown options. You can restrict by including .strict() in the schema definition:

cli-microsoft365/src/m365/commands/login.ts

Lines 13 to 31 in 10765f6

	const options = globalOptionsZod
	.extend({
	authType: zod.alias('t', zod.coercedEnum(AuthType).optional()),
	cloud: zod.coercedEnum(CloudType).optional().default(CloudType.Public),
	userName: zod.alias('u', z.string().optional()),
	password: zod.alias('p', z.string().optional()),
	certificateFile: zod.alias('c', z.string().optional()
	.refine(filePath => !filePath || fs.existsSync(filePath), filePath => ({
	message: `Certificate file ${filePath} does not exist`
	}))),
	certificateBase64Encoded: z.string().optional(),
	thumbprint: z.string().optional(),
	appId: z.string().optional(),
	tenant: z.string().optional(),
	secret: zod.alias('s', z.string().optional()),
	connectionName: z.string().optional(),
	ensure: z.boolean().optional()
	})
	.strict();