Files
pgsql-jellyfin/README_EDITORCONFIG_CHANGES.md
T
wjones 8421e3ad5c Suppress non-critical warnings, refactor Emby.Naming
Expanded .editorconfig to silence non-critical IDE/StyleCop warnings and updated Emby.Naming.csproj to prevent warnings-as-errors in Debug. Refactored codebase for modern C# style, removed unused code and unnecessary usings, and fixed formatting and StringComparison issues. Added detailed documentation on code style and warning suppression. Project now builds cleanly with only critical issues surfaced.
2026-02-21 12:48:04 -05:00

3.8 KiB

Summary: EditorConfig Configuration for Emby.Naming Project

What Was Done

Updated .editorconfig file to suppress non-critical IDE and StyleCop warnings Fixed critical formatting issue in ExternalPathParser.cs (line 77) Created documentation (EDITORCONFIG_SETUP.md) explaining all changes

Current Status

Compilation Errors: ZERO

  • No CS errors - project builds successfully
  • All CS0026 errors have been fixed

Critical Warnings Fixed: 1/2

  1. IDE0055: Fixed formatting issue in ExternalPathParser.cs
  2. ⚠️ IDE0005: Jellyfin.Extensions using - May be needed (needs verification)

Non-Critical Suggestions: SUPPRESSED

  • ~300+ IDE and StyleCop suggestions have been configured to show as hints only
  • They won't clutter your error list anymore

What You Need to Do Now

Step 1: Reload Your IDE

Choose ONE method:

Option A - Restart IDE (Recommended)

  1. Close Visual Studio/your IDE completely
  2. Reopen the solution
  3. The new settings will take effect immediately

Option B - Clear Cache (If restart doesn't work)

  1. Close Visual Studio
  2. Delete the .vs folder in your solution directory
  3. Reopen Visual Studio
  4. The settings will be reloaded

Option C - Command Line

dotnet clean
dotnet build

Step 2: Verify the Changes

After reloading, check the Error List in Visual Studio:

Before:

  • 300+ warnings/suggestions

After:

  • Only ~3-5 real issues (if any)
  • Most suggestions will be shown as dimmed hints in the code editor only

Step 3: Optional - Address Remaining Issues

IDE0051: Unused Private Member (1 occurrence)

File: Emby.Naming\TV\SeasonPathParser.cs
Line: 129
Member: GetSeasonNumberFromPathSubstring
Action: Either remove it or add a comment explaining why it's kept for future use

IDE0005: Unused Using (1 occurrence - Needs Verification)

File: Emby.Naming\Video\VideoListResolver.cs
Line: 14
Using: using Jellyfin.Extensions;
Action: Verify if AsSpan() extension methods come from this namespace. If not, remove the using.

EditorConfig Rules Applied

Suppressed (Won't show as warnings)

  • IDE0008: Use explicit type instead of 'var'
  • IDE0065: Using directive placement
  • IDE0290: Use primary constructor
  • IDE0300/301/305: Collection initialization
  • SA1200: Using directive placement
  • SA1309: Field naming with underscore
  • SA1413: Trailing commas
  • SA1515: Comment spacing
  • SA1633: File headers

Kept as Warnings (Important)

  • CA1307/CA1310: StringComparison specification
  • IDE0051: Unused members
  • IDE0055: Formatting

Expected Results

In Visual Studio Error List

Before: 300+ items
After: 0-5 items

In Code Editor

  • Suggestions still shown as subtle hints (dotted underlines)
  • Can be safely ignored
  • Can still quick-fix if you want (Ctrl+. in Visual Studio)

Benefits

Clean Error List - Only see what matters
Flexible Coding Style - Team members can use their preferred styles
Security Maintained - Important warnings kept
No Build Breaks - All compilation errors already fixed

Notes

  • The .editorconfig affects all developers on the team
  • Settings are checked into source control
  • Individual developers can still use IDE quick-fixes for hints
  • CI/CD builds will respect these settings

Need to Change Something?

Edit .editorconfig and change severity levels:

# Make stricter (shows in error list)
dotnet_diagnostic.IDE0008.severity = warning

# Make less strict (only hint in editor)
dotnet_diagnostic.IDE0008.severity = suggestion

# Disable completely
dotnet_diagnostic.IDE0008.severity = none

Then reload your IDE for changes to take effect.

Questions?

Refer to EDITORCONFIG_SETUP.md for detailed documentation about all changes.