pnp / pnp/cli-microsoft365

New command: enable SPFx package for deployment in Teams

Open
#2,369 15 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

help wanted new feature
Dominant language
TypeScript
Stars
1.5k
Forks
413
Avg merge
5d 6h
Merged PRs (30d)
21

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

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start from the spfx package teams enable command usage and trace how .sppkg files are currently handled. Implement discovery of web-part manifests, reporting of Teams support, and the --fix flow that updates manifests, increments the minor package version, and creates a new zip. Verify both analysis and fixed-package behavior with representative .sppkg files.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
cli
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.