├── ServiceResult
    ├── ResultType.cs
    ├── Result.cs
    ├── SuccessResult.cs
    ├── ServiceResult.csproj
    ├── InvalidResult.cs
    ├── NotFoundResult.cs
    └── UnexpectedResult.cs
├── ServiceResult.ApiExtensions
    ├── ServiceResult.ApiExtensions.csproj
    └── ResultExtensions.cs
├── LICENSE
├── README.md
├── ServiceResult.sln
├── ServiceResult.NuGet
    └── ServiceResult.NuGet.nuproj
├── ServiceResult.ApiExtensions.NuGet
    └── ServiceResult.ApiExtensions.NuGet.nuproj
└── .gitignore


/ServiceResult/ResultType.cs:
--------------------------------------------------------------------------------
 1 | namespace ServiceResult
 2 | {
 3 |     public enum ResultType
 4 |     {
 5 |         Ok,
 6 |         Unexpected,
 7 |         NotFound,
 8 |         Unauthorized,
 9 |         Invalid
10 |     }
11 | }
12 | 


--------------------------------------------------------------------------------
/ServiceResult/Result.cs:
--------------------------------------------------------------------------------
 1 | using System;
 2 | using System.Collections.Generic;
 3 | 
 4 | namespace ServiceResult
 5 | {
 6 |     /// <summary>
 7 |     /// Result model to contain data, result type, and errors
 8 |     /// </summary>
 9 |     public abstract class Result<T>
10 |     {
11 |         public abstract ResultType ResultType { get; }
12 |         public abstract List<string> Errors { get; }
13 |         public abstract T Data { get; }
14 |     }
15 | }
16 | 


--------------------------------------------------------------------------------
/ServiceResult.ApiExtensions/ServiceResult.ApiExtensions.csproj:
--------------------------------------------------------------------------------
 1 | <Project Sdk="Microsoft.NET.Sdk">
 2 | 
 3 |   <PropertyGroup>
 4 |     <TargetFramework>netstandard2.0</TargetFramework>
 5 |   </PropertyGroup>
 6 | 
 7 |   <ItemGroup>
 8 |     <PackageReference Include="ServiceResult" Version="1.0.1" />
 9 |     <PackageReference Include="Microsoft.AspNetCore.Mvc.Core" Version="2.0.0" />
10 |     <PackageReference Include="NuGet.Build.Packaging" Version="0.2.0" />
11 |   </ItemGroup>
12 | 
13 | </Project>
14 | 


--------------------------------------------------------------------------------
/ServiceResult/SuccessResult.cs:
--------------------------------------------------------------------------------
 1 | using System;
 2 | using System.Collections.Generic;
 3 | 
 4 | namespace ServiceResult
 5 | {
 6 |     /// <summary>
 7 |     /// Success result.
 8 |     /// </summary>
 9 |     public class SuccessResult<T> : Result<T>
10 |     {
11 |         private readonly T _data;
12 |         public SuccessResult(T data)
13 |         {
14 |             _data = data;
15 |         }
16 |         public override ResultType ResultType => ResultType.Ok;
17 | 
18 |         public override List<string> Errors => new List<string>();
19 | 
20 |         public override T Data => _data;
21 |     }
22 | }
23 | 


--------------------------------------------------------------------------------
/ServiceResult/ServiceResult.csproj:
--------------------------------------------------------------------------------
 1 | <Project Sdk="Microsoft.NET.Sdk">
 2 | 
 3 |   <PropertyGroup>
 4 |     <TargetFramework>netstandard1.6</TargetFramework>
 5 |   </PropertyGroup>
 6 | 
 7 |   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
 8 |     <NoStdLib>false</NoStdLib>
 9 |   </PropertyGroup>
10 |   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
11 |     <NoStdLib>false</NoStdLib>
12 |     <DebugType></DebugType>
13 |   </PropertyGroup>
14 |   <ItemGroup>
15 |     <PackageReference Include="NuGet.Build.Packaging" Version="0.2.0" />
16 |   </ItemGroup>
17 | </Project>
18 | 


