search

splunk / splunk-sdk-csharp-pcl

Splunk's next generation C# SDK
https://dev.splunk.com/enterprise/docs/csharp
Apache License 2.0
64 stars 46 forks source link

removed redundant StyleCop package #39

Closed adamralph closed 9 years ago

adamralph commented 9 years ago

You only need to install the StyleCop package if you want to reference the lib and build custom rules, which this solution does not do. To run StyleCop analysis, all you need is StyleCop.MSBuild.

As an aside, I also noticed that two projects (Splunk.Client and Splunk.ModularInputs) have both BuildTools.StyleCop and StyleCop.MSBuild installed. You only need one of them. The difference between the two is that StyleCop.MSBuild only installs the targets required for analysis to run and it uses the built-in facility in NuGet (build folder) to do this. BuildTools.StyleCop does the same thing but it uses PowerShell (Install.ps1) to inject the targets into the csproj which introduces x-plat issues. BuildTools.StyleCop also adds PowerShell functions to control the settings but obviously these are also liable to x-plat problems.

glennblock commented 9 years ago

Hey @adamralph, nice to see you here, are you using Splunk now? :-)

Thanks for sending the PR. Can you fill out our CLA? http://www.splunk.com/goto/individualcontributions

adamralph commented 9 years ago

@glennblock CLA signed.

We used Splunk in my previous job but never via the API. Someone raised an issue (unrelated) regarding StyleCop.MSBuild which prompted me to trawl GitHub for usages of the package and I just happened to stumble upon your usage of it in this repo. I spotted the redundant installations of the StyleCop package so I thought I'd just clean them out for you. I'm guessing that perhaps there was a misunderstanding regarding the relationship of StyleCop and StyleCop.MSBuild.

glennblock commented 9 years ago

Thanks. Yep. On Sun, May 31, 2015 at 1:53 PM Adam Ralph notifications@github.com wrote:

@glennblock https://github.com/glennblock CLA signed.

We used Splunk in my previous job but never via the API. Someone raised an issue (unrelated) regarding StyleCop.MSBuild which prompted me to trawl GitHub for usages of the package and I just happened to stumble upon your usage of it in this repo. I spotted the redundant installations of the StyleCop package so I thought I'd just clean them out for you. I'm guessing that perhaps there was a misunderstanding regarding the relationship of StyleCop and StyleCop.MSBuild.

— Reply to this email directly or view it on GitHub https://github.com/splunk/splunk-sdk-csharp-pcl/pull/39#issuecomment-107243162 .

shakeelmohamed commented 9 years ago

Hi @adamralph thanks for doing this! Can you make a PR against the develop branch?

glennblock commented 9 years ago

Aah good catch @shakeelmohamed!

adamralph commented 9 years ago

@shakeelmohamed done - https://github.com/splunk/splunk-sdk-csharp-pcl/issues/40

You may want to consider making develop the default branch and/or adding a CONTRIBUTING.md which says that it should be used.

glennblock commented 9 years ago

@adamralph I don't think we want to make develop the default. Master is the latest shipped bits and we know folks download directly from our repo.

Adding a mention in our contrib guidelines to send to develop is not a bad idea though. On Sun, May 31, 2015 at 10:56 PM Adam Ralph notifications@github.com wrote:

@shakeelmohamed https://github.com/shakeelmohamed done - #40 https://github.com/splunk/splunk-sdk-csharp-pcl/pull/40

You may want to consider making develop the default branch and/or adding a CONTRIBUTING.md which says that it should be used.

— Reply to this email directly or view it on GitHub https://github.com/splunk/splunk-sdk-csharp-pcl/pull/39#issuecomment-107318216 .