Adds prompting on invalid option sets in Zod-enabled commands by waldekmastykarz · Pull Request #7061 · pnp/cli-microsoft365

waldekmastykarz · 2025-12-06T12:45:09Z

Adds prompting on invalid option sets in Zod-enabled commands. Closes #7060

waldekmastykarz · 2025-12-06T12:47:56Z

To test, run:

m365 login -t password > input prompts for username and password
m365 login -t certificate > selection prompt for the cert option
possible to abort prompt and close the CLI without an exception, by pressing CTRL+C

Notice the additional information that we'll need in refined schema definition to feed prompts.

Let's verify that this approach works and meets all our needs. I'll then add the necessary tests and fix existing Zod-enabled commands to support this properly.

waldekmastykarz · 2025-12-21T13:12:08Z

Let's continue with this after we merge #7005 so that we do the migration/alignment work once.

Adam-it · 2026-01-04T00:17:50Z

Let's continue with this after we merge #7005 so that we do the migration/alignment work once.

@waldekmastykarz this one got merged so I think we may continue.
I also tested this PR locally, and this is exactly what we need to recreate 👍

…np#7060

Copilot

Pull request overview

This PR implements interactive prompting for invalid option sets in Zod-enabled commands to maintain UX consistency with non-Zod commands. When users provide invalid option combinations (e.g., specifying both mutually exclusive options or none of the required options), the CLI now prompts them to select and provide values for the correct options instead of immediately exiting with an error.

Changes:

Added prompting logic in src/cli/cli.ts to detect and handle option set validation errors from Zod schemas by checking for custom error params with customCode: 'optionSet'
Modified error handling in src/index.ts to catch ExitPromptError at the top level (moved from src/utils/prompt.ts)
Updated 50+ command files to add params metadata to their Zod .refine() calls, marking them as either optionSet or required validation errors for proper prompting behavior

Reviewed changes

Copilot reviewed 53 out of 53 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
src/index.ts	Added top-level ExitPromptError handling to exit gracefully when user cancels prompts
src/utils/prompt.ts	Removed ExitPromptError catch block from prompt.forInput (now handled at top level)
src/cli/cli.ts	Implemented option set prompting logic that classifies validation errors and prompts users to select and provide values for option sets
src/cli/cli.spec.ts	Added comprehensive tests for option set prompting, required field prompting, and error handling with refined schemas
src/m365/viva/commands/engage/*.ts	Added optionSet params to refine() calls for community and role option validations
src/m365/teams/commands/callrecord/callrecord-list.ts	Added optionSet params for userId/userName validation
src/m365/spp/commands/*/.ts	Added optionSet params for model and autofill column option validations
src/m365/spo/commands/*/.ts	Added optionSet/required params for list, page, homesite, file, and web alert option validations
src/m365/spe/commands/*/.ts	Added optionSet params for container and containertype option validations
src/m365/pp/commands/*/.ts	Added optionSet params for website and environment option validations
src/m365/pa/commands/environment/environment-get.ts	Added optionSet params for name/default validation
src/m365/outlook/commands/*/.ts	Added optionSet/required params for mailbox and mail searchfolder option validations
src/m365/graph/commands/directoryextension/*.ts	Added optionSet params for directory extension option validations
src/m365/flow/commands/environment/environment-get.ts	Added optionSet params for name/default validation
src/m365/exo/commands/approleassignment/approleassignment-add.ts	Added optionSet params for extensive role and scope option validations
src/m365/entra/commands/*/.ts	Added optionSet/required params for user, role, admin unit, and organization option validations
src/m365/commands/login.ts	Added optionSet/required params for authentication option validations
src/m365/booking/commands/business/business-get.ts	Added optionSet params for id/name validation
src/m365/app/commands/permission/permission-add.ts	Added required params for permission option validation
src/m365/adaptivecard/commands/adaptivecard-send.ts	Added required params for card option validation

Copilot · 2026-02-23T14:01:26Z

src/cli/cli.ts

+  const selectedOptionName = await prompt.forSelection<string>({ message: `Option to use:`, choices: options.map((choice: any) => { return { name: choice, value: choice }; }) });
+  const optionValue = await prompt.forInput({ message: `${selectedOptionName}:` });
+
+  args.options[selectedOptionName] = optionValue;


The prompted option value is directly assigned as a string without type coercion. Unlike the handling of missing required values (lines 222-223), which uses getCommandOptionsFromArgs to coerce the value to the correct type, this code doesn't perform any type coercion. If an option in the option set expects a non-string type (e.g., number, boolean, UUID), validation may fail on the next iteration of the while loop. Consider using the same type coercion approach as the missing required values handling.

Suggested change

args.options[selectedOptionName] = optionValue;

let coercedValue: unknown = optionValue;

// Basic type coercion to align with how CLI arguments are typically parsed

if (typeof optionValue === 'string') {

const trimmed = optionValue.trim();

if (trimmed === 'true') {

coercedValue = true;

}

else if (trimmed === 'false') {

coercedValue = false;

}

else if (trimmed !== '' && !isNaN(Number(trimmed))) {

coercedValue = Number(trimmed);

}

}

