chore: linter updates

andrewbabbittdev · andrewbabbittdev · commit cf8da838159b · 2022-05-08T04:04:07.000-06:00
diff --git a/.editorconfig b/.editorconfig
diff --git a/src/BlazorDesktop.Sample/App.razor b/src/BlazorDesktop.Sample/App.razor
@@ -1,4 +1,8 @@
-﻿<Router AppAssembly="@typeof(App).Assembly">
+﻿@* Licensed to the Blazor Desktop Contributors under one or more agreements. *@
+@* The Blazor Desktop Contributors licenses this file to you under the MIT license. *@
+@* See the LICENSE file in the project root for more information. *@
+
+<Router AppAssembly="@typeof(App).Assembly">
     <Found Context="routeData">
         <RouteView RouteData="@routeData" DefaultLayout="@typeof(MainLayout)" />
         <FocusOnNavigate RouteData="@routeData" Selector="h1" />
diff --git a/src/BlazorDesktop.Sample/Data/WeatherForecast.cs b/src/BlazorDesktop.Sample/Data/WeatherForecast.cs
@@ -4,14 +4,29 @@
 
 namespace BlazorDesktop.Data
 {
+    /// <summary>
+    /// A weather forecast
+    /// </summary>
     public class WeatherForecast
     {
+        /// <summary>
+        /// The date
+        /// </summary>
         public DateTime Date { get; set; }
 
+        /// <summary>
+        /// The temperature in celcius
+        /// </summary>
         public int TemperatureC { get; set; }
 
+        /// <summary>
+        /// The temperature in fahrenheit
+        /// </summary>
         public int TemperatureF => 32 + (int)(TemperatureC / 0.5556);
 
+        /// <summary>
+        /// The summary
+        /// </summary>
         public string? Summary { get; set; }
     }
 }
