pnp/cli-microsoft365

Enhancement: Add folder color to `spo folder get`

Open

#5,896 opened on Mar 8, 2024

View on GitHub
 (5 comments) (2 reactions) (0 assignees)TypeScript (399 forks)auto 404
enhancementhelp wantedkeep-openneeds research

Repository metrics

Stars
 (1,390 stars)
PR merge metrics
 (PR metrics pending)

Description

Related to:

  • #5894
  • #5895

The idea for this issue is to read the current folder color.

I suggest that we add a new option.

Option Description
--withColor Also return the color of the folder.

This results in 2 extra properties in the output:

{
  "color": "5",
  "colorValue": "darkBlue"
}

Notice that these 2 properties don't exist natively and we have to create them ourselves.

Tech implementation

Some more research here should be needed. Retrieving the ColorHex field doesn't seem that easy using the REST API. One way I found is by using:

GET https://tenant.sharepoint.com/sites/Projects/_api/Web/GetFolderByServerRelativePath(DecodedUrl='/sites/Projects/Cortex')?$expand=properties&$select=*,properties/vti_x005f_colorhex

This returns the color hex but it isn't ideal. Let's try to look if there's a better way.

Contributor guide

Research direction
Investigate SharePoint REST API to retrieve folder color; consider alternative methods like Graph API or CSOM. Implement new option ` withColor` in `spo folder get` command, adding color and colorValue properties.
Tech stack
typescript
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Needs investigation
Prerequisites
GitTypeScriptSharePoint
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60