file : package-solution.json
The package-solution.json file is a configuration file used in SharePoint Framework (SPFx) projects to define metadata and settings related to packaging and deploying a solution to the SharePoint App Catalog. Let's break down the key components of this file:
$schema: This property specifies the URL of the JSON schema that defines the structure and properties allowed in this configuration file. In this case, it points to the schema for SPFx package solution.
solution: This section contains metadata and settings related to the SPFx solution being packaged:
name: Specifies the name of the solution.
id: Specifies a unique identifier (GUID) for the solution.
version: Specifies the version number of the solution.
includeClientSideAssets: Indicates whether client-side assets (such as JavaScript bundles and CSS files) should be included in the package. Set to true to include these assets.
skipFeatureDeployment: Specifies whether feature deployment should be skipped during solution installation. Set to true to skip feature deployment.
isDomainIsolated: Specifies whether the solution is domain isolated. Domain isolation allows you to isolate the solution from other SharePoint components.
developer: Contains information about the developer of the solution, such as name, website URL, privacy URL, terms of use URL, and MPN ID.
metadata: Contains additional metadata about the solution, such as short and long descriptions, screenshots, video URL, and categories.
features: Specifies features included in the solution. Features are elements that can be activated or deactivated in SharePoint sites.
paths: This section defines paths related to the packaged solution:
zippedPackage: Specifies the path to the packaged solution file ( .sppkg). This is the file that contains the compiled assets, manifests, and metadata for the solution.
Overall, the package-solution.json file provides a structured way to define metadata and settings for packaging and deploying an SPFx solution to the SharePoint App Catalog. It helps manage the configuration and deployment process effectively.