Add a diagnostic ID for asp-for attribute deprecation

gunndabad · gunndabad · commit dfef9ab511ac · 2025-04-15T16:03:03.000+01:00
diff --git a/src/GovUk.Frontend.AspNetCore/DiagnosticIds.cs b/src/GovUk.Frontend.AspNetCore/DiagnosticIds.cs
@@ -0,0 +1,6 @@
+namespace GovUk.Frontend.AspNetCore;
+
+internal static class DiagnosticIds
+{
+    public const string UseForAttributeInstead = "GFA0001";
+}
diff --git a/src/GovUk.Frontend.AspNetCore/TagHelpers/CharacterCountTagHelper.cs b/src/GovUk.Frontend.AspNetCore/TagHelpers/CharacterCountTagHelper.cs
@@ -68,7 +68,7 @@ internal CharacterCountTagHelper(IComponentGenerator componentGenerator, IModelH
     /// An expression to be evaluated against the current model.
     /// </summary>
     [HtmlAttributeName(AspForAttributeName)]
-    [Obsolete("Use the 'for' attribute instead.")]
+    [Obsolete("Use the 'for' attribute instead.", DiagnosticId = DiagnosticIds.UseForAttributeInstead)]
     public ModelExpression? AspFor
     {
         get => For;
diff --git a/src/GovUk.Frontend.AspNetCore/TagHelpers/ErrorMessageTagHelper.cs b/src/GovUk.Frontend.AspNetCore/TagHelpers/ErrorMessageTagHelper.cs
@@ -48,7 +48,7 @@ internal ErrorMessageTagHelper(
     /// An expression to be evaluated against the current model.
     /// </summary>
     [HtmlAttributeName(AspForAttributeName)]
-    [Obsolete("Use the 'for' attribute instead.")]
+    [Obsolete("Use the 'for' attribute instead.", DiagnosticId = DiagnosticIds.UseForAttributeInstead)]
     public ModelExpression? AspFor
     {
         get => For;
diff --git a/src/GovUk.Frontend.AspNetCore/TagHelpers/ErrorSummaryItemTagHelper.cs b/src/GovUk.Frontend.AspNetCore/TagHelpers/ErrorSummaryItemTagHelper.cs
@@ -54,7 +54,7 @@ internal ErrorSummaryItemTagHelper(
     /// An expression to be evaluated against the current model.
     /// </summary>
     [HtmlAttributeName(AspForAttributeName)]
-    [Obsolete("Use the 'for' attribute instead.")]
+    [Obsolete("Use the 'for' attribute instead.", DiagnosticId = DiagnosticIds.UseForAttributeInstead)]
     public ModelExpression? AspFor
     {
         get => For;
diff --git a/src/GovUk.Frontend.AspNetCore/TagHelpers/FormGroupTagHelperBase.cs b/src/GovUk.Frontend.AspNetCore/TagHelpers/FormGroupTagHelperBase.cs
@@ -33,7 +33,7 @@ private protected FormGroupTagHelperBase(
     /// An expression to be evaluated against the current model.
     /// </summary>
     [HtmlAttributeName(AspForAttributeName)]
-    [Obsolete("Use the 'for' attribute instead.")]
+    [Obsolete("Use the 'for' attribute instead.", DiagnosticId = DiagnosticIds.UseForAttributeInstead)]
     public ModelExpression? AspFor
     {
         get => For;
diff --git a/src/GovUk.Frontend.AspNetCore/TagHelpers/TextInputTagHelper.cs b/src/GovUk.Frontend.AspNetCore/TagHelpers/TextInputTagHelper.cs
@@ -80,7 +80,7 @@ internal TextInputTagHelper(IComponentGenerator componentGenerator, IModelHelper
     /// An expression to be evaluated against the current model.
     /// </summary>
     [HtmlAttributeName(AspForAttributeName)]
-    [Obsolete("Use the 'for' attribute instead.")]
+    [Obsolete("Use the 'for' attribute instead.", DiagnosticId = DiagnosticIds.UseForAttributeInstead)]
     public ModelExpression? AspFor
     {
         get => For;

Original file line number	Diff line number	Diff line change
`@@ -68,7 +68,7 @@ internal CharacterCountTagHelper(IComponentGenerator componentGenerator, IModelH`
`68`	`68`	`/// An expression to be evaluated against the current model.`
`69`	`69`	`/// </summary>`
`70`	`70`	`[HtmlAttributeName(AspForAttributeName)]`
`71`		`- [Obsolete("Use the 'for' attribute instead.")]`
	`71`	`+ [Obsolete("Use the 'for' attribute instead.", DiagnosticId = DiagnosticIds.UseForAttributeInstead)]`
`72`	`72`	`public ModelExpression? AspFor`
`73`	`73`	`{`
`74`	`74`	`get => For;`
Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@ internal ErrorMessageTagHelper(`
`48`	`48`	`/// An expression to be evaluated against the current model.`
`49`	`49`	`/// </summary>`
`50`	`50`	`[HtmlAttributeName(AspForAttributeName)]`
`51`		`- [Obsolete("Use the 'for' attribute instead.")]`
	`51`	`+ [Obsolete("Use the 'for' attribute instead.", DiagnosticId = DiagnosticIds.UseForAttributeInstead)]`
`52`	`52`	`public ModelExpression? AspFor`
`53`	`53`	`{`
`54`	`54`	`get => For;`
Original file line number	Diff line number	Diff line change
`@@ -54,7 +54,7 @@ internal ErrorSummaryItemTagHelper(`
`54`	`54`	`/// An expression to be evaluated against the current model.`
`55`	`55`	`/// </summary>`
`56`	`56`	`[HtmlAttributeName(AspForAttributeName)]`
`57`		`- [Obsolete("Use the 'for' attribute instead.")]`
	`57`	`+ [Obsolete("Use the 'for' attribute instead.", DiagnosticId = DiagnosticIds.UseForAttributeInstead)]`
`58`	`58`	`public ModelExpression? AspFor`
`59`	`59`	`{`
`60`	`60`	`get => For;`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ private protected FormGroupTagHelperBase(`
`33`	`33`	`/// An expression to be evaluated against the current model.`
`34`	`34`	`/// </summary>`
`35`	`35`	`[HtmlAttributeName(AspForAttributeName)]`
`36`		`- [Obsolete("Use the 'for' attribute instead.")]`
	`36`	`+ [Obsolete("Use the 'for' attribute instead.", DiagnosticId = DiagnosticIds.UseForAttributeInstead)]`
`37`	`37`	`public ModelExpression? AspFor`
`38`	`38`	`{`
`39`	`39`	`get => For;`
Original file line number	Diff line number	Diff line change
`@@ -80,7 +80,7 @@ internal TextInputTagHelper(IComponentGenerator componentGenerator, IModelHelper`
`80`	`80`	`/// An expression to be evaluated against the current model.`
`81`	`81`	`/// </summary>`
`82`	`82`	`[HtmlAttributeName(AspForAttributeName)]`
`83`		`- [Obsolete("Use the 'for' attribute instead.")]`
	`83`	`+ [Obsolete("Use the 'for' attribute instead.", DiagnosticId = DiagnosticIds.UseForAttributeInstead)]`
`84`	`84`	`public ModelExpression? AspFor`
`85`	`85`	`{`
`86`	`86`	`get => For;`