Merge pull request #37 from jellyfin/analyzer

.editorconfig

@@ -5,7 +5,6 @@
 # Core EditorConfig Options   #
 ###############################
 root = true
-
 # All files
 [*]
 indent_style = space
@@ -14,7 +13,7 @@ charset = utf-8
 trim_trailing_whitespace = true
 insert_final_newline = true
 end_of_line = lf
-max_line_length = 9999
+max_line_length = off
 
 # YAML indentation
 [*.{yml,yaml}]
@@ -27,7 +26,6 @@ indent_size = 2
 ###############################
 # .NET Coding Conventions     #
 ###############################
-
 [*.{cs,vb}]
 # Organize usings
 dotnet_sort_system_directives_first = true
@@ -63,7 +61,6 @@ dotnet_style_prefer_conditional_expression_over_return = true:silent
 ###############################
 # Naming Conventions          #
 ###############################
-
 # Style Definitions (From Roslyn)
 
 # Non-private static fields are PascalCase
@@ -138,7 +135,6 @@ dotnet_naming_style.pascal_case_style.capitalization = pascal_case
 ###############################
 # C# Coding Conventions       #
 ###############################
-
 [*.cs]
 # var preferences
 csharp_style_var_for_built_in_types = true:silent
@@ -169,7 +165,6 @@ csharp_style_inlined_variable_declaration = true:suggestion
 ###############################
 # C# Formatting Rules         #
 ###############################
-
 # New line preferences
 csharp_new_line_before_open_brace = all
 csharp_new_line_before_else = true

.github/dependabot.yml

@@ -1,26 +1,29 @@
 version: 2
 updates:
   # Fetch and update latest `nuget` pkgs
-  - package-ecosystem: "nuget"
+  - package-ecosystem: nuget
-    directory: "/"
+    directory: /
     schedule:
-      interval: "daily"
+      interval: weekly
-      time: "00:00"
     open-pull-requests-limit: 10
+    labels:
+      - chore
+      - dependency
+      - nuget
     commit-message:
-      prefix: "chore"
+      prefix: chore
-      include: "scope"
+      include: scope
 
   # Fetch and update latest `github-actions` pkgs
-  - package-ecosystem: "github-actions"
+  - package-ecosystem: github-actions
-    directory: "/"
+    directory: /
     schedule:
-      interval: "weekly"
+      interval: monthly
-      time: "00:00"
-    labels:
-      - "skip-changelog"
     open-pull-requests-limit: 10
+    labels:
+      - ci
+      - dependency
+      - github_actions
     commit-message:
-      prefix: "ci"
+      prefix: ci
-      include: "scope"
+      include: scope
-

.github/workflows/build-dotnet.yml

@@ -1,10 +1,14 @@
-name: Test Build Plugin
+name: Build Plugin
 
 on:
   push:
     branches: [ master ]
+    paths-ignore:
+      - '**/*.md'
   pull_request:
     branches: [ master ]
+    paths-ignore:
+      - '**/*.md'
 
 jobs:
   build:
@@ -12,16 +16,21 @@ jobs:
     steps:
       - uses: actions/checkout@v2
 
-      - name: "Setup .NET Core"
+      - name: Setup .NET
         uses: actions/setup-dotnet@v1
         with:
-          dotnet-version: "5.0.x"
+          dotnet-version: 6.0.x
 
-      - name: "Install dependencies"
+      - name: Build Jellyfin Plugin
-        run: dotnet restore
+        uses: oddstr13/jellyfin-plugin-repository-manager@v0.4.2
+        id: jprm
+        with:
+            dotnet-target: net6.0
 
-      - name: "Build"
+      - name: Upload Artifact
-        run: dotnet build --configuration Release --no-restore
+        uses: actions/upload-artifact@v2
-
+        with:
-      - name: "Test"
+          name: build-artifact
-        run: dotnet test --no-restore --verbosity normal
+          retention-days: 30
+          if-no-files-found: error
+          path: ${{ steps.jprm.outputs.artifact }}

.github/workflows/codeql-analysis.yml

@@ -3,8 +3,12 @@ name: Run CodeQL
 on:
   push:
     branches: [ master ]
+    paths-ignore:
+      - '**/*.md'
   pull_request:
     branches: [ master ]
+    paths-ignore:
+      - '**/*.md'
   schedule:
     - cron: '24 2 * * 4'
 
@@ -12,6 +16,7 @@ jobs:
   analyze:
     name: Analyze
     runs-on: ubuntu-latest
+    if: github.repository == 'jellyfin/jellyfin-plugin-template'
 
     strategy:
       fail-fast: false
