typescript-tshm-plugin

typescript-tshm-plugin

Augment TypeScript with tshm type signatures.

The plugin is in its infancy, supporting only certain constructs such as variable and function declarations but nothing more fine-grained. It renders tshm's output alongside the normal type signature in "quick info".

Usage

First and foremost, tshm must be installed and accessible to the plugin in your $PATH.

There are then two options for usage:

Global

If your editor supports it you can load the plugin within typescript-language-server (nota bene this is not plain tsserver which is what ships with VSCode for "Intellisense").

• Install the plugin globally with a package manager such as npm (npm i -g typescript-tshm-plugin).
• Configure the language server to load the plugin. Here's what that might look like with Neovim's native LSP client and nvim-lspconfig:

require'lspconfig'.tsserver.setup {
  init_options = {
    plugins = { {
      name = "typescript-tshm-plugin",
      location = "/usr/lib/node_modules/typescript-tshm-plugin/"
    } }
  }
}

Project

Alternatively you can set up the plugin on a per-project basis. This will work for the likes of VSCode.

• Install the plugin either globally or locally in your project with npm, Yarn, or similar.
• Add the following snippet to your project's tsconfig.json:

{
  "compilerOptions": {
    "plugins": [{ "name": "typescript-tshm-plugin" }]
  }
}

If your editor/language client is already running you'll need to reload it.

Changelog

0.1.0 (2021-07-28)

This is the plugin's initial release targeting tshm 0.4.x.

It currently only supports the simplest of circumstances, specifically most top-level declarations. Output is currently printed below the normal type signature in "quick info", which is on hover in something like VSCode.