Welcome to typecheck.nvim 👋

A Neovim plugin for seamless TypeScript type checking.

Introduction

typecheck.nvim is a Neovim plugin designed to enhance your TypeScript development workflow. It provides real-time type checking and integrates smoothly with Neovim's quickfix window, allowing you to easily navigate and fix type errors in your TypeScript projects.

Features

• Asynchronous type checking: Run TypeScript compiler (tsc) checks without blocking the Neovim UI.
• Integration with quickfix or trouble.nvim window: View and navigate TypeScript errors and warnings directly within Neovim.

Installation

Include typecheck.nvim in your plugin manager's configuration. For example, using lazy.nvim:

return {
  "jellydn/typecheck.nvim",
  dependencies = { "folke/trouble.nvim", dependencies = { "nvim-tree/nvim-web-devicons" } },
  ft = { "javascript", "javascriptreact", "json", "jsonc", "typescript", "typescriptreact" },
  opts = {
    debug = true,
    mode = "trouble", -- "quickfix" | "trouble"
  },
  keys = {
    {
      "<leader>ck",
      "<cmd>Typecheck<cr>",
      desc = "Run Type Check",
    },
  }
}

Demo

Run :Typecheck to start type checking. The quickfix window will open if there are any errors or warnings.

Integration with trouble.nvim

Roadmap

typecheck.nvim is continuously evolving, and there are exciting plans for future enhancements. Here's what's on the horizon:

• Bun Support:

  • Detect and utilize Bun (a fast, modern JavaScript runtime) for TypeScript checking.
  • This feature will be explored if bun.lock is present and Bun is installed with TypeScript compiler (tsc) support.

• Deno Integration:

  • Implement support for Deno (a secure runtime for JavaScript and TypeScript).
  • Integration will be prioritized if deno.lock is detected and Deno is installed with TypeScript compiler capabilities.

These features aim to broaden the compatibility and functionality of typecheck.nvim, making it a more versatile tool for TypeScript developers using different environments and setups.

Credits

• Inspired by dmmulroy/tsc.nvim: A Neovim plugin for seamless, asynchronous project-wide TypeScript type-checking using the TypeScript compiler (tsc)

Contributing

Contributions, issues, and feature requests are welcome! Feel free to check issues page.

License

typecheck.nvim is available under the MIT License.

Author

👤 Huynh Duc Dung

• Website: https://productsway.com/
• Twitter: @jellydn
• Github: @jellydn

Show your support

If this guide has been helpful, please give it a ⭐️.