@@ -25,7 +30,7 @@ jobs:
       - name: Setup .NET Core
         uses: actions/setup-dotnet@v1
         with:
-          dotnet-version: 5.0.x
+          dotnet-version: 6.0.x
 
       - name: Initialize CodeQL
         uses: github/codeql-action/init@v1

.github/workflows/test-dotnet.yml

@@ -0,0 +1,31 @@
+name: Test Plugin
+
+on:
+  push:
+    branches: [ master ]
+    paths-ignore:
+      - '**/*.md'
+  pull_request:
+    branches: [ master ]
+    paths-ignore:
+      - '**/*.md'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Setup .NET Core
+        uses: actions/setup-dotnet@v1
+        with:
+          dotnet-version: 6.0.x
+
+      - name: Install dependencies
+        run: dotnet restore
+
+      - name: Build
+        run: dotnet build --configuration Release --no-restore
+
+      - name: Test
+        run: dotnet test --no-restore --verbosity normal

.gitignore

@@ -1,3 +1,5 @@
 bin/
 obj/
 .vs/
+.idea/
+artifacts

Jellyfin.Plugin.Template/Configuration/PluginConfiguration.cs

@@ -1,21 +1,31 @@
 using MediaBrowser.Model.Plugins;
 
-namespace Jellyfin.Plugin.Template.Configuration
+namespace Jellyfin.Plugin.Template.Configuration;
+
+/// <summary>
+/// The configuration options.
+/// </summary>
+public enum SomeOptions
 {
-    public enum SomeOptions
+    /// <summary>
-    {
+    /// Option one.
+    /// </summary>
     OneOption,
+
+    /// <summary>
+    /// Second option.
+    /// </summary>
     AnotherOption
-    }
+}
-
-    public class PluginConfiguration : BasePluginConfiguration
-    {
-        // store configurable settings your plugin might need
-        public bool TrueFalseSetting { get; set; }
-        public int AnInteger { get; set; }
-        public string AString { get; set; }
-        public SomeOptions Options { get; set; }
 
+/// <summary>
+/// Plugin configuration.
+/// </summary>
+public class PluginConfiguration : BasePluginConfiguration
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="PluginConfiguration"/> class.
+    /// </summary>
     public PluginConfiguration()
     {
         // set default options here
@@ -24,5 +34,24 @@ namespace Jellyfin.Plugin.Template.Configuration
         AnInteger = 2;
         AString = "string";
     }
-    }
+
+    /// <summary>
+    /// Gets or sets a value indicating whether some true or false setting is enabled..
+    /// </summary>
+    public bool TrueFalseSetting { get; set; }
+
+    /// <summary>
+    /// Gets or sets an integer setting.
+    /// </summary>
+    public int AnInteger { get; set; }
+
+    /// <summary>
+    /// Gets or sets a string setting.
+    /// </summary>
+    public string AString { get; set; }
+
+    /// <summary>
+    /// Gets or sets an enum option.
+    /// </summary>
+    public SomeOptions Options { get; set; }
 }

Jellyfin.Plugin.Template/Jellyfin.Plugin.Template.csproj

@@ -1,15 +1,23 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFramework>net5.0</TargetFramework>
+    <TargetFramework>net6.0</TargetFramework>
     <RootNamespace>Jellyfin.Plugin.Template</RootNamespace>
     <AssemblyVersion>1.0.0.0</AssemblyVersion>
     <FileVersion>1.0.0.0</FileVersion>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
+    <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
+    <Nullable>enable</Nullable>
+    <AnalysisMode>AllEnabledByDefault</AnalysisMode>
+    <CodeAnalysisRuleSet>../jellyfin.ruleset</CodeAnalysisRuleSet>
   </PropertyGroup>
 
   <ItemGroup>
     <PackageReference Include="Jellyfin.Controller" Version="10.*-*" />
     <PackageReference Include="Jellyfin.Model" Version="10.*-*" />
+    <PackageReference Include="SerilogAnalyzer" Version="0.15.0" PrivateAssets="All" />
+    <PackageReference Include="StyleCop.Analyzers" Version="1.2.0-beta.376" PrivateAssets="All" />
+    <PackageReference Include="SmartAnalyzers.MultithreadingAnalyzer" Version="1.1.31" PrivateAssets="All" />
   </ItemGroup>
 
   <ItemGroup>

Jellyfin.Plugin.Template/Plugin.cs

@@ -1,26 +1,42 @@
 using System;
 using System.Collections.Generic;
+using System.Globalization;
 using Jellyfin.Plugin.Template.Configuration;
 using MediaBrowser.Common.Configuration;
 using MediaBrowser.Common.Plugins;
 using MediaBrowser.Model.Plugins;
 using MediaBrowser.Model.Serialization;
 
