huahaofeng
/
aspnetcore
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Fix #118, Only check K projects for XML documentation errors 

- ignore leftover XML files e.g. from other branches
 - tested manually in MVC repo with a bad doc file outside a K project
- limit checked XML files to those in `bin` directory under K projects
- align with clean target: that only removes bin directories under K projects
- approach ignores XML files in .csproj projects but no such projects in
  repos where _k-xml-docs-test.shade file is used

Address old [comment](https://github.com/aspnet/Universe/pull/101/files#r16633938) from @Eilon on PR#101
> Traditionally we use i++ and not ++i.
This commit is contained in:
Doug Bunting 2014-11-30 21:38:29 -08:00
parent 42f92f78e6
commit ea355e137f
1 changed files with 33 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

59
build/_k-xml-docs-test.shade
View File

@ -8,41 +8,48 @@ default BASE_DIR='${Directory.GetCurrentDirectory()}'
@{ @{
var srcDir = Path.Combine(BASE_DIR, "src"); var srcDir = Path.Combine(BASE_DIR, "src");
foreach (var xmlFilePath in Files.Include(Path.Combine(srcDir, "**/*.xml"))) foreach (var projectFile in Files.Include(Path.Combine(srcDir, "**", "project.json")))
{ {
var errors = 0; var binDirectory = Path.Combine(Path.GetDirectoryName(projectFile), "bin");
var xmlLines = File.ReadAllLines(xmlFilePath); if (Directory.Exists(binDirectory))
for (var linesIndex = 0; linesIndex < xmlLines.Length; ++linesIndex)
{ {
var xmlLine = xmlLines[linesIndex].Trim(); foreach (var xmlFilePath in Files.Include(Path.Combine(binDirectory, "**", "*.xml")))
if (xmlLine.StartsWith("<!--"))
{ {
// Compiler only emits comments for syntax errors. var errors = 0;
if (errors == 0) var xmlLines = File.ReadAllLines(xmlFilePath);
for (var linesIndex = 0; linesIndex < xmlLines.Length; linesIndex++)
{ {
Log.Warn(string.Format("Invalid documentation syntax in {0}:", xmlFilePath)); var xmlLine = xmlLines[linesIndex].Trim();
if (xmlLine.StartsWith("<!--"))
{
// Compiler only emits comments for syntax errors.
if (errors == 0)
{
Log.Warn(string.Format("Invalid documentation syntax in {0}:", xmlFilePath));
}
errors++;
Log.Warn(string.Format(" {0}: {1}", linesIndex + 1, xmlLine));
}
else if (xmlLine.Contains("\"!:"))
{
// '!' is reference string error token.
if (errors == 0)
{
Log.Warn(string.Format("Invalid documentation syntax in {0}:", xmlFilePath));
}
errors++;
Log.Warn(string.Format(" {0}: {1}", linesIndex + 1, xmlLine));
}
} }
++errors; if (errors != 0)
Log.Warn(string.Format(" {0}: {1}", linesIndex + 1, xmlLine));
}
else if (xmlLine.Contains("\"!:"))
{
// '!' is reference string error token.
if (errors == 0)
{ {
Log.Warn(string.Format("Invalid documentation syntax in {0}:", xmlFilePath)); Environment.Exit(errors);
return;
} }
++errors;
Log.Warn(string.Format(" {0}: {1}", linesIndex + 1, xmlLine));
} }
} }
if (errors != 0)
{
Environment.Exit(errors);
return;
}
} }
} }