Style code quality

Usage

This recipe has no required configuration options. You’ll need the Moderne CLI configured before running the command below.

mod run . --recipe OpenRewrite.Recipes.CSharp.CodeQuality.Style.StyleCodeQuality

If the recipe isn’t available locally, install it with:

mod config recipes nuget install OpenRewrite.Recipes.CSharp.CodeQuality

Definition

This recipe runs the following recipes in order.

• Use EventArgs.EmptyOpenRewrite.Recipes.CSharp.CodeQuality.Style.UseEventArgsEmpty
• Place constant values on right side of comparisonsOpenRewrite.Recipes.CSharp.CodeQuality.Style.ConstantValuesOnRightSide
• Use string.Length instead of comparison with empty stringOpenRewrite.Recipes.CSharp.CodeQuality.Style.UseStringLengthComparison
• Use pattern matching for null checkOpenRewrite.Recipes.CSharp.CodeQuality.Simplification.UsePatternMatchingNullCheck
• Use string.IsNullOrEmpty methodOpenRewrite.Recipes.CSharp.CodeQuality.Style.UseStringIsNullOrEmpty
• Use string.Contains instead of IndexOf comparisonOpenRewrite.Recipes.CSharp.CodeQuality.Style.UseStringContains
• Simplify boolean logic with constantsOpenRewrite.Recipes.CSharp.CodeQuality.Style.SimplifyBooleanLogic
• Prefer null check over type checkOpenRewrite.Recipes.CSharp.CodeQuality.Style.PreferNullCheckOverTypeCheck
• Use explicit type instead of varOpenRewrite.Recipes.CSharp.CodeQuality.Style.UseExplicitTypeInsteadOfVar
• Use method group conversionOpenRewrite.Recipes.CSharp.CodeQuality.Style.UseMethodGroupConversion
• Use collection expressionOpenRewrite.Recipes.CSharp.CodeQuality.Style.UseCollectionExpression
• Use file-scoped namespaceOpenRewrite.Recipes.CSharp.CodeQuality.Style.UseFileScopedNamespace
• Use primary constructorOpenRewrite.Recipes.CSharp.CodeQuality.Style.UsePrimaryConstructor
• Make class sealedOpenRewrite.Recipes.CSharp.CodeQuality.Style.MakeClassSealed
• Make field read-onlyOpenRewrite.Recipes.CSharp.CodeQuality.Style.MakeFieldReadOnly
• Use auto propertyOpenRewrite.Recipes.CSharp.CodeQuality.Style.UseAutoProperty
• Mark local variable as constOpenRewrite.Recipes.CSharp.CodeQuality.Style.MarkLocalVariableAsConst
• Use read-only auto propertyOpenRewrite.Recipes.CSharp.CodeQuality.Style.UseReadOnlyAutoProperty
• Default label should be lastOpenRewrite.Recipes.CSharp.CodeQuality.Style.DefaultLabelShouldBeLast
• Make class staticOpenRewrite.Recipes.CSharp.CodeQuality.Style.MakeClassStatic
• Avoid nested ternary operatorOpenRewrite.Recipes.CSharp.CodeQuality.Style.AvoidNestingTernary
• Use element accessOpenRewrite.Recipes.CSharp.CodeQuality.Style.UseElementAccess
• Sort enum membersOpenRewrite.Recipes.CSharp.CodeQuality.Style.SortEnumMembers
• Abstract type should not have public constructorsOpenRewrite.Recipes.CSharp.CodeQuality.Style.AbstractTypeShouldNotHavePublicConstructors
• Declare each attribute separatelyOpenRewrite.Recipes.CSharp.CodeQuality.Style.DeclareEachAttributeSeparately
• Use method chainingOpenRewrite.Recipes.CSharp.CodeQuality.Style.UseMethodChaining
• Use using declarationOpenRewrite.Recipes.CSharp.CodeQuality.Style.UseUsingDeclaration
• Avoid chain of assignmentsOpenRewrite.Recipes.CSharp.CodeQuality.Style.AvoidChainOfAssignments
• Implement exception constructorsOpenRewrite.Recipes.CSharp.CodeQuality.Style.ImplementExceptionConstructors
• Use AttributeUsageAttributeOpenRewrite.Recipes.CSharp.CodeQuality.Style.UseAttributeUsageAttribute
• Value type is never equal to nullOpenRewrite.Recipes.CSharp.CodeQuality.Style.ValueTypeIsNeverEqualToNull
• Split variable declarationOpenRewrite.Recipes.CSharp.CodeQuality.Style.SplitVariableDeclaration
• Remove unused parameterOpenRewrite.Recipes.CSharp.CodeQuality.Style.UnusedParameter
• Remove unused type parameterOpenRewrite.Recipes.CSharp.CodeQuality.Style.UnusedTypeParameter
• Parameter name differs from baseOpenRewrite.Recipes.CSharp.CodeQuality.Style.ParameterNameDiffersFromBase
• Use constant instead of fieldOpenRewrite.Recipes.CSharp.CodeQuality.Style.UseConstantInsteadOfField
• Call extension method as instance methodOpenRewrite.Recipes.CSharp.CodeQuality.Style.CallExtensionMethodAsInstance
• Order named arguments by parametersOpenRewrite.Recipes.CSharp.CodeQuality.Style.OrderNamedArguments
• Order type parameter constraintsOpenRewrite.Recipes.CSharp.CodeQuality.Style.OrderTypeParameterConstraints
• Flag duplicate enum valueOpenRewrite.Recipes.CSharp.CodeQuality.Style.DuplicateEnumValue
• Use EventHandler<T>OpenRewrite.Recipes.CSharp.CodeQuality.Style.UseEventHandlerT
• Declare enum value as combination of namesOpenRewrite.Recipes.CSharp.CodeQuality.Style.DeclareEnumValueAsCombination
• Add static modifier to all members of static classOpenRewrite.Recipes.CSharp.CodeQuality.Style.AddStaticToMembersOfStaticClass
• Normalize format of enum flag valueOpenRewrite.Recipes.CSharp.CodeQuality.Style.NormalizeEnumFlagValue
• Use coalesce expressionOpenRewrite.Recipes.CSharp.CodeQuality.Style.UseCoalesceExpressionFromNullCheck
• Declare enum member with zero valueOpenRewrite.Recipes.CSharp.CodeQuality.Style.DeclareEnumMemberWithZeroValue
• Use async/await when necessaryOpenRewrite.Recipes.CSharp.CodeQuality.Style.UseAsyncAwait
• Implement non-generic counterpartOpenRewrite.Recipes.CSharp.CodeQuality.Style.ImplementNonGenericCounterpart
• Fix invalid argument null checkOpenRewrite.Recipes.CSharp.CodeQuality.Style.InvalidArgumentNullCheck
• Use enum field explicitlyOpenRewrite.Recipes.CSharp.CodeQuality.Style.UseEnumFieldExplicitly
• Use var instead of explicit type in foreachOpenRewrite.Recipes.CSharp.CodeQuality.Style.UseVarInForEach
• Use explicitly typed arrayOpenRewrite.Recipes.CSharp.CodeQuality.Style.UseExplicitlyTypedArray
• Add parentheses to conditional expression conditionOpenRewrite.Recipes.CSharp.CodeQuality.Style.AddParenthesesToConditionalExpression
• Declare each type in separate fileOpenRewrite.Recipes.CSharp.CodeQuality.Style.DeclareEachTypeInSeparateFile
• Declare using directive on top levelOpenRewrite.Recipes.CSharp.CodeQuality.Style.DeclareUsingDirectiveOnTopLevel
• Add parentheses for clarityOpenRewrite.Recipes.CSharp.CodeQuality.Style.AddParenthesesForClarity
• Composite enum value contains undefined flagOpenRewrite.Recipes.CSharp.CodeQuality.Style.CompositeEnumContainsUndefinedFlag
• Static member in generic type should use a type parameterOpenRewrite.Recipes.CSharp.CodeQuality.Style.StaticMemberInGenericType
• Convert comment to documentation commentOpenRewrite.Recipes.CSharp.CodeQuality.Style.ConvertCommentToDocComment
• Overriding member should not change 'params' modifierOpenRewrite.Recipes.CSharp.CodeQuality.Style.OverridingMemberShouldNotChangeParams
• Merge preprocessor directivesOpenRewrite.Recipes.CSharp.CodeQuality.Style.MergePreprocessorDirectives
• Mark type with DebuggerDisplay attributeOpenRewrite.Recipes.CSharp.CodeQuality.Style.MarkTypeWithDebuggerDisplay
• Make method an extension methodOpenRewrite.Recipes.CSharp.CodeQuality.Style.MakeMethodExtensionMethod
• Duplicate word in a commentOpenRewrite.Recipes.CSharp.CodeQuality.Style.DuplicateWordInComment
• Use EventArgs.Empty instead of nullOpenRewrite.Recipes.CSharp.CodeQuality.Style.UseEventArgsEmptyForNull
• Use 'this' for event senderOpenRewrite.Recipes.CSharp.CodeQuality.Style.UseThisForEventSender
• Find missing string equality comparerOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindMissingStringEqualityComparer
• Obsolete attribute should include explanationOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindObsoleteWithoutMessage
• Do not raise reserved exception typesOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindDoNotRaiseReservedExceptionType
• Do not throw from finally blockOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindDoNotThrowFromFinallyBlock
• Embed caught exception as inner exceptionOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindEmbedCaughtExceptionAsInner
• Do not raise ApplicationExceptionOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindDoNotRaiseApplicationException
• Types should not extend ApplicationExceptionOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindTypeShouldNotExtendApplicationException
• Do not use ThreadStatic on instance fieldsOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindThreadStaticOnInstanceField
• Do not use dangerous threading methodsOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindDangerousThreadingMethods
• Do not write custom certificate validationOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindDoNotUseCertificateValidationCallback
• Do not use anonymous delegates to unsubscribe from eventsOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindAvoidAnonymousDelegateForUnsubscribe
• Use System.Threading.Lock instead of object for lockingOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindUseSystemThreadingLock
• ArgumentException should specify argument nameOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindArgumentExceptionParameterName
• Do not throw NotImplementedExceptionOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindDoNotRaiseNotImplementedException
• Use OperatingSystem methods instead of RuntimeInformationOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindUseOperatingSystemMethods
• Non-constant static fields should not be visibleOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindNonConstantStaticFieldsVisible
• Find class with Equals(T) but no IEquatable<T>OpenRewrite.Recipes.CSharp.CodeQuality.Style.FindClassWithEqualsButNoIEquatable
• Find non-deterministic end-of-line in stringsOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindNonDeterministicEndOfLine
• Parenthesize not pattern for clarityOpenRewrite.Recipes.CSharp.CodeQuality.Style.ParenthesizeNotPattern
• Find overrides that change parameter defaultsOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindOverrideChangesParameterDefaults
• Find boolean literal arguments without parameter nameOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindMissingNamedParameter
• Find redundant default argument valuesOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindRedundantArgumentValue
• Find ILogger<T> type parameter mismatchOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindILoggerTypeMismatch
• Find multi-line XML doc commentsOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindMultiLineXmlComment
• Use 'var' or explicit typeOpenRewrite.Recipes.CSharp.CodeQuality.Style.UseVarOrExplicitType
• Find binary expression with identical sidesOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindBothConditionSidesIdentical
• Find throw statements in finalizerOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindDoNotThrowFromFinalizer
• Find async void delegateOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindAsyncVoidDelegate
• Find unawaited task return in using blockOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindAwaitTaskBeforeDisposing
• Find CompareTo without IComparableOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindCompareToWithoutIComparable
• Find [DefaultParameterValue] without [Optional]OpenRewrite.Recipes.CSharp.CodeQuality.Style.FindDefaultParameterValueNeedsOptional
• Find virtual method call in constructorOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindDoNotCallVirtualMethodInConstructor
• Find comparison with NaNOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindDoNotCompareWithNaN
• Find type with BCL nameOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindDoNotCreateTypeWithBCLName
• Find static members on generic typesOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindDoNotDeclareStaticMembersOnGenericTypes
• Find overwritten parameter valuesOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindDoNotOverwriteParameterValue
• Find EqualityComparer<string>.DefaultOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindDoNotUseEqualityComparerDefaultOfString
• Find ToString on object-typed parameterOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindDoNotUseObjectToString
• Find string.GetHashCode() usageOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindDoNotUseStringGetHashCode
• Find Equals without [NotNullWhen(true)]OpenRewrite.Recipes.CSharp.CodeQuality.Style.FindEqualsWithoutNotNullWhen
• Find event raised with null EventArgsOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindEventArgsSenderNotNull
• Find await foreach without CancellationTokenOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindFlowCancellationTokenInAwaitForEach
• Find IComparable without comparison operatorsOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindIComparableWithoutComparisonOperators
• Find IComparable<T> without IEquatable<T>OpenRewrite.Recipes.CSharp.CodeQuality.Style.FindIComparableWithoutIEquatable
• Find IEquatable<T> without Equals(object) overrideOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindIEquatableWithoutEquals
• Find implicit culture-sensitive ToString in concatenationOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindImplicitCultureSensitiveToStringDirect
• Find implicit DateTime to DateTimeOffset conversionOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindImplicitDateTimeOffsetConversion
• Find interpolated string without parametersOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindInterpolatedStringWithoutParameters
• Find potentially invalid attribute argument typeOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindInvalidAttributeArgumentType
• Find method that is too longOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindMethodTooLong
• Find async call missing CancellationTokenOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindMissingCancellationTokenOverload
• Add trailing commaOpenRewrite.Recipes.CSharp.CodeQuality.Style.AddTrailingComma
• Find override method missing params keywordOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindMissingParamsInOverride
• Find string method missing StringComparisonOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindMissingStringComparison
• Find non-flags enum with [Flags]OpenRewrite.Recipes.CSharp.CodeQuality.Style.FindNonFlagsEnumWithFlagsAttribute
• Find unobserved async call resultOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindObserveAsyncResult
• Find concrete collection in public APIOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindPreferCollectionAbstraction
• Find raw string with implicit end of lineOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindRawStringImplicitEndOfLine
• Find static event with non-null senderOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindSenderNullForStaticEvents
• Find unawaited task in using statementOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindTaskInUsing
• Find ThrowIfNull with value type argumentOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindThrowIfNullWithNonNullable
• Find type name matching namespaceOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindTypeNameMatchesNamespace
• Find DateTime.Now/UtcNow usageOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindUseDateTimeOffsetInsteadOfDateTime
• Find [DefaultValue] on parameterOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindUseDefaultParameterValue
• Find == comparison that should use Equals()OpenRewrite.Recipes.CSharp.CodeQuality.Style.FindUseEqualsMethodInsteadOfOperator
• Find integer 0 used instead of named enum valueOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindUseExplicitEnumValue
• Find Parse/ToString without IFormatProviderOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindUseFormatProviderInToString
• Find Interlocked.CompareExchange lazy init patternOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindUseLazyInitializerEnsureInitialize
• Find boolean literal argument without nameOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindUseNamedParameter
• Find Process.Start with string argumentOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindUseProcessStartWithStartInfo
• Find Regex without ExplicitCapture optionOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindUseRegexOptions
• Find redirect without UseShellExecute=falseOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindUseShellExecuteFalseWhenRedirecting
• Find ProcessStartInfo without UseShellExecuteOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindUseShellExecuteNotSet
• Find Dictionary/HashSet without StringComparerOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindUseStringComparer
• Find 'is' pattern with string literalOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindUseStringEqualsInsteadOfIsPattern
• Find double await patternOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindUseTaskUnwrap
• Find custom time abstractionOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindUseTimeProviderInsteadOfCustom
• Find argument validation in iterator methodOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindValidateArgumentsBeforeYield
• Find ElementAt() that could use indexerOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindUseElementAccessInsteadOfLinq
• Find implicit record class declarationOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindUseRecordClassExplicitly
• Find if/else with identical branchesOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindIfElseBranchesIdentical
• Find equality operator on Span<T>OpenRewrite.Recipes.CSharp.CodeQuality.Style.FindSpanEqualityOperator
• Find struct member that could be readonlyOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindReadOnlyStructMembers
• Find FormattableString usageOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindUseStringCreateInsteadOfConcat
• Find reassigned primary constructor parameterOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindPrimaryConstructorReadonly
• Find missing langword in XML commentOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindUseLangwordInXmlComment
• Find multi-line XML doc comment styleOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindSingleLineXmlComment
• Find non-constant string.Format format stringOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindStringFormatConstant
• Find explicit zero initialization in enumOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindEnumDefaultValueZero
• Find Parse/TryParse without IFormatProviderOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindUseIFormatProvider
• Find redundant nameof with CallerArgumentExpressionOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindUseCallerArgumentExpression
• Find async void methodOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindAsyncMethodReturnsNull
• Find IAsyncEnumerable method without Async suffixOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindMethodReturningIAsyncEnumerable
• Find ToString override without DebuggerDisplayOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindUseDebuggerDisplayAttribute
• Find null passed for CancellationTokenOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindDoNotPassNullForCancellationToken
• Find missing NotNullIfNotNull attributeOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindNotNullIfNotNullAttribute
• Find Stream.Read() return value ignoredOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindStreamReadIgnored
• Find Thread.Sleep usageOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindDoNotUseSleep
• Find GetType() on Type instanceOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindDoNotUseGetHashCodeForString
• Find missing non-generic interface implementationOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindImplementNonGenericInterface
• Find collection emptiness checkOpenRewrite.Recipes.CSharp.CodeQuality.Style.FindUseListPatternMatching