Changed default HTML extension from '*.htm' to '*.html'

danielpalme · danielpalme · commit bbb30e338b7a · 2020-05-26T16:25:41.000+02:00
diff --git a/docs/resources/SampleReports.zip b/docs/resources/SampleReports.zip
diff --git a/src/AzureDevopsTask/ReportGenerator/reportgenerator.ts b/src/AzureDevopsTask/ReportGenerator/reportgenerator.ts
@@ -20,13 +20,6 @@ async function executeReportGenerator(): Promise<number> {
     return await tool.exec();
 }
 
-function copyHtmIndexToHtmlIndex() {
-    var sourceFile = path.join(tl.getInput('targetdir'), 'index.htm');
-    if (tl.exist(sourceFile)) {
-        tl.cp(sourceFile, path.join(tl.getInput('targetdir'), 'index.html'), '-f');
-    }
-}
-
 async function run() {
     try {
         tl.setResourcePath(path.join( __dirname, 'task.json'));
@@ -37,8 +30,6 @@ async function run() {
             tl.setResult(tl.TaskResult.Failed, tl.loc('FailedMsg'));
         }
 
-        copyHtmIndexToHtmlIndex();
-
         tl.setResult(tl.TaskResult.Succeeded, tl.loc('SucceedMsg'));
     } catch (e) {
         tl.debug(e.message);
diff --git a/src/Readme.txt b/src/Readme.txt
@@ -69,6 +69,7 @@ CHANGELOG
     * New: #348: Added coverage indicator for methods/properties
     * New: #349: Apply query string to referenced CSS and JavaScript files and links to support SAS tokens (e.g. on blob storage)
     * New: Added Source Link for Nuget package 'ReportGenerator.Core'
+    * New: Changed default HTML extension from '*.htm' to '*.html'
 
 4.5.8.0
 
diff --git a/src/ReportGenerator.Core/Reporting/Builders/HtmlChartReportBuilder.cs b/src/ReportGenerator.Core/Reporting/Builders/HtmlChartReportBuilder.cs
@@ -1,5 +1,6 @@
 ﻿using System;
 using System.Collections.Generic;
+using System.IO;
 using System.Linq;
 using Palmmedia.ReportGenerator.Core.CodeAnalysis;
 using Palmmedia.ReportGenerator.Core.Parser.Analysis;
@@ -38,7 +39,7 @@ public override void CreateSummaryReport(IReportRenderer reportRenderer, Summary
                 throw new ArgumentNullException(nameof(summaryResult));
             }
 
-            reportRenderer.BeginSummaryReport(this.ReportContext.ReportConfiguration.TargetDirectory, "CoverageHistory.htm", ReportResources.Summary);
+            reportRenderer.BeginSummaryReport(this.ReportContext.ReportConfiguration.TargetDirectory, "CoverageHistory.html", ReportResources.Summary);
 
             var historicCoverages = this.GetOverallHistoricCoverages(this.ReportContext.OverallHistoricCoverages);
             if (historicCoverages.Any(h => h.CoverageQuota.HasValue || h.BranchCoverageQuota.HasValue))
@@ -49,6 +50,11 @@ public override void CreateSummaryReport(IReportRenderer reportRenderer, Summary
             reportRenderer.CustomSummary(summaryResult.Assemblies, new List<RiskHotspot>(), summaryResult.SupportsBranchCoverage);
 
             reportRenderer.SaveSummaryReport(this.ReportContext.ReportConfiguration.TargetDirectory);
+
+            File.Copy(
+                Path.Combine(this.ReportContext.ReportConfiguration.TargetDirectory, "CoverageHistory.html"),
+                Path.Combine(this.ReportContext.ReportConfiguration.TargetDirectory, "CoverageHistory.htm"),
+                true);
         }
     }
 }
diff --git a/src/ReportGenerator.Core/Reporting/Builders/HtmlInlineAzurePipelinesDarkReportBuilder.cs b/src/ReportGenerator.Core/Reporting/Builders/HtmlInlineAzurePipelinesDarkReportBuilder.cs
@@ -1,4 +1,5 @@
 ﻿using System.Collections.Generic;
+using System.IO;
 using Palmmedia.ReportGenerator.Core.Parser.Analysis;
 using Palmmedia.ReportGenerator.Core.Reporting.Builders.Rendering;
 
@@ -40,6 +41,11 @@ public override void CreateSummaryReport(SummaryResult summaryResult)
             {
                 this.CreateSummaryReport(renderer, summaryResult);
             }
+
+            File.Copy(
+                Path.Combine(this.ReportContext.ReportConfiguration.TargetDirectory, "index.html"),
+                Path.Combine(this.ReportContext.ReportConfiguration.TargetDirectory, "index.htm"),
+                true);
         }
     }
 }
