[nanddeepn]

Adds 'spo file roleassignment list' command. Closes #6191

[Copilot]

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Adds the ability to list SharePoint file role assignments via a new command and centralizes file/permissions retrieval logic in the spo utility.

Changes:

• Updated SharePoint REST calls to use decodedUrl in GetFolderByServerRelativePath/GetFileByServerRelativePath requests
• Added spo.getFileByUrl() and spo.getFileRoleAssignments() helpers and refactored spo file get to reuse them
• Introduced new spo file roleassignment list command with tests and documentation

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
src/utils/spo.ts	Adds helper methods for file retrieval and role assignments; updates REST parameter casing
src/utils/spo.spec.ts	Updates URL expectations for decodedUrl and adds tests for new helpers
src/m365/spo/commands/file/file-roleassignment-list.ts	New command to list role assignments for a file by URL or ID
src/m365/spo/commands/file/file-roleassignment-list.spec.ts	Unit tests for the new command behavior and validation
src/m365/spo/commands/file/file-get.ts	Refactors permission retrieval to use shared spo.getFileRoleAssignments()
src/m365/spo/commands/file/file-get.spec.ts	Updates tests to stub spo.getFileRoleAssignments()
src/m365/spo/commands.ts	Registers new command constant
docs/src/config/sidebars.ts	Adds the new command doc to the sidebar
docs/docs/cmd/spo/file/file-roleassignment-list.mdx	Adds documentation page for the new command

[milanholemans]

Thanks, we'll try to review it ASAP!

[Copilot]

Copilot review overview

🟡 Changes recommended

The documented -i alias and required default output are missing, with additional validation, typing, test, and documentation gaps.

Get a fresh assessment by requesting another Copilot review.

Review effort: Lite
Findings: 2 · 2

Open (4)

• Docs advertise a short option -i for --fileId, but the command implementation only defines…
• The tests for the new command stub spo.getFileRoleAssignments() to return an array (.value),…
• Avoid asserting against the mutated role-assignment response · New
• Type the role-assignment helper as RoleAssignment[] · New

Resolved since last review (4)

• This test passes an absolute URL (fileUrl) into getFileRoleAssignments, but the REST endpoint…
• getFileRoleAssignments returns the full { value: ... } response object, but callers (eg.…
• Correct spelling of 'sucessfully' to 'successfully' in test titles.
• Correct spelling of 'sucessfully' to 'successfully' in test titles.

Previously missed (5)

In code that hasn't changed since last review

Add the missing -i alias for the fileId option

src/​m365/​spo/​commands/​file/​file-roleassignment-list.ts:55

The issue and this page document -i as the fileId alias, but this option is registered only as --fileId, so invocations using -i <guid> are rejected as unknown. Add the short alias to the option declaration.

Shape role assignments and declare default text properties

src/​m365/​spo/​commands/​file/​file-roleassignment-list.ts:100

The command logs the raw nested role-assignment objects, but the issue requires default text properties PrincipalId, Member/Title, and comma-separated RoleDefinitionBindings/Name. Without shaping those nested values (or extending the property filtering) and declaring the defaults, text output exposes the full response instead of the specified columns.

Add a Permissions section to the command page

docs/​docs/​cmd/​spo/​file/​file-roleassignment-list.mdx:44

This new command page has no ## Permissions section, so users cannot determine the minimum delegated and application permissions required for the read request. Add the permissions table before the response section.

Add representative JSON, text, CSV, and Markdown examples

docs/​docs/​cmd/​spo/​file/​file-roleassignment-list.mdx:50

All four response examples are empty code blocks, so the reference page does not show the returned role-assignment shape and does not satisfy the required JSON, text, CSV, and Markdown samples. Add representative output for each format.

Migrate fileUrl/fileId validation to the Zod schema

src/​m365/​spo/​commands/​file/​file-roleassignment-list.ts:78

This new command uses the legacy optionSets/validator pattern for the required fileUrl/fileId XOR. New command implementations use a refined Zod schema for this constraint (for example, file-version-keep.ts:12-47); migrate this validation so the command participates in the current option schema pipeline.

[MartinM85]

Hi @nanddeepn, could you please check the findings from Copilot? Thank you

[nanddeepn]

Hi @MartinM85
Done

[MartinM85]

Thank you for the contribution @nanddeepn 🚀
Looks good overall, just a few tiny things to consider. One major thing is to use the Zod schema for command options, but our AI skill can help you save a time.

[MartinM85]

The example of a JSON response is missing. Same for the text, csv and md output. Could you please add the response?

[MartinM85]

Suggested change

	: The server- or site-relative decoded URL of the file. Specify either `fileUrl` or `fileId` but not both.
	: The server- or site-relative decoded URL of the file. Specify either `fileUrl` or `fileId`, but not both.

[MartinM85]

Suggested change

	: The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
	: The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId`, but not both.

[MartinM85]

Please use Zod schema instead of the old way.
You can use zod-migration skill. It will convert the current options to zod schema and modify unit tests.