diff --git a/.gitignore b/.gitignore index a057183f58..9553838c52 100644 --- a/.gitignore +++ b/.gitignore @@ -22,6 +22,7 @@ mods/*/*.mdb /*.pdb /*.mdb /*.exe +thirdparty/StyleCop* # backup files by various editors *~ @@ -57,6 +58,7 @@ Lua-API.md # StyleCop *.Cache +StyleCopViolations.xml # SublimeText *.sublime-project diff --git a/INSTALL.md b/INSTALL.md index 48614c2a88..4754ec0f11 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -38,6 +38,7 @@ Debian/Ubuntu * mono-dmcs * libmono-system-windows-forms4.0-cil +* nuget * cli-common-dev (>= 2.10) * libfreetype6 * libopenal1 @@ -50,6 +51,7 @@ openSUSE -------- * mono-devel +* nuget * openal * freetype2 * SDL2 @@ -62,6 +64,7 @@ Gentoo * dev-lang/mono * dev-dotnet/libgdiplus +* dev-dotnet/nuget * media-libs/freetype:2 * media-libs/libsdl2 * media-libs/openal diff --git a/Makefile b/Makefile index b4941623c4..d8be6e0890 100644 --- a/Makefile +++ b/Makefile @@ -105,7 +105,7 @@ mod_common_SRCS := $(shell find OpenRA.Mods.Common/ -iname '*.cs') mod_common_TARGET = mods/common/OpenRA.Mods.Common.dll mod_common_KIND = library mod_common_DEPS = $(game_TARGET) -mod_common_LIBS = $(COMMON_LIBS) $(STD_MOD_LIBS) +mod_common_LIBS = $(COMMON_LIBS) $(STD_MOD_LIBS) thirdparty/StyleCop.dll thirdparty/StyleCop.CSharp.dll thirdparty/StyleCop.CSharp.Rules.dll PROGRAMS += mod_common mod_common: $(mod_common_TARGET) @@ -264,6 +264,7 @@ distclean: clean dependencies: cli-dependencies native-dependencies cli-dependencies: + cd thirdparty && ./fetch-thirdparty-deps.sh && cd .. @ $(CP_R) thirdparty/*.dll . @ $(CP_R) thirdparty/*.dll.config . diff --git a/OpenRA.Mods.Common/OpenRA.Mods.Common.csproj b/OpenRA.Mods.Common/OpenRA.Mods.Common.csproj index 8cefe7899b..c46f3e917c 100644 --- a/OpenRA.Mods.Common/OpenRA.Mods.Common.csproj +++ b/OpenRA.Mods.Common/OpenRA.Mods.Common.csproj @@ -31,14 +31,22 @@ - - False - ..\thirdparty\Eluant.dll - False - + + ..\thirdparty\Eluant.dll + False + + + ..\thirdparty\StyleCop.CSharp.Rules.dll + + + ..\thirdparty\StyleCop.CSharp.dll + + + ..\thirdparty\StyleCop.dll + @@ -244,6 +252,7 @@ + diff --git a/OpenRA.Mods.Common/UtilityCommands/CheckCodeStyle.cs b/OpenRA.Mods.Common/UtilityCommands/CheckCodeStyle.cs new file mode 100644 index 0000000000..017c84a6f4 --- /dev/null +++ b/OpenRA.Mods.Common/UtilityCommands/CheckCodeStyle.cs @@ -0,0 +1,56 @@ +#region Copyright & License Information +/* + * Copyright 2007-2014 The OpenRA Developers (see AUTHORS) + * This file is part of OpenRA, which is free software. It is made + * available to you under the terms of the GNU General Public License + * as published by the Free Software Foundation. For more information, + * see COPYING. + */ +#endregion + +using System; +using System.Collections.Generic; +using System.IO; +using System.Linq; +using System.Reflection; +using OpenRA.FileSystem; +using OpenRA.Traits; +using StyleCop; + +namespace OpenRA.Mods.Common.UtilityCommands +{ + class CheckCodeStyle : IUtilityCommand + { + public string Name { get { return "--check-code-style"; } } + int violationCount; + + [Desc("DIRECTORY", "Check the *.cs source code files in a directory for code style violations.")] + public void Run(ModData modData, string[] args) + { + var projectPath = Path.GetFullPath(args[1]); + + var console = new StyleCopConsole(null, false, null, null, true); + var project = new CodeProject(0, projectPath, new Configuration(null)); + foreach (var filePath in Directory.GetFiles(projectPath, "*.cs", SearchOption.AllDirectories)) + console.Core.Environment.AddSourceCode(project, filePath, null); + + console.OutputGenerated += OnOutputGenerated; + console.ViolationEncountered += OnViolationEncountered; + console.Start(new[] { project }, true); + + if (violationCount > 0) + Environment.Exit(1); + } + + void OnOutputGenerated(object sender, OutputEventArgs e) + { + Console.WriteLine(e.Output); + } + + void OnViolationEncountered(object sender, ViolationEventArgs e) + { + violationCount++; + Console.WriteLine("{0}:L{1}: [{2}] {3}", e.SourceCode.Path, e.LineNumber, e.Violation.Rule.CheckId, e.Message); + } + } +} diff --git a/make.ps1 b/make.ps1 index 2dda5c5f35..4e7ddfaf0f 100644 --- a/make.ps1 +++ b/make.ps1 @@ -107,8 +107,11 @@ elseif ($command -eq "version") } elseif ($command -eq "dependencies") { - cp thirdparty/*.dll . - cp thirdparty/windows/*.dll . + cd thirdparty + ./fetch-thirdparty-deps.ps1 + cp *.dll .. + cp windows/*.dll .. + cd .. echo "Dependencies copied." } elseif ($command -eq "test") diff --git a/thirdparty/fetch-thirdparty-deps.ps1 b/thirdparty/fetch-thirdparty-deps.ps1 new file mode 100644 index 0000000000..bfc9fdb8fc --- /dev/null +++ b/thirdparty/fetch-thirdparty-deps.ps1 @@ -0,0 +1,12 @@ +if (!(Test-Path "nuget.exe")) +{ + echo "Fetching NuGet." + Invoke-WebRequest "http://nuget.org/nuget.exe" -OutFile "nuget.exe" +} +if (!(Test-Path "StyleCop.dll")) +{ + echo "Fetching StyleCop files from NuGet." + ./nuget.exe install StyleCop.MSBuild -Version 4.7.49.0 + cp StyleCop.MSBuild.4.7.49.0/tools/StyleCop*.dll . + rmdir StyleCop.MSBuild.4.7.49.0 -Recurse +} diff --git a/thirdparty/fetch-thirdparty-deps.sh b/thirdparty/fetch-thirdparty-deps.sh new file mode 100755 index 0000000000..efff79699c --- /dev/null +++ b/thirdparty/fetch-thirdparty-deps.sh @@ -0,0 +1,7 @@ +#!/bin/bash +if [ ! -f StyleCop.dll ]; then + echo "Fetching StyleCop files from nuget" + nuget install StyleCop.MSBuild -Version 4.7.49.0 + cp ./StyleCop.MSBuild.4.7.49.0/tools/StyleCop*.dll . + rm -rf StyleCop.MSBuild.4.7.49.0 +fi \ No newline at end of file