diff --git a/src/ReportGenerator.Core/Reporting/Builders/HtmlInlineAzurePipelinesReportBuilder.cs b/src/ReportGenerator.Core/Reporting/Builders/HtmlInlineAzurePipelinesReportBuilder.cs
@@ -1,4 +1,5 @@
 ﻿using System.Collections.Generic;
+using System.IO;
 using Palmmedia.ReportGenerator.Core.Parser.Analysis;
 using Palmmedia.ReportGenerator.Core.Reporting.Builders.Rendering;
 
@@ -40,6 +41,11 @@ public override void CreateSummaryReport(SummaryResult summaryResult)
             {
                 this.CreateSummaryReport(renderer, summaryResult);
             }
+
+            File.Copy(
+                Path.Combine(this.ReportContext.ReportConfiguration.TargetDirectory, "index.html"),
+                Path.Combine(this.ReportContext.ReportConfiguration.TargetDirectory, "index.htm"),
+                true);
         }
     }
 }
diff --git a/src/ReportGenerator.Core/Reporting/Builders/HtmlInlineCssAndJavaScriptReportBuilder.cs b/src/ReportGenerator.Core/Reporting/Builders/HtmlInlineCssAndJavaScriptReportBuilder.cs
@@ -1,4 +1,5 @@
 ﻿using System.Collections.Generic;
+using System.IO;
 using Palmmedia.ReportGenerator.Core.Parser.Analysis;
 using Palmmedia.ReportGenerator.Core.Reporting.Builders.Rendering;
 
@@ -40,6 +41,11 @@ public override void CreateSummaryReport(SummaryResult summaryResult)
             {
                 this.CreateSummaryReport(renderer, summaryResult);
             }
+
+            File.Copy(
+                Path.Combine(this.ReportContext.ReportConfiguration.TargetDirectory, "index.html"),
+                Path.Combine(this.ReportContext.ReportConfiguration.TargetDirectory, "index.htm"),
+                true);
         }
     }
 }
diff --git a/src/ReportGenerator.Core/Reporting/Builders/HtmlReportBuilder.cs b/src/ReportGenerator.Core/Reporting/Builders/HtmlReportBuilder.cs
@@ -1,4 +1,5 @@
 ﻿using System.Collections.Generic;
+using System.IO;
 using Palmmedia.ReportGenerator.Core.Parser.Analysis;
 using Palmmedia.ReportGenerator.Core.Reporting.Builders.Rendering;
 
@@ -64,6 +65,11 @@ public override void CreateSummaryReport(SummaryResult summaryResult)
             {
                 this.CreateSummaryReport(renderer, summaryResult);
             }
+
+            File.Copy(
+                Path.Combine(this.ReportContext.ReportConfiguration.TargetDirectory, "index.html"),
+                Path.Combine(this.ReportContext.ReportConfiguration.TargetDirectory, "index.htm"),
+                true);
         }
     }
 }
diff --git a/src/ReportGenerator.Core/Reporting/Builders/HtmlSummaryReportBuilder.cs b/src/ReportGenerator.Core/Reporting/Builders/HtmlSummaryReportBuilder.cs
@@ -1,4 +1,5 @@
 ﻿using System.Collections.Generic;
+using System.IO;
 using Palmmedia.ReportGenerator.Core.Parser.Analysis;
 using Palmmedia.ReportGenerator.Core.Reporting.Builders.Rendering;
 
@@ -36,6 +37,16 @@ public override void CreateSummaryReport(SummaryResult summaryResult)
             {
                 this.CreateSummaryReport(renderer, summaryResult);
             }
+
+            string sourcePath = Path.Combine(this.ReportContext.ReportConfiguration.TargetDirectory, "summary.html");
+
+            if (File.Exists(sourcePath))
+            {
+                File.Copy(
+                    sourcePath,
+                    Path.Combine(this.ReportContext.ReportConfiguration.TargetDirectory, "summary.htm"),
+                    true);
+            }
         }
     }
 }
diff --git a/src/ReportGenerator.Core/Reporting/Builders/MhtmlReportBuilder.cs b/src/ReportGenerator.Core/Reporting/Builders/MhtmlReportBuilder.cs
@@ -146,29 +146,30 @@ private void CreateMhtmlFile()
                 writer.WriteLine("\tboundary=\"----=_NextPart_000_0000_01D23618.54EBCBE0\"");
                 writer.WriteLine();
 
-                string file = "index.htm";
+                string file = "index.html";
                 string content = File.ReadAllText(Path.Combine(this.htmlReportTargetDirectory, file));
                 content = AddFilePrefixForCssAndJavaScript(content);
                 content = content.Replace("<tr><td><a href=\"", "<tr><td><a href=\"file:///");
                 WriteFile(writer, file, "text/html", content);
 
