Expand Minimize



The quality rules for SharePoint Apps are used to identify possible problems or coding errors in assemblies, XML files, ASPX files, JavaScript, CSS files etc. The rules check the artifacts and return violations as CriticalError, Error, CriticalWarning or Warning.

Rule Configuration

By default all recommended rules are checked. To disable rules or rule categories or to change the severity of a rule the SPCAF Settings Editor can be used.

Rule Severities

Each rule has a severity by default to classify the impact of a violation against the rule.

Severity Description
Error Issues reported at Error level should not impact the solution deployment process or the stability of the SharePoint farm. But deployed solutions may not work as expected. Future upgrades of the solution maybe impossible or may most likely fail. WSPs or Apps with errors should only be deployed to SharePoint very carefully after the detected issues have been reviewed.
CriticalWarning Issues reported at CriticalWarning level reflect issues that generally have little or no adverse effect on code behavior; they are primarily concerned with code maintainability, and correcting less-than-optimal choices for visible elements. However, for a minority of cases, these messages are considered errors. Therefore, they should be reviewed closely before they are excluded.
Warning Issues reported at Warning level are generally concerned with doing things correctly to keep your code base stable, extensible, and maintainable.

Category Index

Category Description
Correctness Correctness rules check the SharePoint XML code for syntax errors. This includes check for all required XML attributes, correct values and data types of attributes.
Best Practice Rules to warn if best practices are not used.
Deployment The deployment process of SharePoint customizations is often a critical part. Deploying the wrong way or the wrong files can harm the SharePoint farm or make the farm inaccessible. Deployment rules check the code for these risks or potential problems.
Localization Localization is the process of customizing an application, webpage, or website for a given culture or locale. The localization rules check if all attributes in XML which support localization are localized in a proper way.
AppStore Compatibility Rules to check for compliance with the AppStore requirements.
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 AB. 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.