-namespace Jellyfin.Plugin.Template
+namespace Jellyfin.Plugin.Template;
+
+/// <summary>
+/// The main plugin.
+/// </summary>
+public class Plugin : BasePlugin<PluginConfiguration>, IHasWebPages
 {
-    public class Plugin : BasePlugin<PluginConfiguration>, IHasWebPages
+    /// <summary>
-    {
+    /// Initializes a new instance of the <see cref="Plugin"/> class.
-        public override string Name => "Template";
+    /// </summary>
-
+    /// <param name="applicationPaths">Instance of the <see cref="IApplicationPaths"/> interface.</param>
-        public override Guid Id => Guid.Parse("eb5d7894-8eef-4b36-aa6f-5d124e828ce1");
+    /// <param name="xmlSerializer">Instance of the <see cref="IXmlSerializer"/> interface.</param>
-
+    public Plugin(IApplicationPaths applicationPaths, IXmlSerializer xmlSerializer)
-        public Plugin(IApplicationPaths applicationPaths, IXmlSerializer xmlSerializer) : base(applicationPaths, xmlSerializer)
+        : base(applicationPaths, xmlSerializer)
     {
         Instance = this;
     }
 
-        public static Plugin Instance { get; private set; }
+    /// <inheritdoc />
+    public override string Name => "Template";
 
+    /// <inheritdoc />
+    public override Guid Id => Guid.Parse("eb5d7894-8eef-4b36-aa6f-5d124e828ce1");
+
+    /// <summary>
+    /// Gets the current plugin instance.
+    /// </summary>
+    public static Plugin? Instance { get; private set; }
+
+    /// <inheritdoc />
     public IEnumerable<PluginPageInfo> GetPages()
     {
         return new[]
@@ -28,9 +44,8 @@ namespace Jellyfin.Plugin.Template
             new PluginPageInfo
             {
                 Name = this.Name,
-                    EmbeddedResourcePath = string.Format("{0}.Configuration.configPage.html", GetType().Namespace)
+                EmbeddedResourcePath = string.Format(CultureInfo.InvariantCulture, "{0}.Configuration.configPage.html", GetType().Namespace)
             }
         };
     }
-    }
 }

jellyfin.ruleset

