pnp/cli-microsoft365

Enhance `spo site list` to return archived sites

Open

#6,547 opened on Jan 4, 2025

View on GitHub
 (16 comments) (0 reactions) (1 assignee)TypeScript (399 forks)auto 404
hacktoberfestnew featurework in progress

Repository metrics

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

Description

Idea

Let's enhance the command spo site list to return sites that are archived using spo site archive. The idea is to expand option --type [type] with extra options: fullyArchived, recentlyArchived, and archived.

Let's make sure that we use the same API that is currently being used. The output of the command cannot alter.

Remarks

(Include these remarks in the docs to make it clearer)

When providing a value for option type, consider the following:

  • fullyArchived: return sites that are fully archived (longer than 7 days)
  • recentlyArchived: return sites that are recently archived (within 7 days)
  • archived: return both recently archived and fully archived sites

Contributor guide

Research direction
Examine the implementation of the 'spo site list' command and the 'spo site archive' command to understand how the API is called. Add new values 'fullyArchived', 'recentlyArchived', and 'archived' to the ' type' option. Ensure the output format remains unchanged.
Tech stack
typescript
Domain
backendapi
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.
Clear
Prerequisites
TypeScriptGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65