@ts-kizuna/typescript-plugin

TypeScript language service plugin that surfaces ts-kizuna deprecations in editors. Deprecated routes and fields are struck through everywhere the contract's types flow, hovering shows the migration message, and completions strike through deprecated entries.

Install

pnpm add -D @ts-kizuna/typescript-plugin

Usage

Declare the plugin in tsconfig.json:

{
    "compilerOptions": {
        "plugins": [
            {
                "name": "@ts-kizuna/typescript-plugin"
            }
        ]
    }
}

Deprecations are declared once, on the contract:

deleteUser: {
    method: 'DELETE',
    path: '/users/:id',
    deprecated: 'use archiveUser instead',
    // ...
},

Documentation