WPF 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.Wpf.WpfCodeQuality

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.

• Backing member for a DependencyProperty should match registered nameOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.RenameDependencyPropertyBackingMember
• Backing member for a DependencyPropertyKey should match registered nameOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.RenameDependencyPropertyKeyBackingMember
• CLR property for a DependencyProperty should match registered nameOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.RenameClrPropertyToMatchRegisteredName
• CLR method for a DependencyProperty must match registered nameOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.RenameClrAccessorMethodToMatchRegisteredName
• Convert a trivial dependency property callback to a lambdaOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.ConvertTrivialCallbackToLambda
• Name the PropertyChangedCallback OnNameChangedOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.RenamePropertyChangedCallbackToMatchRegisteredName
• Name the CoerceValueCallback CoerceNameOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.RenameCoerceValueCallbackToMatchRegisteredName
• Name the ValidateValueCallback ValidateNameOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.RenameValidateValueCallbackToMatchRegisteredName
• Target of [DependsOn] should existOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.FindDependsOnTargetMissing
• Default value type must match registered typeOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.FindDefaultValueTypeMismatch
• Containing type should be used as registered ownerOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.UseContainingTypeAsRegisteredOwner
• CLR property type should match registered typeOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.UseRegisteredTypeForClrProperty
• CLR accessor for attached property must match registered typeOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.UseRegisteredTypeForClrAccessorMethod
• SetValue must use the registered typeOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.FindSetValueTypeMismatch
• Registered owner type must inherit DependencyObjectOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.FindRegisteredOwnerNotDependencyObject
• Default value is a shared reference typeOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.FindSharedReferenceTypeDefaultValue
• Metadata must be of the same type or a super typeOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.FindOverrideMetadataTypeMismatch
• Use containing typeOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.FindDefaultStyleKeyOverrideMetadataArgument
• Cast the sender of a dependency property callback to the correct typeOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.CastSenderToCorrectType
• Cast the value of a dependency property callback to the correct typeOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.CastValueToCorrectType
• Cast the sender of a dependency property callback to the containing typeOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.CastSenderToContainingType
• Cast the value of a dependency property callback to the exact typeOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.CastValueToExactType
• Declare the coerce and validate callback value parameter nullableOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.MakeCallbackParameterNullable
• Backing member for a DependencyProperty should be static and readonlyOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.MakeDependencyPropertyBackingMemberStaticReadonly
• DependencyPropertyKey member must be declared before DependencyProperty memberOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.DeclareDependencyPropertyKeyBeforeProperty
• Use same dependency property in get and setOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.RequireSameDependencyPropertyInGetAndSet
• Add [AttachedPropertyBrowsableForType]OpenRewrite.Recipes.CSharp.CodeQuality.Wpf.AddAttachedPropertyBrowsableForTypeAttribute
• Use correct argument for [AttachedPropertyBrowsableForType]OpenRewrite.Recipes.CSharp.CodeQuality.Wpf.UseCorrectAttachedPropertyBrowsableForType
• Use SetValue in setterOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.UseSetValueInClrPropertySetter
• Avoid side effects in CLR accessorsOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.FindSideEffectsInClrAccessors
• Set a readonly DependencyProperty using its DependencyPropertyKeyOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.UseDependencyPropertyKeyToSetValue
• Set a mutable dependency property using SetCurrentValueOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.UseSetCurrentValueForMutableProperty
• Avoid side effects in attached property CLR accessorsOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.FindSideEffectsInAttachedPropertyAccessor
• Do not set DataContext or Style using SetCurrentValueOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.UseSetValueForDataContextAndStyle
• XmlnsPrefix must map to the same url as XmlnsDefinitionOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.FindXmlnsPrefixDefinitionMismatch
• XmlnsDefinition must map to an existing namespaceOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.FindXmlnsDefinitionForMissingNamespace
• XmlnsDefinitions should map all namespaces with public typesOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.AddXmlnsDefinitionForUnmappedNamespaces
• Backing member for DependencyProperty should have standard documentation textOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.DocumentDependencyPropertyBackingMember
• Accessor method for attached property should have standard documentation textOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.DocumentAttachedPropertyAccessor
• Property changed callback should have standard documentation textOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.DocumentPropertyChangedCallback
• Add default field to converterOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.AddDefaultFieldToValueConverter
• Add ValueConversion attributeOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.AddValueConversionAttribute
• ValueConversion must use correct typesOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.UseCorrectValueConversionTypes
• Add ValueConversion attribute (unknown types)OpenRewrite.Recipes.CSharp.CodeQuality.Wpf.FindValueConverterWithUnknownConversionTypes
• Use containing typeOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.UseContainingTypeForConverterDefault
• Add MarkupExtensionReturnType attributeOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.AddMarkupExtensionReturnTypeAttribute
• MarkupExtensionReturnType must use correct return typeOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.UseCorrectMarkupExtensionReturnType
• [ConstructorArgument] must matchOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.UseCorrectConstructorArgumentName
• Add [ConstructorArgument]OpenRewrite.Recipes.CSharp.CodeQuality.Wpf.AddConstructorArgumentAttribute
• Target of [XamlSetMarkupExtension] should exist and have correct signatureOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.XamlSetMarkupExtensionTargetShouldExist
• Target of [XamlSetTypeConverter] should exist and have correct signatureOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.XamlSetTypeConverterTargetShouldExist
• Name the RegisterClassHandler callback OnEventNameOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.RenameRegisterClassHandlerCallbackToMatchEvent
• Name the AddHandler/RemoveHandler callback OnEventNameOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.RenameAddRemoveHandlerCallbackToMatchEvent
• Use the registered routed event handler typeOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.UseRegisteredRoutedEventHandlerType
• Backing member for a RoutedEvent should match registered nameOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.RenameRoutedEventBackingMember
• Containing type should be used as registered ownerOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.RegisterContainingTypeAsRoutedEventOwner
• Name of the event should match registered nameOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.RenameEventDeclarationToMatchRegisteredName
• Use same event in add and removeOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.FindEventDeclarationAddRemoveMismatch
• Call AddHandler in addOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.FindEventAddAccessorNotCallingAddHandler
• Call RemoveHandler in removeOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.FindEventRemoveAccessorNotCallingRemoveHandler
• Use the registered handler typeOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.FindEventDeclarationHandlerTypeMismatch
• Backing member for a RoutedEvent should be static and readonlyOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.MakeRoutedEventBackingMemberStaticReadonly
• Backing member for RoutedEvent should have standard documentation textOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.DocumentRoutedEventBackingMember
• Register the containing member as the name for a RoutedCommandOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.UseContainingMemberAsRoutedCommandName
• Register the containing type as the owner for a RoutedCommandOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.UseContainingTypeAsRoutedCommandOwner
• Register a name and an owning type for a RoutedCommandOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.RegisterRoutedCommandNameAndOwner
• Backing member for a RoutedCommand should be static and readonlyOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.MakeRoutedCommandBackingMemberStaticReadonly
• Add [TemplatePart] for a looked-up template partOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.AddTemplatePartAttribute
• Use the declared [TemplatePart] typeOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.RequireCorrectTemplatePartType
• Use the PART_ prefix for template part namesOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.RequirePartPrefixInTemplatePartName
• ContentProperty should name an existing propertyOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.FindMissingContentPropertyTarget
• Use the containing type when creating a ComponentResourceKeyOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.UseContainingTypeForComponentResourceKey
• Use the containing member as the key when creating a ComponentResourceKeyOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.UseContainingMemberForComponentResourceKey
• Use nameof() instead of a string literalOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.UseNameofInsteadOfLiteral
• Use nameof() instead of a constantOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.UseNameofInsteadOfConstant
• StyleTypedProperty.Property must existOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.RequireExistingStyleTypedProperty
• StyleTypedProperty.Property should name a Style propertyOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.RequireStyleTypedPropertyOfStyleType
• StyleTypedProperty.Property should be specifiedOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.RequireStyleTypedPropertyProperty
• StyleTypedProperty.StyleTargetType should support stylingOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.RequireStyleTypedPropertyStyleTargetTypeToSupportStyle
• StyleTypedProperty.StyleTargetType should be specifiedOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.RequireStyleTypedPropertyStyleTargetType
• StyleTypedProperty.Property should be specified only onceOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.RequireUniqueStyleTypedProperty
• StyleTypedProperty should be specified for a Style propertyOpenRewrite.Recipes.CSharp.CodeQuality.Wpf.FindMissingStyleTypedProperty