diff --git a/src/BlazorDesktop.Sample/Data/WeatherForecastService.cs b/src/BlazorDesktop.Sample/Data/WeatherForecastService.cs
@@ -4,20 +4,31 @@
 
 namespace BlazorDesktop.Data
 {
+    /// <summary>
+    /// The weather forecast service
+    /// </summary>
     public class WeatherForecastService
     {
-        private static readonly string[] Summaries = new[]
+        /// <summary>
+        /// The list of summaries
+        /// </summary>
+        private static readonly string[] s_summaries = new[]
         {
             "Freezing", "Bracing", "Chilly", "Cool", "Mild", "Warm", "Balmy", "Hot", "Sweltering", "Scorching"
         };
 
+        /// <summary>
+        /// Gets the weather forecast asynchronously
+        /// </summary>
+        /// <param name="startDate">The starting date</param>
+        /// <returns>An array of <see cref="WeatherForecast"/></returns>
         public Task<WeatherForecast[]> GetForecastAsync(DateTime startDate)
         {
             return Task.FromResult(Enumerable.Range(1, 5).Select(index => new WeatherForecast
             {
                 Date = startDate.AddDays(index),
                 TemperatureC = Random.Shared.Next(-20, 55),
-                Summary = Summaries[Random.Shared.Next(Summaries.Length)]
+                Summary = s_summaries[Random.Shared.Next(s_summaries.Length)]
             }).ToArray());
         }
     }
diff --git a/src/BlazorDesktop.Sample/Pages/Counter.razor b/src/BlazorDesktop.Sample/Pages/Counter.razor
@@ -1,4 +1,8 @@
-﻿@page "/counter"
+﻿@* Licensed to the Blazor Desktop Contributors under one or more agreements. *@
+@* The Blazor Desktop Contributors licenses this file to you under the MIT license. *@
+@* See the LICENSE file in the project root for more information. *@
+
+@page "/counter"
 
 <PageTitle>Counter</PageTitle>
 
diff --git a/src/BlazorDesktop.Sample/Pages/FetchData.razor b/src/BlazorDesktop.Sample/Pages/FetchData.razor
@@ -1,4 +1,8 @@
-﻿@page "/fetchdata"
+﻿@* Licensed to the Blazor Desktop Contributors under one or more agreements. *@
+@* The Blazor Desktop Contributors licenses this file to you under the MIT license. *@
+@* See the LICENSE file in the project root for more information. *@
+
+@page "/fetchdata"
 
 @using BlazorDesktop.Data
 
diff --git a/src/BlazorDesktop.Sample/Pages/Index.razor b/src/BlazorDesktop.Sample/Pages/Index.razor
@@ -1,4 +1,8 @@
-﻿@page "/"
+﻿@* Licensed to the Blazor Desktop Contributors under one or more agreements. *@
+@* The Blazor Desktop Contributors licenses this file to you under the MIT license. *@
+@* See the LICENSE file in the project root for more information. *@
+
+@page "/"
 
 <PageTitle>Index</PageTitle>
 
diff --git a/src/BlazorDesktop.Sample/Shared/MainLayout.razor b/src/BlazorDesktop.Sample/Shared/MainLayout.razor
@@ -1,4 +1,8 @@
-﻿@inherits LayoutComponentBase
+﻿@* Licensed to the Blazor Desktop Contributors under one or more agreements. *@
+@* The Blazor Desktop Contributors licenses this file to you under the MIT license. *@
+@* See the LICENSE file in the project root for more information. *@
+
+@inherits LayoutComponentBase
 
 <div class="page">
     <div class="sidebar">
diff --git a/src/BlazorDesktop.Sample/Shared/MainLayout.razor.css b/src/BlazorDesktop.Sample/Shared/MainLayout.razor.css
@@ -1,3 +1,7 @@
+/* Licensed to the Blazor Desktop Contributors under one or more agreements. */
+/* The Blazor Desktop Contributors licenses this file to you under the MIT license. */
+/* See the LICENSE file in the project root for more information. */
+
 .page {
     position: relative;
     display: flex;
diff --git a/src/BlazorDesktop.Sample/Shared/NavMenu.razor b/src/BlazorDesktop.Sample/Shared/NavMenu.razor
@@ -1,4 +1,8 @@
-﻿<div class="top-row ps-3 navbar navbar-dark">
+﻿@* Licensed to the Blazor Desktop Contributors under one or more agreements. *@
+@* The Blazor Desktop Contributors licenses this file to you under the MIT license. *@
+@* See the LICENSE file in the project root for more information. *@
+
+<div class="top-row ps-3 navbar navbar-dark">
     <div class="container-fluid">
         <a class="navbar-brand" href="">BlazorDesktop.Sample</a>
         <button title="Navigation menu" class="navbar-toggler" @onclick="ToggleNavMenu">
diff --git a/src/BlazorDesktop.Sample/Shared/NavMenu.razor.css b/src/BlazorDesktop.Sample/Shared/NavMenu.razor.css
@@ -1,3 +1,7 @@
+/* Licensed to the Blazor Desktop Contributors under one or more agreements. */
+/* The Blazor Desktop Contributors licenses this file to you under the MIT license. */
+/* See the LICENSE file in the project root for more information. */
+
 .navbar-toggler {
     background-color: rgba(255, 255, 255, 0.1);
 }
diff --git a/src/BlazorDesktop.Sample/Shared/SurveyPrompt.razor b/src/BlazorDesktop.Sample/Shared/SurveyPrompt.razor
@@ -1,4 +1,8 @@
-﻿<div class="alert alert-secondary mt-4">
+﻿@* Licensed to the Blazor Desktop Contributors under one or more agreements. *@
+@* The Blazor Desktop Contributors licenses this file to you under the MIT license. *@
+@* See the LICENSE file in the project root for more information. *@
+
+<div class="alert alert-secondary mt-4">
     <span class="oi oi-pencil me-2" aria-hidden="true"></span>
     <strong>@Title</strong>
 
diff --git a/src/BlazorDesktop.Sample/_Imports.razor b/src/BlazorDesktop.Sample/_Imports.razor
@@ -1,4 +1,8 @@
-﻿@using System.Net.Http
+﻿@* Licensed to the Blazor Desktop Contributors under one or more agreements. *@
+@* The Blazor Desktop Contributors licenses this file to you under the MIT license. *@
+@* See the LICENSE file in the project root for more information. *@
+
+@using System.Net.Http
 @using System.Net.Http.Json
 @using Microsoft.AspNetCore.Components.Forms
 @using Microsoft.AspNetCore.Components.Routing
diff --git a/src/BlazorDesktop.Sample/wwwroot/css/app.css b/src/BlazorDesktop.Sample/wwwroot/css/app.css
@@ -1,4 +1,8 @@
-﻿@import url('open-iconic/font/css/open-iconic-bootstrap.min.css');
+/* Licensed to the Blazor Desktop Contributors under one or more agreements. */
+/* The Blazor Desktop Contributors licenses this file to you under the MIT license. */
+/* See the LICENSE file in the project root for more information. */
+
+@import url('open-iconic/font/css/open-iconic-bootstrap.min.css');
 
 html, body {
     font-family: 'Helvetica Neue', Helvetica, Arial, sans-serif;
diff --git a/src/BlazorDesktop.Sample/wwwroot/index.html b/src/BlazorDesktop.Sample/wwwroot/index.html
@@ -1,3 +1,7 @@
+<!-- Licensed to the Blazor Desktop Contributors under one or more agreements. -->
+<!-- The Blazor Desktop Contributors licenses this file to you under the MIT license. -->
+<!-- See the LICENSE file in the project root for more information. -->
+
 <!DOCTYPE html>
 <html lang="en">
 
diff --git a/src/BlazorDesktop.Templates/BlazorDesktop.Templates.csproj b/src/BlazorDesktop.Templates/BlazorDesktop.Templates.csproj
@@ -24,6 +24,7 @@
     <RepositoryType>git</RepositoryType>
     <NoWarn>$(NoWarn);NU5128</NoWarn>
     <PackageIcon>nuget.png</PackageIcon>
+    <LangVersion>10.0</LangVersion>
   </PropertyGroup>
 
   <ItemGroup>
diff --git a/src/BlazorDesktop/Hosting/BlazorDesktopHost.cs b/src/BlazorDesktop/Hosting/BlazorDesktopHost.cs
@@ -39,23 +39,35 @@ internal BlazorDesktopHost(IHost host)
     /// </summary>
     /// <param name="cancellationToken">The <see cref="CancellationToken"/>.</param>
     /// <returns>A task that represents the startup of the <see cref="BlazorDesktopHost"/>.</returns>
-    public Task StartAsync(CancellationToken cancellationToken = default) => _host.StartAsync(cancellationToken);
+    public Task StartAsync(CancellationToken cancellationToken = default)
+    {
+        return _host.StartAsync(cancellationToken);
+    }
 
     /// <summary>
     /// Shuts down the host.
     /// </summary>
     /// <param name="cancellationToken">The <see cref="CancellationToken"/>.</param>
     /// <returns>A task that represents the shutdown of the <see cref="BlazorDesktopHost"/>.</returns>
-    public Task StopAsync(CancellationToken cancellationToken = default) => _host.StopAsync(cancellationToken);
+    public Task StopAsync(CancellationToken cancellationToken = default)
+    {
+        return _host.StopAsync(cancellationToken);
+    }
 
     /// <summary>
     /// Disposes the host.
     /// </summary>
-    public void Dispose() => _host.Dispose();
+    public void Dispose()
+    {
+        _host.Dispose();
+    }
 
     /// <summary>
     /// Disposes the host asynchronously.
     /// </summary>
     /// <returns></returns>
-    public ValueTask DisposeAsync() => ((IAsyncDisposable)_host).DisposeAsync();
+    public ValueTask DisposeAsync()
+    {
+        return ((IAsyncDisposable)_host).DisposeAsync();
+    }
 }
diff --git a/src/BlazorDesktop/Hosting/BlazorDesktopHostBuilder.cs b/src/BlazorDesktop/Hosting/BlazorDesktopHostBuilder.cs
@@ -71,7 +71,10 @@ internal BlazorDesktopHostBuilder(string[]? args)
     /// </summary>
     /// <param name="args">The arguments passed to the application's main method.</param>
     /// <returns>A <see cref="BlazorDesktopHostBuilder"/>.</returns>
-    public static BlazorDesktopHostBuilder CreateDefault(string[]? args = default) => new(args);
+    public static BlazorDesktopHostBuilder CreateDefault(string[]? args = default)
+    {
+        return new(args);
+    }
 
     /// <summary>
     /// Builds a <see cref="BlazorDesktopHost"/> instance based on the configuration of this builder.
diff --git a/src/BlazorDesktop/Services/BlazorDesktopService.cs b/src/BlazorDesktop/Services/BlazorDesktopService.cs
@@ -75,7 +75,10 @@ public async Task StartAsync(CancellationToken cancellationToken)
     /// </summary>
     /// <param name="cancellationToken">The <see cref="CancellationToken"/>.</param>
     /// <returns>A task representing the shutdown of the service.</returns>
-    public Task StopAsync(CancellationToken cancellationToken) => Task.CompletedTask;
+    public Task StopAsync(CancellationToken cancellationToken)
+    {
+        return Task.CompletedTask;
+    }
 
     /// <summary>
     /// The application thread.
diff --git a/src/Directory.Build.props b/src/Directory.Build.props
@@ -0,0 +1,8 @@
+<Project>
+  <PropertyGroup>
+    <Nullable>enable</Nullable>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <WarningsAsErrors>Nullable</WarningsAsErrors>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
+  </PropertyGroup>
+</Project>

Original file line number	Diff line number	Diff line change
`@@ -4,20 +4,31 @@`
`4`	`4`
`5`	`5`	`namespace BlazorDesktop.Data`
`6`	`6`	`{`
	`7`	`+ /// <summary>`
	`8`	`+ /// The weather forecast service`
	`9`	`+ /// </summary>`
`7`	`10`	`public class WeatherForecastService`
`8`	`11`	`{`
`9`		`- private static readonly string[] Summaries = new[]`
	`12`	`+ /// <summary>`
	`13`	`+ /// The list of summaries`
	`14`	`+ /// </summary>`
	`15`	`+ private static readonly string[] s_summaries = new[]`
`10`	`16`	`{`
`11`	`17`	`"Freezing", "Bracing", "Chilly", "Cool", "Mild", "Warm", "Balmy", "Hot", "Sweltering", "Scorching"`
`12`	`18`	`};`
`13`	`19`
	`20`	`+ /// <summary>`
	`21`	`+ /// Gets the weather forecast asynchronously`
	`22`	`+ /// </summary>`
	`23`	`+ /// <param name="startDate">The starting date</param>`
	`24`	`+ /// <returns>An array of <see cref="WeatherForecast"/></returns>`
`14`	`25`	`public Task<WeatherForecast[]> GetForecastAsync(DateTime startDate)`
`15`	`26`	`{`
`16`	`27`	`return Task.FromResult(Enumerable.Range(1, 5).Select(index => new WeatherForecast`
`17`	`28`	`{`
`18`	`29`	`Date = startDate.AddDays(index),`
`19`	`30`	`TemperatureC = Random.Shared.Next(-20, 55),`
`20`		`- Summary = Summaries[Random.Shared.Next(Summaries.Length)]`
	`31`	`+ Summary = s_summaries[Random.Shared.Next(s_summaries.Length)]`
`21`	`32`	`}).ToArray());`
`22`	`33`	`}`
`23`	`34`	`}`