Add stubs for deprecation diagnostics

Author: thecrypticace

packages/tailwindcss-language-server/src/config.ts

@@ -22,6 +22,7 @@ function getDefaultSettings(): Settings {
       rootFontSize: 16,
       lint: {
         cssConflict: 'warning',
+        deprecatedClass: 'warning',
         invalidApply: 'error',
         invalidScreen: 'error',
         invalidVariant: 'error',

packages/tailwindcss-language-service/src/codeActions/codeActionProvider.ts

@@ -13,6 +13,7 @@ import {
   isInvalidScreenDiagnostic,
   isInvalidVariantDiagnostic,
   isRecommendedVariantOrderDiagnostic,
+  isDeprecatedClassDiagnostic,
 } from '../diagnostics/types'
 import { flatten, dedupeBy } from '../util/array'
 import { provideCssConflictCodeActions } from './provideCssConflictCodeActions'
@@ -74,7 +75,8 @@ export async function doCodeActions(
         isInvalidTailwindDirectiveDiagnostic(diagnostic) ||
         isInvalidScreenDiagnostic(diagnostic) ||
         isInvalidVariantDiagnostic(diagnostic) ||
-        isRecommendedVariantOrderDiagnostic(diagnostic)
+        isRecommendedVariantOrderDiagnostic(diagnostic) ||
+        isDeprecatedClassDiagnostic(diagnostic)
       ) {
         return provideSuggestionCodeActions(state, params, diagnostic)
       }

packages/tailwindcss-language-service/src/codeActions/provideSuggestionCodeActions.ts

@@ -1,6 +1,7 @@
 import type { State } from '../util/state'
 import type { CodeActionParams, CodeAction } from 'vscode-languageserver'
 import type {
+  DeprecatedClassDiagnostic,
   InvalidConfigPathDiagnostic,
   InvalidTailwindDirectiveDiagnostic,
   InvalidScreenDiagnostic,
@@ -12,6 +13,7 @@ export function provideSuggestionCodeActions(
   _state: State,
   params: CodeActionParams,
   diagnostic:
+    | DeprecatedClassDiagnostic
     | InvalidConfigPathDiagnostic
     | InvalidTailwindDirectiveDiagnostic
     | InvalidScreenDiagnostic

packages/tailwindcss-language-service/src/diagnostics/diagnosticsProvider.ts

@@ -9,11 +9,13 @@ import { getInvalidConfigPathDiagnostics } from './getInvalidConfigPathDiagnosti
 import { getInvalidTailwindDirectiveDiagnostics } from './getInvalidTailwindDirectiveDiagnostics'
 import { getRecommendedVariantOrderDiagnostics } from './getRecommendedVariantOrderDiagnostics'
 import { getInvalidSourceDiagnostics } from './getInvalidSourceDiagnostics'
+import { getDeprecatedClassDiagnostics } from './getDeprecatedClassDiagnostics'
 
 export async function doValidate(
   state: State,
   document: TextDocument,
   only: DiagnosticKind[] = [
+    DiagnosticKind.Deprecation,
     DiagnosticKind.CssConflict,
     DiagnosticKind.InvalidApply,
     DiagnosticKind.InvalidScreen,
@@ -28,6 +30,9 @@ export async function doValidate(
 
   return settings.tailwindCSS.validate
     ? [
+        ...(only.includes(DiagnosticKind.Deprecation)
+          ? await getDeprecatedClassDiagnostics(state, document, settings)
+          : []),
         ...(only.includes(DiagnosticKind.CssConflict)
           ? await getCssConflictDiagnostics(state, document, settings)
           : []),

packages/tailwindcss-language-service/src/diagnostics/getDeprecatedClassDiagnostics.ts

@@ -0,0 +1,22 @@
+import type { State, Settings } from '../util/state'
+import { type DeprecatedClassDiagnostic } from './types'
+import type { TextDocument } from 'vscode-languageserver-textdocument'
+
+export async function getDeprecatedClassDiagnostics(
+  state: State,
+  document: TextDocument,
+  settings: Settings,
+): Promise<DeprecatedClassDiagnostic[]> {
+  // Only v4 projects can report deprecations
+  if (!state.v4) return []
+
+  // This is an earlier v4 version that does not support class deprecations
+  if (!state.designSystem.classMetadata) return []
+
+  let severity = settings.tailwindCSS.lint.deprecatedClass
+  if (severity === 'ignore') return []
+
+  let diagnostics: DeprecatedClassDiagnostic[] = []
+
+  return diagnostics
+}

packages/tailwindcss-language-service/src/diagnostics/types.ts

@@ -6,12 +6,25 @@ export enum DiagnosticKind {
   InvalidApply = 'invalidApply',
   InvalidScreen = 'invalidScreen',
   InvalidVariant = 'invalidVariant',
+  DeprecatedClass = 'deprecatedClass',
   InvalidConfigPath = 'invalidConfigPath',
   InvalidTailwindDirective = 'invalidTailwindDirective',
   InvalidSourceDirective = 'invalidSourceDirective',
   RecommendedVariantOrder = 'recommendedVariantOrder',
 }
 
+export type DeprecatedClassDiagnostic = Diagnostic & {
+  code: DiagnosticKind.DeprecatedClass
+  className: DocumentClassName
+  suggestions: string[]
+}
+
+export function isDeprecatedClassDiagnostic(
+  diagnostic: AugmentedDiagnostic,
+): diagnostic is DeprecatedClassDiagnostic {
+  return diagnostic.code === DiagnosticKind.DeprecatedClass
+}
+
 export type CssConflictDiagnostic = Diagnostic & {
   code: DiagnosticKind.CssConflict
   className: DocumentClassName
@@ -101,6 +114,7 @@ export function isRecommendedVariantOrderDiagnostic(
 }
 
 export type AugmentedDiagnostic =
+  | DeprecatedClassDiagnostic
   | CssConflictDiagnostic
   | InvalidApplyDiagnostic
   | InvalidScreenDiagnostic

packages/tailwindcss-language-service/src/util/state.ts

@@ -54,6 +54,7 @@ export type TailwindCssSettings = {
   colorDecorators: boolean
   lint: {
     cssConflict: DiagnosticSeveritySetting
+    deprecatedClass: DiagnosticSeveritySetting
     invalidApply: DiagnosticSeveritySetting
     invalidScreen: DiagnosticSeveritySetting
     invalidVariant: DiagnosticSeveritySetting

packages/vscode-tailwindcss/README.md

@@ -148,6 +148,10 @@ Unknown or invalid path used with the [`theme` helper](https://tailwindcss.com/d
 
 Class names on the same HTML element which apply the same CSS property or properties. **Default: `warning`**
 
+#### `tailwindCSS.lint.deprecatedClass`
+
+Use of a deprecated class. **Default: `warning`**
+
 #### `tailwindCSS.lint.recommendedVariantOrder`
 
 Class variants not in the recommended order (applies in [JIT mode](https://tailwindcss.com/docs/just-in-time-mode) only). **Default: `warning`**

packages/vscode-tailwindcss/package.json

@@ -225,6 +225,17 @@
           "markdownDescription": "Class names on the same HTML element which apply the same CSS property or properties",
           "scope": "language-overridable"
         },
+        "tailwindCSS.lint.deprecatedClass": {
+          "type": "string",
+          "enum": [
+            "ignore",
+            "warning",
+            "error"
+          ],
+          "default": "warning",
+          "markdownDescription": "Use of a deprecated utility class",
+          "scope": "language-overridable"
+        },
         "tailwindCSS.lint.invalidApply": {
           "type": "string",
           "enum": [