Migrate file commands to Zod#7370
Open
waldekmastykarz wants to merge 3 commits into
Open
Conversation
Migrates all 5 file commands under src/m365/file/commands/ from the old options/validators/telemetry pattern to Zod schemas: - file add - file copy - file list - file move - file convert pdf Closes pnp#7303 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Adds missing test to cover the folderUrl validation error callback, fixing 100% function coverage. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Migrates the m365 file command set from the legacy #initTelemetry/#initOptions/#initValidators pattern to Zod-based option schemas, aligning these commands with the newer schema-driven command infrastructure (option metadata + validation + telemetry).
Changes:
- Replaced manual option/validator/telemetry initialization with exported
z.strictObjectoption schemas andschemagetters for 5filecommands. - Moved additional validations (eg. file existence, optional URL validity) into
getRefinedSchema()where needed. - Updated unit tests to validate options via
commandInfo.command.getSchemaToParse().safeParse(...)rather thancommand.validate(...).
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/m365/file/commands/file-move.ts | Defines Zod schema for file move options (incl. enums/aliases) and removes legacy init methods. |
| src/m365/file/commands/file-move.spec.ts | Switches validation tests to schema safeParse. |
| src/m365/file/commands/file-list.ts | Defines Zod schema for file list options and removes legacy init methods. |
| src/m365/file/commands/file-list.spec.ts | Switches validation tests to schema safeParse. |
| src/m365/file/commands/file-copy.ts | Defines Zod schema for file copy options (incl. enums/aliases) and removes legacy init methods. |
| src/m365/file/commands/file-copy.spec.ts | Switches validation tests to schema safeParse. |
| src/m365/file/commands/file-add.ts | Defines Zod schema for file add options and adds refined schema checks (file existence, optional siteUrl). |
| src/m365/file/commands/file-add.spec.ts | Switches validation tests to schema safeParse and adds a folderUrl-invalid test. |
| src/m365/file/commands/convert/convert-pdf.ts | Defines Zod schema for file convert pdf options and moves path checks into refined schema. |
| src/m365/file/commands/convert/convert-pdf.spec.ts | Switches validation tests to schema safeParse. |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Migrates all 5
filecommands to use Zod schemas for option definitions and validation, replacing the old#initTelemetry,#initOptions, and#initValidatorspattern.Commands migrated
file addfolderUrl/siteUrlSharePoint URL validation via Zod refine;filePathexistence check viagetRefinedSchemafile copywebUrlSharePoint URL validation;nameConflictBehaviorasz.enumfile listwebUrlSharePoint URL validation;recursiveas optional booleanfile movewebUrlSharePoint URL validation;nameConflictBehaviorasz.enumfile convert pdfsourceFile/targetFileexistence checks viagetRefinedSchemaChanges per file
#initTelemetry,#initOptions,#initValidators; added exportedz.strictObjectschema withglobalOptionsZod.shapespread andget schema()gettercommandOptionsSchema.safeParse()instead ofcommand.validate()Closes #7303