Coder Social home page Coder Social logo

roslyn-analyzers's Introduction

.NET Compiler Platform ("Roslyn") Analyzers

Join the chat at https://gitter.im/roslyn-analyzers/Lobby

This repository contains a number of Roslyn diagnostic analyzers initially developed to help flesh out the design and implementation of the static analysis APIs. They have been migrated from the main dotnet/roslyn repository in order to continue and speed their further development.

Pre-release builds are available on MyGet gallery: https://dotnet.myget.org/Gallery/roslyn-analyzers.

Windows Debug Windows Release
master Build Status codecov Build Status

Projects

MetaCompilation

Created by summer 2015 interns Zoë Petard, Jessica Petty, and Daniel King

The MetaCompilation Analyzer is an analyzer that functions as a tutorial to teach users how to write an analyzer. It uses diagnostics and code fixes to guide the user through the various steps required to create a simple analyzer. It is designed for a novice analyzer programmer with some previous programming experience.

For instructions on using this tutorial, see Instructions.

Microsoft.CodeAnalysis.Analyzers

Latest stable version: NuGet

Provides guidelines for using .NET Compiler Platform ("Roslyn") APIs.

More info

Microsoft.CodeQuality.Analyzers

Latest stable version: NuGet

Provides common code quality guidelines.

More info

Microsoft.CodeQuality.Analyzers.Exp

Latest pre-release version: NuGet

Experimental package based on Dataflow Analysis to provide code quality guidelines in executable code.

More info

Microsoft.NetCore.Analyzers

Latest stable version: NuGet

Analyzers for APIs specific to .NET Core.

More info

Microsoft.NetFramework.Analyzers

Latest stable version: NuGet

Analyzers for APIs specific to the desktop .NET Framework.

More info

Roslyn.Diagnostics.Analyzers

Latest stable version: NuGet

Contains analyzers specific to the .NET Compiler Platform ("Roslyn") project.

More info

Text.Analyzers

Latest stable version: NuGet

Contains analyzers for text included in code, such as comments.

Getting Started

  1. Clone the repository
  2. Restore and build: build.cmd
  3. Execute tests: test.cmd

Submitting Pull Requests

Prior to submitting a pull request, ensure the build and all tests pass using using steps 2 and 3 above.

Versioning Scheme for Analyzer Packages

See VERSIONING.md for the versioning scheme for all analyzer packages built out of this repo.

Recommended version of Analyzer Packages

Recommended Visual Studio Version: Visual Studio 2017 15.5 Preview5, RTW or later

Recommended Analyzer Package Version: Version 2.6.1, for example https://www.nuget.org/packages/Microsoft.CodeAnalysis.FxCopAnalyzers/2.6.1

Due to the fact that large number of our analyzers were based on the not-yet-shipped IOperation APIs in Roslyn, they were in beta stage and tied to a specific compiler/Visual Studio version. IOperation API shipped in Visual Studio 2017 15.5 Preview5, and we have released fully supported version 2.6.0 analyzer packages that should work on all future compiler/Visual Studio versions. Please use the following guidelines when choosing the version of analyzer packages to use on a specific version of Visual Studio/compiler toolset:

  1. Visual Studio 2015 RTW: Analyzer package Version 1.0.1, for example https://www.nuget.org/packages/Microsoft.CodeAnalysis.FxCopAnalyzers/1.0.1
  2. Visual Studio 2015 Update 1: Analyzer package Version 1.1.0, for example https://www.nuget.org/packages/Microsoft.CodeAnalysis.FxCopAnalyzers/1.1.0
  3. Visual Studio 2015 Update 2 and 3: Analyzer package Version 1.2.0-beta2, for example https://www.nuget.org/packages/Microsoft.CodeAnalysis.FxCopAnalyzers/1.2.0-beta2
  4. Visual Studio 2017 RTW (15.0), 15.1 and 15.2: Analyzer package Version 2.0.0-beta2, for example https://www.nuget.org/packages/Microsoft.CodeAnalysis.FxCopAnalyzers/2.0.0-beta2
  5. Visual Studio 2017 15.3: Analyzer package Version 2.3.0-beta1, for example https://www.nuget.org/packages/Microsoft.CodeAnalysis.FxCopAnalyzers/2.3.0-beta1
  6. Visual Studio 2017 15.5 Preview5, RTW or later: Analyzer package Version 2.6.1, for example https://www.nuget.org/packages/Microsoft.CodeAnalysis.FxCopAnalyzers/2.6.1

On Visual Studio 2017 15.5 and later releases, you can also install a custom Microsoft Code Analysis VSIX containing these analyzers as a Visual Studio extension for all your managed projects. See details here: https://marketplace.visualstudio.com/items?itemName=VisualStudioPlatformTeam.MicrosoftCodeAnalysis2017

roslyn-analyzers's People

Contributors

333fred avatar balajikris avatar basoundr avatar bkoelman avatar chborl avatar cyrusnajmabadi avatar daking2014 avatar danielkim-msft avatar duracellko avatar dustincampbell avatar genlu avatar heejaechang avatar ivanbasov avatar jamesqo avatar jepetty avatar jinujoseph avatar joshvarty avatar maggiemsft avatar mavasani avatar morrisjoe avatar msjohnhamby avatar natidea avatar nguerrera avatar pakdev avatar qinxgit avatar sharwell avatar srivatsn avatar tmat avatar tmeschter avatar v-zbsail avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.