--------------------------------------------------------------------------------
/ServiceResult/InvalidResult.cs:
--------------------------------------------------------------------------------
 1 | using System;
 2 | using System.Collections.Generic;
 3 | 
 4 | namespace ServiceResult
 5 | {
 6 |     /// <summary>
 7 |     /// Invalid result.
 8 |     /// </summary>
 9 |     public class InvalidResult<T> : Result<T>
10 |     {
11 |         private string _error;
12 |         public InvalidResult(string error)
13 |         {
14 |             _error = error;
15 |         }
16 |         public override ResultType ResultType => ResultType.Invalid;
17 | 
18 |         public override List<string> Errors => new List<string> { _error ?? "The input was invalid." };
19 | 
20 |         public override T Data => default(T);
21 |     }
22 | }
23 | 


--------------------------------------------------------------------------------
/ServiceResult/NotFoundResult.cs:
--------------------------------------------------------------------------------
 1 | using System;
 2 | using System.Collections.Generic;
 3 | 
 4 | namespace ServiceResult
 5 | {
 6 |     /// <summary>
 7 |     /// Not found result.
 8 |     /// </summary>
 9 |     public class NotFoundResult<T> : Result<T>
10 |     {
11 |         private readonly string _error;
12 |         public NotFoundResult(string error)
13 |         {
14 |             _error = error;
15 |         }
16 |         public override ResultType ResultType => ResultType.NotFound;
17 | 
18 |         public override List<string> Errors => new List<string> { _error ?? "The entity you're looking for cannot be found" };
19 | 
20 |         public override T Data => default(T);
21 |     }
22 | }
23 | 