-                foreach (var reportFile in Directory.EnumerateFiles(this.htmlReportTargetDirectory, "*.htm"))
+                foreach (var reportFile in Directory.EnumerateFiles(this.htmlReportTargetDirectory, "*.html"))
                 {
-                    if (reportFile.EndsWith("index.htm"))
+                    if (reportFile.EndsWith("index.html"))
                     {
                         continue;
                     }
 
                     file = reportFile.Substring(reportFile.LastIndexOf(Path.DirectorySeparatorChar) + 1);
                     content = File.ReadAllText(reportFile);
                     content = AddFilePrefixForCssAndJavaScript(content);
-                    content = content.Replace("<a href=\"index.htm\">", "<a href=\"file:///index.htm\">");
+                    content = content.Replace("<a href=\"index.html\"", "<a href=\"file:///index.html\"");
                     WriteFile(writer, file, "text/html", content);
                 }
 
                 file = "main.js";
                 content = File.ReadAllText(Path.Combine(this.htmlReportTargetDirectory, file));
-                content = content.Replace(", \"reportPath\": \"", ", \"reportPath\" : \"file:///");
+                content = content.Replace(", \"reportPath\": \"", ", \"reportPath\": \"file:///");
+                content = content.Replace(", \"rp\": \"", ", \"rp\": \"file:///");
                 WriteFile(writer, file, "application/javascript", content);
 
                 file = "class.js";
