virtualx-engine/modules/mono/glue/GodotSharp/.editorconfig

# This file should only contain severity override to diagnostics, in order to make generated and
# interop code compilation readable. We want to limit the scope of suppression as much as possible.

[**/Generated/**.cs]
# IDE1006: Naming rule violation
dotnet_diagnostic.IDE1006.severity = none
# CA1062: Validate parameter is non-null before using it
# Useful for generated code, as it disables nullable
dotnet_diagnostic.CA1062.severity = error
# CA1069: Enums should not have duplicate values
dotnet_diagnostic.CA1069.severity = none
# CA1707: Identifiers should not contain underscores
dotnet_diagnostic.CA1707.severity = none
# CA1708: Identifiers should differ by more than case
dotnet_diagnostic.CA1708.severity = none
# CA1711: Identifiers should not have incorrect suffix
# Disable warning for suffixes like EventHandler, Flags, Enum, etc.
dotnet_diagnostic.CA1711.severity = none
# CA1716: Identifiers should not match keywords
# This is suppressed, because it will report `@event` as well as `event`
dotnet_diagnostic.CA1716.severity = none
# CA1720: Identifiers should not contain type names
dotnet_diagnostic.CA1720.severity = none
# CS1591: Missing XML comment for publicly visible type or member
dotnet_diagnostic.CS1591.severity = none
# CS1573: Parameter has no matching param tag in the XML comment
dotnet_diagnostic.CS1573.severity = none
# TODO: Temporary change to not pollute the warnings, but this denotes with ou doc generation
# CS1734: XML comment on '' has a paramref tag for '', but there is no parameter by that name
dotnet_diagnostic.CS1734.severity = none

[GodotSharp/Core/NativeInterop/**.cs]
# CA1720: Identifiers should not contain type names
dotnet_diagnostic.CA1720.severity = none

[GodotSharp/Core/**.cs]
# CS1591: Missing XML comment for publicly visible type or member
# TODO: Temporary change to not pollute the warnings, but we need to document public APIs
dotnet_diagnostic.CS1591.severity = suggestion
Cleanup C# projects, code quality & style New rules: - Do not silence CA1805 any more - Limit where we silence CA1707, CA1711, CA1720 - Enforce severity=warning for IDE0040 - Enforce Allman style braces - Enforce naming conventions (IDE1006 is still severity=suggestion) Fixes: - Fix REFL045, CS1572, CS1573 - Suppress CS0618 when generating `InvokeGodotClassMethod` - Fix indent when generating GD_constants.cs - Temporarily silence CS1734 in generated code - Fix a lot of naming rule violations Misc.: - Remove ReSharper comments for RedundantNameQualifier - Remove suppression attributes for RedundantNameQualifier - Remove severity=warnings for CA1716, CA1304 (already included in the level of analysis we run) 2024-02-19 22:15:37 +01:00			`# This file should only contain severity override to diagnostics, in order to make generated and`
			`# interop code compilation readable. We want to limit the scope of suppression as much as possible.`

C#: Code cleanup and greatly reduce use of C# pointers 2021-12-28 23:25:16 +01:00			`[/Generated/.cs]`
Cleanup C# projects, code quality & style New rules: - Do not silence CA1805 any more - Limit where we silence CA1707, CA1711, CA1720 - Enforce severity=warning for IDE0040 - Enforce Allman style braces - Enforce naming conventions (IDE1006 is still severity=suggestion) Fixes: - Fix REFL045, CS1572, CS1573 - Suppress CS0618 when generating `InvokeGodotClassMethod` - Fix indent when generating GD_constants.cs - Temporarily silence CS1734 in generated code - Fix a lot of naming rule violations Misc.: - Remove ReSharper comments for RedundantNameQualifier - Remove suppression attributes for RedundantNameQualifier - Remove severity=warnings for CA1716, CA1304 (already included in the level of analysis we run) 2024-02-19 22:15:37 +01:00			`# IDE1006: Naming rule violation`
			`dotnet_diagnostic.IDE1006.severity = none`
C#: CS1591 from `none` to `suggestion` 2023-09-19 16:37:02 +02:00			`# CA1062: Validate parameter is non-null before using it`
C#: Code cleanup and greatly reduce use of C# pointers 2021-12-28 23:25:16 +01:00			`# Useful for generated code, as it disables nullable`
			`dotnet_diagnostic.CA1062.severity = error`
			`# CA1069: Enums should not have duplicate values`
			`dotnet_diagnostic.CA1069.severity = none`
Cleanup C# projects, code quality & style New rules: - Do not silence CA1805 any more - Limit where we silence CA1707, CA1711, CA1720 - Enforce severity=warning for IDE0040 - Enforce Allman style braces - Enforce naming conventions (IDE1006 is still severity=suggestion) Fixes: - Fix REFL045, CS1572, CS1573 - Suppress CS0618 when generating `InvokeGodotClassMethod` - Fix indent when generating GD_constants.cs - Temporarily silence CS1734 in generated code - Fix a lot of naming rule violations Misc.: - Remove ReSharper comments for RedundantNameQualifier - Remove suppression attributes for RedundantNameQualifier - Remove severity=warnings for CA1716, CA1304 (already included in the level of analysis we run) 2024-02-19 22:15:37 +01:00			`# CA1707: Identifiers should not contain underscores`
			`dotnet_diagnostic.CA1707.severity = none`
C#: Code cleanup and greatly reduce use of C# pointers 2021-12-28 23:25:16 +01:00			`# CA1708: Identifiers should differ by more than case`
			`dotnet_diagnostic.CA1708.severity = none`
Cleanup C# projects, code quality & style New rules: - Do not silence CA1805 any more - Limit where we silence CA1707, CA1711, CA1720 - Enforce severity=warning for IDE0040 - Enforce Allman style braces - Enforce naming conventions (IDE1006 is still severity=suggestion) Fixes: - Fix REFL045, CS1572, CS1573 - Suppress CS0618 when generating `InvokeGodotClassMethod` - Fix indent when generating GD_constants.cs - Temporarily silence CS1734 in generated code - Fix a lot of naming rule violations Misc.: - Remove ReSharper comments for RedundantNameQualifier - Remove suppression attributes for RedundantNameQualifier - Remove severity=warnings for CA1716, CA1304 (already included in the level of analysis we run) 2024-02-19 22:15:37 +01:00			`# CA1711: Identifiers should not have incorrect suffix`
			`# Disable warning for suffixes like EventHandler, Flags, Enum, etc.`
			`dotnet_diagnostic.CA1711.severity = none`
Clean a bunch of C# warnings - `[Obsolete]` tag generated in the middle of documentation comments - Potential `null` values in generators - Obsolete call to `GetEditorInterface()` - We don't want `Godot.Collections.Array` to end with `Collection` - A few culture specifications and use of `AsSpan` instead of `SubString` in `StringExtensions` - Disable CA1716 in GodotSharp 2024-01-24 00:49:34 +01:00			`# CA1716: Identifiers should not match keywords`
			# This is suppressed, because it will report `@event` as well as `event`
			`dotnet_diagnostic.CA1716.severity = none`
Cleanup C# projects, code quality & style New rules: - Do not silence CA1805 any more - Limit where we silence CA1707, CA1711, CA1720 - Enforce severity=warning for IDE0040 - Enforce Allman style braces - Enforce naming conventions (IDE1006 is still severity=suggestion) Fixes: - Fix REFL045, CS1572, CS1573 - Suppress CS0618 when generating `InvokeGodotClassMethod` - Fix indent when generating GD_constants.cs - Temporarily silence CS1734 in generated code - Fix a lot of naming rule violations Misc.: - Remove ReSharper comments for RedundantNameQualifier - Remove suppression attributes for RedundantNameQualifier - Remove severity=warnings for CA1716, CA1304 (already included in the level of analysis we run) 2024-02-19 22:15:37 +01:00			`# CA1720: Identifiers should not contain type names`
			`dotnet_diagnostic.CA1720.severity = none`
C# - bindings_generator warnings to .editorconfig 2023-09-15 19:50:40 +02:00			`# CS1591: Missing XML comment for publicly visible type or member`
			`dotnet_diagnostic.CS1591.severity = none`
			`# CS1573: Parameter has no matching param tag in the XML comment`
			`dotnet_diagnostic.CS1573.severity = none`
Cleanup C# projects, code quality & style New rules: - Do not silence CA1805 any more - Limit where we silence CA1707, CA1711, CA1720 - Enforce severity=warning for IDE0040 - Enforce Allman style braces - Enforce naming conventions (IDE1006 is still severity=suggestion) Fixes: - Fix REFL045, CS1572, CS1573 - Suppress CS0618 when generating `InvokeGodotClassMethod` - Fix indent when generating GD_constants.cs - Temporarily silence CS1734 in generated code - Fix a lot of naming rule violations Misc.: - Remove ReSharper comments for RedundantNameQualifier - Remove suppression attributes for RedundantNameQualifier - Remove severity=warnings for CA1716, CA1304 (already included in the level of analysis we run) 2024-02-19 22:15:37 +01:00			`# TODO: Temporary change to not pollute the warnings, but this denotes with ou doc generation`
			`# CS1734: XML comment on '' has a paramref tag for '', but there is no parameter by that name`
			`dotnet_diagnostic.CS1734.severity = none`

			`[GodotSharp/Core/NativeInterop/**.cs]`
			`# CA1720: Identifiers should not contain type names`
			`dotnet_diagnostic.CA1720.severity = none`
C#: CS1591 from `none` to `suggestion` 2023-09-19 16:37:02 +02:00
			`[GodotSharp/Core/**.cs]`
			`# CS1591: Missing XML comment for publicly visible type or member`
			`# TODO: Temporary change to not pollute the warnings, but we need to document public APIs`
			`dotnet_diagnostic.CS1591.severity = suggestion`