args.options[selectedOptionName] = coercedValue as any;

So I actually managed to reproduce the type coercion bug. Here's what happens with m365 pp environment get:

You get prompted to pick an option > select default

Type something as the value > CLI crashes with Error: The value 'test' for option '--default' is not a valid boolean

Even if you type true, it loops back and prompts again for the default as if it's still missing

The value gets stored as a raw string ("true") in args.options, but the Zod schema expects a proper boolean true. So validation fails again, this time as a missingRequiredValuesErrors error, which re-prompts you.

Jwaegebaert

Great work @waldekmastykarz! Left a few minor suggestion and the topic Copilot suggested seems something interesting to look into. That function works fine for strings but as soon as we work with other types the behavior seems to change a bit.

Jwaegebaert · 2026-02-23T15:21:37Z

src/cli/cli.ts

+        const otherErrors: z.core.$ZodIssue[] = result.error.issues
+          .filter(e => !missingRequiredValuesErrors.includes(e) && !optionSetErrors.includes(e as z.core.$ZodIssueCustom));
+
+        if (otherErrors.some(e => e)) {


Maybe a bit nitpicking but I think .length > 0 would be a bit cleaner in this scenario

I wonder if there's a performance penalty for using length over some. Typically, when you use length, the runtime needs to calculate the full length of a collection. In comparison, when you use some, the runtime uses the iterator and stops as soon as the condition is met, which would be more efficient.

If I'm not mistaken, it’s a field the engine keeps up to date when the array changes, so checking otherErrors.length > 0 is basically just a quick property read.

src/cli/cli.ts

waldekmastykarz force-pushed the zod-optionset-prompt branch from e44a046 to 5b7f650 Compare December 27, 2025 17:17

Adds prompting on invalid option sets in Zod-enabled commands. Closes p…

ff328b7

…np#7060

waldekmastykarz force-pushed the zod-optionset-prompt branch from 5b7f650 to ff328b7 Compare February 22, 2026 09:46

waldekmastykarz changed the title ~~WIP: Adds prompting on invalid option sets in Zod-enabled commands~~ Adds prompting on invalid option sets in Zod-enabled commands Feb 22, 2026

waldekmastykarz marked this pull request as ready for review February 22, 2026 09:47

Jwaegebaert requested a review from Copilot February 23, 2026 13:56

Jwaegebaert self-assigned this Feb 23, 2026

Copilot started reviewing on behalf of Jwaegebaert February 23, 2026 13:57 View session

Copilot AI reviewed Feb 23, 2026

View reviewed changes

Jwaegebaert requested changes Feb 23, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adds prompting on invalid option sets in Zod-enabled commands#7061

Adds prompting on invalid option sets in Zod-enabled commands#7061
waldekmastykarz wants to merge 1 commit intopnp:mainfrom
waldekmastykarz:zod-optionset-prompt

waldekmastykarz commented Dec 6, 2025 •

edited

Loading

Uh oh!

waldekmastykarz commented Dec 6, 2025

Uh oh!

waldekmastykarz commented Dec 21, 2025

Uh oh!

Adam-it commented Jan 4, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Feb 23, 2026

Uh oh!

Jwaegebaert Feb 23, 2026

Uh oh!

Jwaegebaert left a comment

Uh oh!

Jwaegebaert Feb 23, 2026

Uh oh!

waldekmastykarz Feb 26, 2026

Uh oh!

Jwaegebaert Mar 4, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

-  args.options[selectedOptionName] = optionValue;
+  let coercedValue: unknown = optionValue;
+  // Basic type coercion to align with how CLI arguments are typically parsed
+  if (typeof optionValue === 'string') {
+    const trimmed = optionValue.trim();
+    if (trimmed === 'true') {
+      coercedValue = true;
+    }
+    else if (trimmed === 'false') {
+      coercedValue = false;
+    }
+    else if (trimmed !== '' && !isNaN(Number(trimmed))) {
+      coercedValue = Number(trimmed);
+    }
+  }
+  args.options[selectedOptionName] = coercedValue as any;

Conversation

waldekmastykarz commented Dec 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

waldekmastykarz commented Dec 6, 2025

Uh oh!

waldekmastykarz commented Dec 21, 2025

Uh oh!

Adam-it commented Jan 4, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Feb 23, 2026

Choose a reason for hiding this comment

Uh oh!

Jwaegebaert Feb 23, 2026

Choose a reason for hiding this comment

Uh oh!

Jwaegebaert left a comment

Choose a reason for hiding this comment

Uh oh!

Jwaegebaert Feb 23, 2026

Choose a reason for hiding this comment

Uh oh!

waldekmastykarz Feb 26, 2026

Choose a reason for hiding this comment

Uh oh!

Jwaegebaert Mar 4, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

waldekmastykarz commented Dec 6, 2025 •

edited

Loading