{"id":19863167,"url":"https://github.com/peopleware/stylecop-msbuild-ppwcode","last_synced_at":"2026-02-01T12:38:16.616Z","repository":{"id":18199794,"uuid":"21328555","full_name":"peopleware/stylecop-msbuild-ppwcode","owner":"peopleware","description":"Nuget package for StyleCop MSBuild integration with the PPWCode code style settings.","archived":false,"fork":false,"pushed_at":"2015-11-25T13:44:17.000Z","size":7144,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-06-20T23:08:04.803Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/peopleware.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE_Non-StyleCop-files","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-06-29T17:43:17.000Z","updated_at":"2015-05-09T13:42:12.000Z","dependencies_parsed_at":"2022-08-25T14:50:27.887Z","dependency_job_id":null,"html_url":"https://github.com/peopleware/stylecop-msbuild-ppwcode","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/peopleware/stylecop-msbuild-ppwcode","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peopleware%2Fstylecop-msbuild-ppwcode","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peopleware%2Fstylecop-msbuild-ppwcode/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peopleware%2Fstylecop-msbuild-ppwcode/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peopleware%2Fstylecop-msbuild-ppwcode/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/peopleware","download_url":"https://codeload.github.com/peopleware/stylecop-msbuild-ppwcode/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peopleware%2Fstylecop-msbuild-ppwcode/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261032097,"owners_count":23100050,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-12T15:13:49.769Z","updated_at":"2026-02-01T12:38:10.701Z","avatar_url":"https://github.com/peopleware.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# StyleCop.MSBuild.PPWCode\n\nThis NuGet package provides [StyleCop] MSBuild integration with the PPWCode \nstyle conventions.\n\n\n## Getting started\n\nThe package is available from the [NuGet] central package repository: the\n[NuGet Gallery].\n\nThe package can be installed on a project by project basis by using the\nNuGet package manager from inside Visual Studio.\n\nDuring package installation, a hook will be placed in the project build\nwhich will trigger StyleCop.  From then on, the build output will also\ncontain StyleCop warnings.\n\nStyleCop warnings can be spotted easily in the build output because these\nwarnings always start with a prefix of the form `SAxxxx`, with `xxxx` a\nnumber referring to the specific StyleCop rule that was violated.\n\nNote that there is no need to install StyleCop when using this NuGet package.\nThe NuGet package includes a version of StyleCop which is used transparently.\n\n\n## Style settings\n\nNote that complete documentation is available at [StyleCop documentation].\n\nThe package contains a StyleCop settings configuration that reflects the code\nstyle that is followed throughout all the PPWCode projects.\n\nEven if this style is no match with the coding style you wish to follow in\nyour own projects, this package can still be usefull. It is possible to\noverride the included settings in the following ways.\n\n### Use your own StyleCop settings files\n\nIt is possible to completely override the included settings by using another\nsettings file on a project by project basis.  The preferred setttings file must\nbe placed in the root of the project.\n\nFor more information, see [StyleCop settings across projects].\n\n### Locally disable specific rules\n\nThe StyleCop settings that are configured for PPWCode are pretty strict. Sometimes\nit is desirable to disable specific rules locally, without disabling the rules\nalltogether over the whole of the project.\n\nDisabling specific rules can be done using a specific `SuppressMessage` attribute.\nWe illustrate this with a couple of examples. For more complete documentation,\nplease consult the StyleCop documentation: [StyleCop Rule Suppressions].\n\n#### Example: disable specific rule\n\nThe following example shows how to disable a specific rule.\n\n    [SuppressMessage(\n        \"StyleCop.CSharp.NamingRules\",\n        \"SA1302:InterfaceNamesMustBeginWithI\",\n        Justification = \"Reviewed. Suppression is OK here.\")] \n    public interface MyInterface\n    { \n        int GiveMeAnInt();\n    }\n\nNote that it is required to add a `justification` when suppressing a rule.\n\n\n#### Example: disable class of rules\n\nThe following example shows how to disable all naming rules.\n\n    [SuppressMessage(\n        \"StyleCop.CSharp.NamingRules\",\n        \"*\",\n        Justification = \"Reviewed. Suppression is OK here.\")] \n    public interface MyInterface\n    { \n        int GiveMeAnInt();\n    }\n\nNote that also in this case a `justification` must be added.\n    \n\n## Contributors\n\nSee the [GitHub Contributors list].\n\n\n## PPWCode\n\nThis package is part of the PPWCode project, developed by [PeopleWare n.v.].\n\nMore information can be found in the following locations:\n* [PPWCode project website]\n* [PPWCode Google Code website]\n\nPlease note that not all information on those sites is up-to-date. We are\ncurrently in the process of moving the code away from the Google code\nsubversion repositories to git repositories on [GitHub].\n\n\n### PPWCode .NET\n\nSpecifically for the .NET libraries: new development will be done on the\n[PeopleWare GitHub repositories], and all new stable releases will also\nbe published as packages on the [NuGet Gallery].\n\nWe believe in Design By Contract and have good experience with\n[Microsoft Code Contracts] and the related tooling.  As such, our packages\nalways include Contract Reference assemblies.  This allows you to also\nbenefit as a user from the contracts that are already included in the\nlibrary code.\n\nThe packages also include both the pdb and xml files, for debugging symbols\nand documentation respectively.  In the future we might look into using\nsymbol servers.\n\n\n## License and Copyright\n\nCopyright 2014 by [PeopleWare n.v.].\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\nhttp://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n\n\n### StyleCop\n\nA release of StyleCop is embedded in this package.\n\nStyleCop is licensed under the Microsoft Public License (see [StyleCop License]).\n\n\n\n[PPWCode project website]: http://www.ppwcode.org\n[PPWCode Google Code website]: http://ppwcode.googlecode.com\n\n[PeopleWare n.v.]: http://www.peopleware.be/\n\n[NuGet]: https://www.nuget.org/\n[NuGet Gallery]: https://www.nuget.org/policies/About\n\n[GitHub]: https://github.com\n[PeopleWare GitHub repositories]: https://github.com/peopleware\n\n[Microsoft Code Contracts]: http://research.microsoft.com/en-us/projects/contracts/\n\n[StyleCop]: http://stylecop.codeplex.com/\n[StyleCop License]: http://stylecop.codeplex.com/license\n[StyleCop documentation]: https://stylecop.codeplex.com/documentation\n[StyleCop settings across projects]: https://stylecop.codeplex.com/wikipage?title=Sharing%20StyleCop%20Settings%20Across%20Projects\u0026referringTitle=Documentation\n[StyleCop Rule Suppressions]: https://stylecop.codeplex.com/wikipage?title=Rule%20Suppressions\u0026referringTitle=Documentation\n\n[GitHub Contributors list]: https://github.com/peopleware/stylecop-msbuild-ppwcode/graphs/contributors\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpeopleware%2Fstylecop-msbuild-ppwcode","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpeopleware%2Fstylecop-msbuild-ppwcode","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpeopleware%2Fstylecop-msbuild-ppwcode/lists"}