--------------------------------------------------------------------------------
/ServiceResult/UnexpectedResult.cs:
--------------------------------------------------------------------------------
 1 | using System;
 2 | using System.Collections.Generic;
 3 | 
 4 | namespace ServiceResult
 5 | {
 6 |     /// <summary>
 7 |     /// Unexpected result.
 8 |     /// </summary>
 9 |     public class UnexpectedResult<T> : Result<T>
10 |     {
11 | 
12 |         private readonly string _error;
13 |         public UnexpectedResult(string error)
14 |         {
15 |             _error = error;
16 |         }
17 |         public UnexpectedResult()
18 |         {
19 | 
20 |         }
21 |         public override ResultType ResultType => ResultType.Unexpected;
22 | 
23 |         public override List<string> Errors => new List<string> { _error ?? "There was an unexpected problem" };
24 | 
25 |         public override T Data => default(T);
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2018 Alex Dunn
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/ServiceResult.ApiExtensions/ResultExtensions.cs:
--------------------------------------------------------------------------------
 1 | using System;
 2 | using Microsoft.AspNetCore.Mvc;
 3 | 
 4 | namespace ServiceResult.ApiExtensions
 5 | {
 6 |     /// <summary>
 7 |     /// Result extensions for APIs.
 8 |     /// </summary>
 9 |     public static class ResultExtensions
10 |     {
11 |         /// <summary>
12 |         /// Creates an ActionResult from a service Result
13 |         /// </summary>
14 |         /// <returns>The action result.</returns>
15 |         /// <param name="result">Service Result.</param>
16 |         /// <typeparam name="T">The data type of the Result.</typeparam>
17 |         public static ActionResult FromResult<T>(this ControllerBase controller, Result<T> result)
18 |         {
19 |             switch (result.ResultType)
20 |             {
21 |                 case ResultType.Ok:
22 |                     if (result.Data == null)
23 |                         return controller.NoContent();
24 |                     else
25 |                         return controller.Ok(result.Data);
26 |                 case ResultType.NotFound:
27 |                     return controller.NotFound(result.Errors);
28 |                 case ResultType.Invalid:
29 |                     return controller.BadRequest(result.Errors);
30 |                 case ResultType.Unexpected:
31 |                     return controller.BadRequest(result.Errors);
32 |                 case ResultType.Unauthorized:
33 |                     return controller.Unauthorized();
34 |                 default:
35 |                     throw new Exception("An unhandled result has occurred as a result of a service call.");
36 |             }
37 |         }
38 |     }
39 | }
40 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # ServiceResult
 2 | A set of models used to follow the service result pattern in C#. Allows for wrapping response data and/or errors in a single model. Use this to avoid bubbling exceptions to the client - great for Client side .NET development, and API development.
 3 | 
 4 | ## Installation
 5 | 
 6 | It's on NuGet!
 7 | 
 8 | ```
 9 | Install-Package ServiceResult
10 | ```
11 | Or using the cli
12 | ```
13 | dotnet add package ServiceResult
14 | ```
15 | 
16 | ## Usage
17 | 
18 | Use the different result models to create a verbose response:
19 | 
20 | ``` csharp
21 | // successful result
22 | var myData = _someService.DoSomeStuff();
23 | return new SuccessResult<MyData>(myData);
24 | ...
25 | 
26 | // error wrapped
27 | try
28 | {
29 |     var myData = _someService.DoSomeStuff();
30 |     if(myData == null)
31 |     {
32 |         return new NotFoundResult<MyData>("Can't find your data!");
33 |     }
34 |     
35 |     return new SuccessResult<MyData>(myData);
36 | }
37 | catch(Exception ex)
38 | {
39 |     // do something with the error first like logging
40 |     return new UnexpectedResult<MyData>(ex.Message);
41 | }
42 | ```
43 | 
44 | Want to use this in your API and return the proper HTTP responses?
45 | We created a NuGet package for that too!
46 | ```
47 | Install-Package ServiceResult.ApiExtensions
48 | ```
49 | Or using the cli
50 | ```
51 | dotnet add package ServiceResult.ApiExtensions
52 | ```
53 | 
54 | Then use the extension method in your `Controller`:
55 | 
56 | ``` csharp
57 | using ServiceResult.ApiExtensions;
58 | 
59 | public class MyController : Controller
60 | {
61 |     private readonly IMyService _service;
62 |     public MyController(IMyService service)
63 |     {
64 |         _service = service;
65 |     }
66 |     
67 |     [HttpGet]
68 |     public async Task<IActionResult> Get()
69 |     {
70 |         // returns a Result<T>
71 |         var result = await _service.GetSomeData();
72 |         return this.FromResult(result); // using extension
73 |     }
74 | }
75 | ```
76 | 
77 | ## Contributing
78 | 
79 | Want a type of `Result<T>` that isn't here already? Create on yourself and contribute it back to the repository!
80 | 
81 | ## Contributors
82 | 
83 | - Alex Dunn (https://github.com/SuavePirate)
84 | - Patrick Dunn (https://github.com/patwritescode)
85 | 


--------------------------------------------------------------------------------
/ServiceResult.sln:
--------------------------------------------------------------------------------
 1 | 
 2 | Microsoft Visual Studio Solution File, Format Version 12.00
 3 | # Visual Studio 2012
 4 | Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ServiceResult", "ServiceResult\ServiceResult.csproj", "{67D362AE-8BFB-495E-9BA2-801FAFC7AE1B}"
 5 | EndProject
 6 | Project("{5DD5E4FA-CB73-4610-85AB-557B54E96AA9}") = "ServiceResult.NuGet", "ServiceResult.NuGet\ServiceResult.NuGet.nuproj", "{1982C97A-D38F-4C97-A3EF-922DD1257F04}"
 7 | EndProject
 8 | Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ServiceResult.ApiExtensions", "ServiceResult.ApiExtensions\ServiceResult.ApiExtensions.csproj", "{3F2920B9-A5EF-4CBD-A0BB-D2327DC94AE8}"
 9 | EndProject
10 | Project("{5DD5E4FA-CB73-4610-85AB-557B54E96AA9}") = "ServiceResult.ApiExtensions.NuGet", "ServiceResult.ApiExtensions.NuGet\ServiceResult.ApiExtensions.NuGet.nuproj", "{5EACDADD-1D3C-436B-BCC8-0DEA4994C30E}"
11 | EndProject
12 | Global
13 | 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
14 | 		Debug|Any CPU = Debug|Any CPU
15 | 		Release|Any CPU = Release|Any CPU
16 | 	EndGlobalSection
17 | 	GlobalSection(ProjectConfigurationPlatforms) = postSolution
18 | 		{67D362AE-8BFB-495E-9BA2-801FAFC7AE1B}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
19 | 		{67D362AE-8BFB-495E-9BA2-801FAFC7AE1B}.Debug|Any CPU.Build.0 = Debug|Any CPU
20 | 		{67D362AE-8BFB-495E-9BA2-801FAFC7AE1B}.Release|Any CPU.ActiveCfg = Release|Any CPU
21 | 		{67D362AE-8BFB-495E-9BA2-801FAFC7AE1B}.Release|Any CPU.Build.0 = Release|Any CPU
22 | 		{1982C97A-D38F-4C97-A3EF-922DD1257F04}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
23 | 		{1982C97A-D38F-4C97-A3EF-922DD1257F04}.Debug|Any CPU.Build.0 = Debug|Any CPU
24 | 		{1982C97A-D38F-4C97-A3EF-922DD1257F04}.Release|Any CPU.ActiveCfg = Release|Any CPU
25 | 		{1982C97A-D38F-4C97-A3EF-922DD1257F04}.Release|Any CPU.Build.0 = Release|Any CPU
26 | 		{3F2920B9-A5EF-4CBD-A0BB-D2327DC94AE8}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
27 | 		{3F2920B9-A5EF-4CBD-A0BB-D2327DC94AE8}.Debug|Any CPU.Build.0 = Debug|Any CPU
28 | 		{3F2920B9-A5EF-4CBD-A0BB-D2327DC94AE8}.Release|Any CPU.ActiveCfg = Release|Any CPU
29 | 		{3F2920B9-A5EF-4CBD-A0BB-D2327DC94AE8}.Release|Any CPU.Build.0 = Release|Any CPU
30 | 		{5EACDADD-1D3C-436B-BCC8-0DEA4994C30E}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
31 | 		{5EACDADD-1D3C-436B-BCC8-0DEA4994C30E}.Debug|Any CPU.Build.0 = Debug|Any CPU
32 | 		{5EACDADD-1D3C-436B-BCC8-0DEA4994C30E}.Release|Any CPU.ActiveCfg = Release|Any CPU
33 | 		{5EACDADD-1D3C-436B-BCC8-0DEA4994C30E}.Release|Any CPU.Build.0 = Release|Any CPU
34 | 	EndGlobalSection
35 | EndGlobal
36 | 


--------------------------------------------------------------------------------
/ServiceResult.NuGet/ServiceResult.NuGet.nuproj:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="utf-8"?>
 2 | <Project DefaultTargets="Build" ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
 3 |   <Import Project="$(NuGetAuthoringPath)\NuGet.Packaging.Authoring.props" Condition="Exists('$(NuGetAuthoringPath)\NuGet.Packaging.Authoring.props')" />
 4 |   <PropertyGroup>
 5 |     <Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>
 6 |     <Platform Condition=" '$(Platform)' == '' ">AnyCPU</Platform>
 7 |     <ProjectGuid>{1982C97A-D38F-4C97-A3EF-922DD1257F04}</ProjectGuid>
 8 |     <Description>Result models for the service result pattern. Allows for wrapping data and errors in a reusable way.</Description>
 9 |     <PackageId>ServiceResult</PackageId>
10 |     <PackageVersion>1.0.1</PackageVersion>
11 |     <Authors>SuavePirate</Authors>
12 |     <DevelopmentDependency>false</DevelopmentDependency>
13 |     <PackageRequireLicenseAcceptance>false</PackageRequireLicenseAcceptance>
14 |     <OutputType>Exe</OutputType>
15 |     <RootNamespace>ServiceResult.NuGet</RootNamespace>
16 |     <UsePartialTypes>false</UsePartialTypes>
17 |     <AssemblyName>ServiceResult.NuGet</AssemblyName>
18 |     <TargetFrameworkVersion>v4.5</TargetFrameworkVersion>
19 |     <Owners>SuavePirate</Owners>
20 |     <PackageTags>.NET C# Result</PackageTags>
21 |     <Title>ServiceResult</Title>
22 |     <PackageReleaseNotes>Initial release</PackageReleaseNotes>
23 |     <Summary>Result models for the service result pattern. Allows for wrapping data and errors in a reusable way.</Summary>
24 |     <PackageProjectUrl>https://github.com/SuavePirate/ServiceResult</PackageProjectUrl>
25 |     <PackageLicenseUrl>https://github.com/SuavePirate/ServiceResult/blob/master/LICENSE</PackageLicenseUrl>
26 |   </PropertyGroup>
27 |   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
28 |     <DebugSymbols>true</DebugSymbols>
29 |     <DebugType>full</DebugType>
30 |     <OutputPath>bin\Debug</OutputPath>
31 |     <ErrorReport>prompt</ErrorReport>
32 |   </PropertyGroup>
33 |   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
34 |     <OutputPath>bin\Release</OutputPath>
35 |     <ErrorReport>prompt</ErrorReport>
36 |   </PropertyGroup>
37 |   <ItemGroup>
38 |     <PackageReference Include="NuGet.Build.Packaging">
39 |       <Version>0.2.2</Version>
40 |       <PrivateAssets>All</PrivateAssets>
41 |     </PackageReference>
42 |   </ItemGroup>
43 |   <ItemGroup>
44 |     <ProjectReference Include="..\ServiceResult\ServiceResult.csproj">
45 |       <Project>{67D362AE-8BFB-495E-9BA2-801FAFC7AE1B}</Project>
46 |       <Name>ServiceResult</Name>
47 |     </ProjectReference>
48 |   </ItemGroup>
49 |   <Import Project="$(MSBuildBinPath)\Microsoft.Common.targets" />
50 |   <Import Project="$(NuGetAuthoringPath)\NuGet.Packaging.Authoring.targets" Condition="Exists('$(NuGetAuthoringPath)\NuGet.Packaging.Authoring.targets')" />
51 | </Project>


--------------------------------------------------------------------------------
/ServiceResult.ApiExtensions.NuGet/ServiceResult.ApiExtensions.NuGet.nuproj:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="utf-8"?>
 2 | <Project DefaultTargets="Build" ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
 3 |   <Import Project="$(NuGetAuthoringPath)\NuGet.Packaging.Authoring.props" Condition="Exists('$(NuGetAuthoringPath)\NuGet.Packaging.Authoring.props')" />
 4 |   <PropertyGroup>
 5 |     <Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>
 6 |     <Platform Condition=" '$(Platform)' == '' ">AnyCPU</Platform>
 7 |     <ProjectGuid>{5EACDADD-1D3C-436B-BCC8-0DEA4994C30E}</ProjectGuid>
 8 |     <Description>ServiceResult API Extensions to create action results from service results</Description>
 9 |     <PackageId>ServiceResult.ApiExtensions</PackageId>
10 |     <PackageVersion>1.1.1</PackageVersion>
11 |     <Authors>SauvePirate</Authors>
12 |     <DevelopmentDependency>false</DevelopmentDependency>
13 |     <PackageRequireLicenseAcceptance>false</PackageRequireLicenseAcceptance>
14 |     <OutputType>Exe</OutputType>
15 |     <RootNamespace>ServiceResult.ApiExtensions.NuGet</RootNamespace>
16 |     <UsePartialTypes>false</UsePartialTypes>
17 |     <AssemblyName>ServiceResult.ApiExtensions.NuGet</AssemblyName>
18 |     <TargetFrameworkVersion>v4.5</TargetFrameworkVersion>
19 |     <Owners>SuavePirate</Owners>
20 |     <PackageTags>ServiceResult API WebAPI</PackageTags>
21 |     <Title>ServiceResult API Extensions</Title>
22 |     <PackageReleaseNotes>Initial release</PackageReleaseNotes>
23 |     <Summary>ServiceResult API Extensions to create action results from service results</Summary>
24 |     <PackageProjectUrl>https://github.com/SuavePirate/ServiceResult</PackageProjectUrl>
25 |     <PackageLicenseUrl>https://github.com/SuavePirate/ServiceResult/blob/master/LICENSE</PackageLicenseUrl>
26 |   </PropertyGroup>
27 |   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
28 |     <DebugSymbols>true</DebugSymbols>
29 |     <DebugType>full</DebugType>
30 |     <OutputPath>bin\Debug</OutputPath>
31 |     <ErrorReport>prompt</ErrorReport>
32 |   </PropertyGroup>
33 |   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
34 |     <OutputPath>bin\Release</OutputPath>
35 |     <ErrorReport>prompt</ErrorReport>
36 |   </PropertyGroup>
37 |   <ItemGroup>
38 |     <PackageReference Include="NuGet.Build.Packaging">
39 |       <Version>0.2.0</Version>
40 |       <PrivateAssets>All</PrivateAssets>
41 |     </PackageReference>
42 |   </ItemGroup>
43 |   <ItemGroup>
44 |     <ProjectReference Include="..\ServiceResult.ApiExtensions\ServiceResult.ApiExtensions.csproj">
45 |       <Project>{3F2920B9-A5EF-4CBD-A0BB-D2327DC94AE8}</Project>
46 |       <Name>ServiceResult.ApiExtensions</Name>
47 |     </ProjectReference>
48 |   </ItemGroup>
49 |   <Import Project="$(MSBuildBinPath)\Microsoft.Common.targets" />
50 |   <Import Project="$(NuGetAuthoringPath)\NuGet.Packaging.Authoring.targets" Condition="Exists('$(NuGetAuthoringPath)\NuGet.Packaging.Authoring.targets')" />
51 | </Project>


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
  1 | ## Ignore Visual Studio temporary files, build results, and
  2 | ## files generated by popular Visual Studio add-ons.
  3 | ##
  4 | ## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore
  5 | 
  6 | # User-specific files
  7 | *.suo
  8 | *.user
  9 | *.userosscache
 10 | *.sln.docstates
 11 | 
 12 | # User-specific files (MonoDevelop/Xamarin Studio)
 13 | *.userprefs
 14 | 
 15 | # Build results
 16 | [Dd]ebug/
 17 | [Dd]ebugPublic/
 18 | [Rr]elease/
 19 | [Rr]eleases/
 20 | x64/
 21 | x86/
 22 | bld/
 23 | [Bb]in/
 24 | [Oo]bj/
 25 | [Ll]og/
 26 | 
 27 | # Visual Studio 2015 cache/options directory
 28 | .vs/
 29 | # Uncomment if you have tasks that create the project's static files in wwwroot
 30 | #wwwroot/
 31 | 
 32 | # MSTest test Results
 33 | [Tt]est[Rr]esult*/
 34 | [Bb]uild[Ll]og.*
 35 | 
 36 | # NUNIT
 37 | *.VisualState.xml
 38 | TestResult.xml
 39 | 
 40 | # Build Results of an ATL Project
 41 | [Dd]ebugPS/
 42 | [Rr]eleasePS/
 43 | dlldata.c
 44 | 
 45 | # .NET Core
 46 | project.lock.json
 47 | project.fragment.lock.json
 48 | artifacts/
 49 | **/Properties/launchSettings.json
 50 | 
 51 | *_i.c
 52 | *_p.c
 53 | *_i.h
 54 | *.ilk
 55 | *.meta
 56 | *.obj
 57 | *.pch
 58 | *.pdb
 59 | *.pgc
 60 | *.pgd
 61 | *.rsp
 62 | *.sbr
 63 | *.tlb
 64 | *.tli
 65 | *.tlh
 66 | *.tmp
 67 | *.tmp_proj
 68 | *.log
 69 | *.vspscc
 70 | *.vssscc
 71 | .builds
 72 | *.pidb
 73 | *.svclog
 74 | *.scc
 75 | 
 76 | # Chutzpah Test files
 77 | _Chutzpah*
 78 | 
 79 | # Visual C++ cache files
 80 | ipch/
 81 | *.aps
 82 | *.ncb
 83 | *.opendb
 84 | *.opensdf
 85 | *.sdf
 86 | *.cachefile
 87 | *.VC.db
 88 | *.VC.VC.opendb
 89 | 
 90 | # Visual Studio profiler
 91 | *.psess
 92 | *.vsp
 93 | *.vspx
 94 | *.sap
 95 | 
 96 | # TFS 2012 Local Workspace
 97 | $tf/
 98 | 
 99 | # Guidance Automation Toolkit
100 | *.gpState
101 | 
102 | # ReSharper is a .NET coding add-in
103 | _ReSharper*/
104 | *.[Rr]e[Ss]harper
105 | *.DotSettings.user
106 | 
107 | # JustCode is a .NET coding add-in
108 | .JustCode
109 | 
110 | # TeamCity is a build add-in
111 | _TeamCity*
112 | 
113 | # DotCover is a Code Coverage Tool
114 | *.dotCover
115 | 
116 | # Visual Studio code coverage results
117 | *.coverage
118 | *.coveragexml
119 | 
120 | # NCrunch
121 | _NCrunch_*
122 | .*crunch*.local.xml
123 | nCrunchTemp_*
124 | 
125 | # MightyMoose
126 | *.mm.*
127 | AutoTest.Net/
128 | 
129 | # Web workbench (sass)
130 | .sass-cache/
131 | 
132 | # Installshield output folder
133 | [Ee]xpress/
134 | 
135 | # DocProject is a documentation generator add-in
136 | DocProject/buildhelp/
137 | DocProject/Help/*.HxT
138 | DocProject/Help/*.HxC
139 | DocProject/Help/*.hhc
140 | DocProject/Help/*.hhk
141 | DocProject/Help/*.hhp
142 | DocProject/Help/Html2
143 | DocProject/Help/html
144 | 
145 | # Click-Once directory
146 | publish/
147 | 
148 | # Publish Web Output
149 | *.[Pp]ublish.xml
150 | *.azurePubxml
151 | # TODO: Comment the next line if you want to checkin your web deploy settings
152 | # but database connection strings (with potential passwords) will be unencrypted
153 | *.pubxml
154 | *.publishproj
155 | 
156 | # Microsoft Azure Web App publish settings. Comment the next line if you want to
157 | # checkin your Azure Web App publish settings, but sensitive information contained
158 | # in these scripts will be unencrypted
159 | PublishScripts/
160 | 
161 | # NuGet Packages
162 | *.nupkg
163 | # The packages folder can be ignored because of Package Restore
164 | **/packages/*
165 | # except build/, which is used as an MSBuild target.
166 | !**/packages/build/
167 | # Uncomment if necessary however generally it will be regenerated when needed
168 | #!**/packages/repositories.config
169 | # NuGet v3's project.json files produces more ignorable files
170 | *.nuget.props
171 | *.nuget.targets
172 | 
173 | # Microsoft Azure Build Output
174 | csx/
175 | *.build.csdef
176 | 
177 | # Microsoft Azure Emulator
178 | ecf/
179 | rcf/
180 | 
181 | # Windows Store app package directories and files
182 | AppPackages/
183 | BundleArtifacts/
184 | Package.StoreAssociation.xml
185 | _pkginfo.txt
186 | 
187 | # Visual Studio cache files
188 | # files ending in .cache can be ignored
189 | *.[Cc]ache
190 | # but keep track of directories ending in .cache
191 | !*.[Cc]ache/
192 | 
193 | # Others
194 | ClientBin/
195 | ~$*
196 | *~
197 | *.dbmdl
198 | *.dbproj.schemaview
199 | *.jfm
200 | *.pfx
201 | *.publishsettings
202 | orleans.codegen.cs
203 | 
204 | # Since there are multiple workflows, uncomment next line to ignore bower_components
205 | # (https://github.com/github/gitignore/pull/1529#issuecomment-104372622)
206 | #bower_components/
207 | 
208 | # RIA/Silverlight projects
209 | Generated_Code/
210 | 
211 | # Backup & report files from converting an old project file
212 | # to a newer Visual Studio version. Backup files are not needed,
213 | # because we have git ;-)
214 | _UpgradeReport_Files/
215 | Backup*/
216 | UpgradeLog*.XML
217 | UpgradeLog*.htm
218 | 
219 | # SQL Server files
220 | *.mdf
221 | *.ldf
222 | *.ndf
223 | 
224 | # Business Intelligence projects
225 | *.rdl.data
226 | *.bim.layout
227 | *.bim_*.settings
228 | 
229 | # Microsoft Fakes
230 | FakesAssemblies/
231 | 
232 | # GhostDoc plugin setting file
233 | *.GhostDoc.xml
234 | 
235 | # Node.js Tools for Visual Studio
236 | .ntvs_analysis.dat
237 | node_modules/
238 | 
239 | # Typescript v1 declaration files
240 | typings/
241 | 
242 | # Visual Studio 6 build log
243 | *.plg
244 | 
245 | # Visual Studio 6 workspace options file
246 | *.opt
247 | 
248 | # Visual Studio 6 auto-generated workspace file (contains which files were open etc.)
249 | *.vbw
250 | 
251 | # Visual Studio LightSwitch build output
252 | **/*.HTMLClient/GeneratedArtifacts
253 | **/*.DesktopClient/GeneratedArtifacts
254 | **/*.DesktopClient/ModelManifest.xml
255 | **/*.Server/GeneratedArtifacts
256 | **/*.Server/ModelManifest.xml
257 | _Pvt_Extensions
258 | 
259 | # Paket dependency manager
260 | .paket/paket.exe
261 | paket-files/
262 | 
263 | # FAKE - F# Make
264 | .fake/
265 | 
266 | # JetBrains Rider
267 | .idea/
268 | *.sln.iml
269 | 
270 | # CodeRush
271 | .cr/
272 | 
273 | # Python Tools for Visual Studio (PTVS)
274 | __pycache__/
275 | *.pyc
276 | 
277 | # Cake - Uncomment if you are using it
278 | # tools/**
279 | # !tools/packages.config
280 | 
281 | # Telerik's JustMock configuration file
282 | *.jmconfig
283 | 
284 | # BizTalk build output
285 | *.btp.cs
286 | *.btm.cs
287 | *.odx.cs
288 | *.xsd.cs
289 | *.db
290 | 


--------------------------------------------------------------------------------