officedev/sharepoint-code-analysis-framework-rules

topic	products	languages	extensions
sample	office-sp office-365	html	contentType createdDate tools 10/1/2014 2:08:12 PM

Rules for the SharePoint Code Analysis Framework (SPCAF)

Summary

This project contains custom community rules that can be used with the SharePoint Code Analysis Framework (SPCAF).

The rules are supported by the

• SPCAF Code Migration Assessment (Free) and the
• SPCAF Professional Edition (Commercial)

The purpose of this project is to align the coding practices checked by SPCAF with the guidance defined by Microsoft e.g. in the Office Patterns and Practices project in order to support developers with the transformation of their legacy full trust farm solutions (.wsp) to the SharePoint App model.

How do I get started?

1. Download and install the free SPCAF Code Migration Assessment tool or SPCAF Professional Edition
2. Clone this GitHub repositiory and open the Visual Studio solution inside the SPCAF.Rules folder
3. Create/Change a rule
4. Build and replace the SPCAF.Rules.MigrationAssessment.dll in the SPCAF installation folder
5. Run SPCAF test your rule on a WSP file (in SPCAF Professional you have to select the Migration Assessment ruleset in the advanced view before the analysis)

What is SPCAF?

The SharePoint Code Analysis Framework (SPCAF) analyzes the code SharePoint solutions (.wsp) for SharePoint 2007 / 2010 / 2013 SharePoint 2013/Online apps

SPCAF includes five different analysis components for

• Code Quality Analysis,
• Metrics,
• Dependency Analysis,
• Inventory and
• Code Migration Assessment.

SPCAF runs integrated in Visual Studio 2010, 2012, 2013 and 2015 or in the standalone client application that can analyze without having the source code. Further, with SPCAF Server you can integrate the code analysis into your continuous integration process in Team Foundation Server, Visual Studio Online, TeamCity or any other automated build system.

Links

Download (Visual Studio Gallery)

• SPCAF Code Migration Assessment (Free)
• SPCAF Community Edition (Free)
• SPCAF Professional Edition (Commercial)

Documentation

• Online Documentation
• Run SPCAF in VS
• Rule Development (SDK)
• Sample Rule

Other

• Office Patterns and Practices
• Office Developer Center

This project has adopted the Microsoft Open Source Code of Conduct. For more information, see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.