pnp/cli-microsoft365

New command: enable SPFx package for deployment in Teams

Open

#2,369 opened on Apr 17, 2021

View on GitHub
 (15 comments) (1 reaction) (0 assignees)TypeScript (399 forks)auto 404
help wantednew feature

Repository metrics

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

Description

Usage

spfx package teams enable

Description

Checks if the SPFx package is enabled for deployment in Teams. Optionally, changes the package to enable it for deployment in Teams

Options

Option Description
-f, --filePath <filePath> Absolute or relative path to the .sppkg file to analyze
--fix Specify, to update all web parts in the package to be exposed in Teams

Additional Information

The idea of this command is to help admins analyze if the particular SPFx package can be deployed in Teams and enable it if needed without having to manually change the package.

The command has the following steps:

  • unzips the specified .sppkg file
  • discovers all web parts
  • for each web part checks its manifest and verifies if Teams is listed in supported hosts
  • the command prints in console all discovered web parts and whether they're enabled for deployment in Teams or not
  • when you use the --fix option, the command will unzip the .sppkg file, update all web part manifests so that all web parts are enabled in Teams, increase the package minor version number and create a new zip

This command could also be used in a script that downloads all .sppkg files from the app catalog, analyzes them and provides report or downloads all .sppkg files from the app catalog and updates all .sppkg files to be deployable in Teams.

Contributor guide

Research direction
Study the existing command structure in the CLI for Microsoft 365 repository, focusing on commands that handle file operations. Understand the .sppkg file format (it's a ZIP archive containing web part manifests). Then implement the new command by unzipping, parsing manifests, checking/enabling Teams support, and optionally updating the package.
Tech stack
typescript
Domain
cli
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
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
TypeScriptNode.jsSharePoint Framework
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65