diff --git a/src/ReportGenerator.Core/Reporting/Builders/Rendering/HtmlRenderer.cs b/src/ReportGenerator.Core/Reporting/Builders/Rendering/HtmlRenderer.cs
@@ -122,7 +122,7 @@ internal HtmlRenderer(bool onlySummary, HtmlMode htmlMode, string cssFileResourc
         /// <param name="title">The title.</param>
         public void BeginSummaryReport(string targetDirectory, string fileName, string title)
         {
-            string targetPath = Path.Combine(targetDirectory, this.onlySummary ? "summary.htm" : "index.htm");
+            string targetPath = Path.Combine(targetDirectory, this.onlySummary ? "summary.html" : "index.html");
 
             if (fileName != null)
             {
@@ -198,7 +198,7 @@ public void HeaderWithGithubLinks(string text)
         /// <param name="text">The text.</param>
         public void HeaderWithBackLink(string text)
         {
-            this.reportTextWriter.WriteLine("<h1><a href=\"index.htm\" class=\"back\">&lt;</a> {0}</h1>", WebUtility.HtmlEncode(text));
+            this.reportTextWriter.WriteLine("<h1><a href=\"index.html\" class=\"back\">&lt;</a> {0}</h1>", WebUtility.HtmlEncode(text));
         }
 
         /// <summary>
@@ -1270,7 +1270,7 @@ private static string GetClassReportFilename(string assemblyName, string classNa
                     }
                 }
 
-                fileName = StringHelper.ReplaceInvalidPathChars(assemblyName + "_" + shortClassName) + ".htm";
+                fileName = StringHelper.ReplaceInvalidPathChars(assemblyName + "_" + shortClassName) + ".html";
 
                 if (fileName.Length > 100)
                 {
@@ -1287,7 +1287,7 @@ private static string GetClassReportFilename(string assemblyName, string classNa
 
                     do
                     {
-                        fileName = fileNameWithoutExtension + counter + ".htm";
+                        fileName = fileNameWithoutExtension + counter + ".html";
                         counter++;
                     }
                     while (FileNameByClass.Values.Any(v => v.Equals(fileName, StringComparison.OrdinalIgnoreCase)));

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`using System;`
`2`	`2`	`using System.Collections.Generic;`
	`3`	`+using System.IO;`
`3`	`4`	`using System.Linq;`
`4`	`5`	`using Palmmedia.ReportGenerator.Core.CodeAnalysis;`
`5`	`6`	`using Palmmedia.ReportGenerator.Core.Parser.Analysis;`
`@@ -38,7 +39,7 @@ public override void CreateSummaryReport(IReportRenderer reportRenderer, Summary`
`38`	`39`	`throw new ArgumentNullException(nameof(summaryResult));`
`39`	`40`	`}`
`40`	`41`
`41`		`- reportRenderer.BeginSummaryReport(this.ReportContext.ReportConfiguration.TargetDirectory, "CoverageHistory.htm", ReportResources.Summary);`
	`42`	`+ reportRenderer.BeginSummaryReport(this.ReportContext.ReportConfiguration.TargetDirectory, "CoverageHistory.html", ReportResources.Summary);`
`42`	`43`
`43`	`44`	`var historicCoverages = this.GetOverallHistoricCoverages(this.ReportContext.OverallHistoricCoverages);`
`44`	`45`	`if (historicCoverages.Any(h => h.CoverageQuota.HasValue \|\| h.BranchCoverageQuota.HasValue))`
`@@ -49,6 +50,11 @@ public override void CreateSummaryReport(IReportRenderer reportRenderer, Summary`
`49`	`50`	`reportRenderer.CustomSummary(summaryResult.Assemblies, new List<RiskHotspot>(), summaryResult.SupportsBranchCoverage);`
`50`	`51`
`51`	`52`	`reportRenderer.SaveSummaryReport(this.ReportContext.ReportConfiguration.TargetDirectory);`
	`53`	`+`
	`54`	`+ File.Copy(`
	`55`	`+ Path.Combine(this.ReportContext.ReportConfiguration.TargetDirectory, "CoverageHistory.html"),`
	`56`	`+ Path.Combine(this.ReportContext.ReportConfiguration.TargetDirectory, "CoverageHistory.htm"),`
	`57`	`+ true);`
`52`	`58`	`}`
`53`	`59`	`}`
`54`	`60`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`using System.Collections.Generic;`
	`2`	`+using System.IO;`
`2`	`3`	`using Palmmedia.ReportGenerator.Core.Parser.Analysis;`
`3`	`4`	`using Palmmedia.ReportGenerator.Core.Reporting.Builders.Rendering;`
`4`	`5`
`@@ -40,6 +41,11 @@ public override void CreateSummaryReport(SummaryResult summaryResult)`
`40`	`41`	`{`
`41`	`42`	`this.CreateSummaryReport(renderer, summaryResult);`
`42`	`43`	`}`
	`44`	`+`
	`45`	`+ File.Copy(`
	`46`	`+ Path.Combine(this.ReportContext.ReportConfiguration.TargetDirectory, "index.html"),`
	`47`	`+ Path.Combine(this.ReportContext.ReportConfiguration.TargetDirectory, "index.htm"),`
	`48`	`+ true);`
`43`	`49`	`}`
`44`	`50`	`}`
`45`	`51`	`}`
Original file line number	Diff line number	Diff line change
`@@ -122,7 +122,7 @@ internal HtmlRenderer(bool onlySummary, HtmlMode htmlMode, string cssFileResourc`
`122`	`122`	`/// <param name="title">The title.</param>`
`123`	`123`	`public void BeginSummaryReport(string targetDirectory, string fileName, string title)`
`124`	`124`	`{`
`125`		`- string targetPath = Path.Combine(targetDirectory, this.onlySummary ? "summary.htm" : "index.htm");`
	`125`	`+ string targetPath = Path.Combine(targetDirectory, this.onlySummary ? "summary.html" : "index.html");`
`126`	`126`
`127`	`127`	`if (fileName != null)`
`128`	`128`	`{`
`@@ -198,7 +198,7 @@ public void HeaderWithGithubLinks(string text)`
`198`	`198`	`/// <param name="text">The text.</param>`
`199`	`199`	`public void HeaderWithBackLink(string text)`
`200`	`200`	`{`
`201`		`- this.reportTextWriter.WriteLine("<h1><a href=\"index.htm\" class=\"back\"><</a> {0}</h1>", WebUtility.HtmlEncode(text));`
	`201`	`+ this.reportTextWriter.WriteLine("<h1><a href=\"index.html\" class=\"back\"><</a> {0}</h1>", WebUtility.HtmlEncode(text));`
`202`	`202`	`}`
`203`	`203`
`204`	`204`	`/// <summary>`
`@@ -1270,7 +1270,7 @@ private static string GetClassReportFilename(string assemblyName, string classNa`
`1270`	`1270`	`}`
`1271`	`1271`	`}`
`1272`	`1272`
`1273`		`- fileName = StringHelper.ReplaceInvalidPathChars(assemblyName + "_" + shortClassName) + ".htm";`
	`1273`	`+ fileName = StringHelper.ReplaceInvalidPathChars(assemblyName + "_" + shortClassName) + ".html";`
`1274`	`1274`
`1275`	`1275`	`if (fileName.Length > 100)`
`1276`	`1276`	`{`
`@@ -1287,7 +1287,7 @@ private static string GetClassReportFilename(string assemblyName, string classNa`
`1287`	`1287`
`1288`	`1288`	`do`
`1289`	`1289`	`{`
`1290`		`- fileName = fileNameWithoutExtension + counter + ".htm";`
	`1290`	`+ fileName = fileNameWithoutExtension + counter + ".html";`
`1291`	`1291`	`counter++;`
`1292`	`1292`	`}`
`1293`	`1293`	`while (FileNameByClass.Values.Any(v => v.Equals(fileName, StringComparison.OrdinalIgnoreCase)));`