Merge pull request #94 from gep13/baseline

Bring Cake.Discord to canonical cake-contrib baseline (Cake.7zip-style)

Author: gep13

.config/dotnet-tools.json

@@ -3,7 +3,7 @@
   "isRoot": true,
   "tools": {
     "cake.tool": {
-      "version": "3.2.0",
+      "version": "2.3.0",
       "commands": [
         "dotnet-cake"
       ],

.github/CODE_OF_CONDUCT.md

@@ -81,7 +81,7 @@ jobs:
       uses: cake-build/cake-action@d218f1133bb74a1df0b08c89cfd8fc100c09e1a0 # v3
       with:
         script-path: recipe.cake
-        target: DotNet-Build
+        target: DotNetCore-Build
         cake-version: tool-manifest
       env:
         COMPlus_DbgEnableMiniDump: 1

.github/workflows/codeql-analysis.yml

@@ -346,3 +346,6 @@ Source/Cake.Discord/tools/**
 BuildArtifacts/*
 
 .DS_Store
+
+# Language service cache files (e.g. Roslyn / IDE language servers)
+*.lscache

.gitignore

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+nils@nils-andresen.de.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+<https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+<https://www.contributor-covenant.org/faq>. Translations are available at
+<https://www.contributor-covenant.org/translations>.

CODE_OF_CONDUCT.md

@@ -41,6 +41,10 @@ For details see $(PackageProjectUrl)/releases</PackageReleaseNotes>
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
+    <PackageReference Include="IDisposableAnalyzers" Version="4.0.8">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+    </PackageReference>
     <PackageReference Include="Microsoft.SourceLink.GitHub" Version="8.0.0">
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
       <PrivateAssets>all</PrivateAssets>

Source/Cake.Discord/Cake.Discord.csproj

@@ -48,13 +48,12 @@ internal static async Task<DiscordChatMessageResult> PostMessage(
       context.Debug("Parameter: {0}", json);
 
       using (var client = new HttpClient())
+      using (var stringContent = new StringContent(json, Encoding.UTF8, "application/json"))
+      using (var httpResponse = await client.PostAsync(webHookUrl, stringContent))
       {
-        var stringContent = new StringContent(json, Encoding.UTF8, "application/json");
-
-        var httpResponse = await client.PostAsync(webHookUrl, stringContent);
         context.Debug($"Status Code: {httpResponse.StatusCode}");
 
-        DiscordChatMessageResult parsedResult = null;
+        DiscordChatMessageResult parsedResult;
 
         if (httpResponse.StatusCode != System.Net.HttpStatusCode.NoContent)
         {
@@ -66,8 +65,8 @@ internal static async Task<DiscordChatMessageResult> PostMessage(
           parsedResult = new DiscordChatMessageResult(
             false,
             DateTime.UtcNow.ToString(),
-            result.GetInteger("code").Value,
-            result.GetString("message"));
+            result.GetInteger("code") ?? 0,
+            result.GetString("message") ?? string.Empty);
         }
         else
         {
@@ -96,7 +95,7 @@ internal static async Task<DiscordChatMessageResult> PostMessage(
           : null as int?;
     }
 
-    private static string GetString(this JsonData data, string key)
+    private static string? GetString(this JsonData data, string key)
     {
       return (data != null && data.Keys.Contains(key))
           ? (string)data[key]

Source/Cake.Discord/Chat/DiscordChatApi.cs

@@ -17,12 +17,12 @@ public sealed class DiscordChatMessageSettings
         /// <summary>
         /// Gets or sets the name of the bot.
         /// </summary>
-        public string UserName { get; set; }
+        public string? UserName { get; set; }
 
         /// <summary>
         /// Gets or sets the URL to an image to use as the avatar for this message.
         /// </summary>
-        public Uri AvatarUrl { get; set; }
+        public Uri? AvatarUrl { get; set; }
 
         /// <summary>
         /// Gets or sets a value indicating whether this message is a

Source/Cake.Discord/Chat/DiscordChatMessageSettings.cs

@@ -1,3 +1,5 @@
+#nullable disable
+#pragma warning disable IDISP001, IDISP004, IDISP008 // vendored LitJson — disposal patterns are not the addin's responsibility
 #pragma warning disable SA1124
 #region Header
 

Source/Cake.Discord/LitJson/IJsonWrapper.cs

@@ -1,3 +1,5 @@
+#nullable disable
+#pragma warning disable IDISP001, IDISP004, IDISP008 // vendored LitJson — disposal patterns are not the addin's responsibility
 #pragma warning disable SA1124
 #region Header
 /*