@@ -0,0 +1,108 @@
+<?xml version="1.0" encoding="utf-8"?>
+<RuleSet Name="Rules for Jellyfin.Server" Description="Code analysis rules for Jellyfin.Server.csproj" ToolsVersion="14.0">
+    <Rules AnalyzerId="StyleCop.Analyzers" RuleNamespace="StyleCop.Analyzers">
+        <!-- disable warning SA1009: Closing parenthesis should be followed by a space. -->
+        <Rule Id="SA1009" Action="None" />
+        <!-- disable warning SA1011: Closing square bracket should be followed by a space. -->
+        <Rule Id="SA1011" Action="None" />
+        <!-- disable warning SA1101: Prefix local calls with 'this.' -->
+        <Rule Id="SA1101" Action="None" />
+        <!-- disable warning SA1108: Block statements should not contain embedded comments -->
+        <Rule Id="SA1108" Action="None" />
+        <!-- disable warning SA1118: Parameter must not span multiple lines. -->
+        <Rule Id="SA1118" Action="None" />
+        <!-- disable warning SA1128:: Put constructor initializers on their own line -->
+        <Rule Id="SA1128" Action="None" />
+        <!-- disable warning SA1130: Use lambda syntax -->
+        <Rule Id="SA1130" Action="None" />
+        <!-- disable warning SA1200: 'using' directive must appear within a namespace declaration -->
+        <Rule Id="SA1200" Action="None" />
+        <!-- disable warning SA1202: 'public' members must come before 'private' members -->
+        <Rule Id="SA1202" Action="None" />
+        <!-- disable warning SA1204: Static members must appear before non-static members -->
+        <Rule Id="SA1204" Action="None" />
+        <!-- disable warning SA1309: Fields must not begin with an underscore -->
+        <Rule Id="SA1309" Action="None" />
+        <!-- disable warning SA1413: Use trailing comma in multi-line initializers -->
+        <Rule Id="SA1413" Action="None" />
+        <!-- disable warning SA1512: Single-line comments must not be followed by blank line -->
+        <Rule Id="SA1512" Action="None" />
+        <!-- disable warning SA1515: Single-line comment should be preceded by blank line -->
+        <Rule Id="SA1515" Action="None" />
+        <!-- disable warning SA1600: Elements should be documented -->
+        <Rule Id="SA1600" Action="None" />
+        <!-- disable warning SA1602: Enumeration items should be documented -->
+        <Rule Id="SA1602" Action="None" />
+        <!-- disable warning SA1633: The file header is missing or not located at the top of the file -->
+        <Rule Id="SA1633" Action="None" />
+    </Rules>
+
+    <Rules AnalyzerId="Microsoft.CodeAnalysis.NetAnalyzers" RuleNamespace="Microsoft.Design">
+        <!-- error on CA1305: Specify IFormatProvider -->
+        <Rule Id="CA1305" Action="Error" />
+        <!-- error on CA1725: Parameter names should match base declaration -->
+        <Rule Id="CA1725" Action="Error" />
+        <!-- error on CA1725: Call async methods when in an async method -->
+        <Rule Id="CA1727" Action="Error" />
+        <!-- error on CA1843: Do not use 'WaitAll' with a single task -->
+        <Rule Id="CA1843" Action="Error" />
+        <!-- error on CA2016: Forward the CancellationToken parameter to methods that take one
+            or pass in 'CancellationToken.None' explicitly to indicate intentionally not propagating the token -->
+        <Rule Id="CA2016" Action="Error" />
+        <!-- error on CA2254: Template should be a static expression -->
+        <Rule Id="CA2254" Action="Error" />
+
+        <!-- disable warning CA1014: Mark assemblies with CLSCompliantAttribute -->
+        <Rule Id="CA1014" Action="Info" />
+        <!-- disable warning CA1024: Use properties where appropriate -->
+        <Rule Id="CA1024" Action="Info" />
+        <!-- disable warning CA1031: Do not catch general exception types -->
+        <Rule Id="CA1031" Action="Info" />
+        <!-- disable warning CA1032: Implement standard exception constructors -->
+        <Rule Id="CA1032" Action="Info" />
+        <!-- disable warning CA1040: Avoid empty interfaces -->
+        <Rule Id="CA1040" Action="Info" />
+        <!-- disable warning CA1062: Validate arguments of public methods -->
+        <Rule Id="CA1062" Action="Info" />
+        <!-- TODO: enable when false positives are fixed -->
+        <!-- disable warning CA1508: Avoid dead conditional code -->
+        <Rule Id="CA1508" Action="Info" />
+        <!-- disable warning CA1716: Identifiers should not match keywords -->
+        <Rule Id="CA1716" Action="Info" />
+        <!-- disable warning CA1720: Identifiers should not contain type names -->
+        <Rule Id="CA1720" Action="Info" />
+        <!-- disable warning CA1724: Type names should not match namespaces -->
+        <Rule Id="CA1724" Action="Info" />
+        <!-- disable warning CA1805: Do not initialize unnecessarily -->
+        <Rule Id="CA1805" Action="Info" />
+        <!-- disable warning CA1812: internal class that is apparently never instantiated.
+            If so, remove the code from the assembly.
+            If this class is intended to contain only static members, make it static -->
+        <Rule Id="CA1812" Action="Info" />
+        <!-- disable warning CA1822: Member does not access instance data and can be marked as static -->
+        <Rule Id="CA1822" Action="Info" />
+        <!-- disable warning CA2000: Dispose objects before losing scope -->
+        <Rule Id="CA2000" Action="Info" />
+        <!-- disable warning CA2253: Named placeholders should not be numeric values -->
+        <Rule Id="CA2253" Action="Info" />
+        <!-- disable warning CA5394: Do not use insecure randomness -->
+        <Rule Id="CA5394" Action="Info" />
+
+        <!-- disable warning CA1054: Change the type of parameter url from string to System.Uri -->
+        <Rule Id="CA1054" Action="None" />
+        <!-- disable warning CA1055: URI return values should not be strings -->
+        <Rule Id="CA1055" Action="None" />
+        <!-- disable warning CA1056: URI properties should not be strings -->
+        <Rule Id="CA1056" Action="None" />
+        <!-- disable warning CA1303: Do not pass literals as localized parameters -->
+        <Rule Id="CA1303" Action="None" />
+        <!-- disable warning CA1308: Normalize strings to uppercase -->
+        <Rule Id="CA1308" Action="None" />
+        <!-- disable warning CA1848: Use the LoggerMessage delegates -->
+        <Rule Id="CA1848" Action="None" />
+        <!-- disable warning CA2101: Specify marshaling for P/Invoke string arguments -->
+        <Rule Id="CA2101" Action="None" />
+        <!-- disable warning CA2234: Pass System.Uri objects instead of strings -->
+        <Rule Id="CA2234" Action="None" />
+    </Rules>
+</RuleSet>