Expand Minimize

SPF019814: Specify valid component type in the manifest

The manifest must specify a valid component type

CheckId SPF019814
TypeName SpecifyValidManifestComponentType
Severity CriticalError
Type Project

Each manifest must specify the type of component using the componentType property. At the moment WebPart is the only supported value.

MyWebPart.manifest.json example

{
  "$schema": "../../../node_modules/@microsoft/sp-module-interfaces/lib/manifestSchemas/jsonSchemas/clientSideComponentManifestSchema.json",

  "id": "de33e780-5ae0-4d1e-abbc-5ef3468debb1",
  "alias": "WeatherWebPart",
  "componentType": "WebPart",
  "version": "0.0.1",
  "manifestVersion": 2,

  "preconfiguredEntries": [{
    "groupId": "de33e780-5ae0-4d1e-abbc-5ef3468debb1",
    "group": { "default": "Under Development" },
    "title": { "default": "Weather" },
    "description": { "default": "Shows weather for the given place" },
    "officeFabricIconFontName": "Sunny",
    "properties": {
      "location": ""
    }
  }]
}

To suppress this violation in XML SharePoint code add the following comment right before the XML tag which causes the rule violation. Learn more about SuppressMessage here.

<!-- "SuppressMessage":{"rule":"SPF019814:SpecifyValidManifestComponentType","justification":"Provide reason for suppression here"} -->
Disclaimer: The views and opinions expressed in this documentation and in SPCAF do not necessarily reflect the opinions and recommendations of Microsoft or any member of Microsoft. SPCAF and RENCORE are registered trademarks of Rencore. All other trademarks, service marks, collective marks, copyrights, registered names, and marks used or cited by this documentation are the property of their respective owners.