Skip to content

Commit

Permalink
put the typescript readme back to how it was
Browse files Browse the repository at this point in the history
This reverts commit 1e9feeb.
  • Loading branch information
willparsons committed May 29, 2024
1 parent 4962cb0 commit 99443c4
Showing 1 changed file with 1 addition and 41 deletions.
42 changes: 1 addition & 41 deletions lua/astrocommunity/pack/typescript/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,5 @@
# TypeScript Language Pack

> [!NOTE]
> The default functionality for this pack is to use eslint and prettier, if you want to use biome then use `typescript.biome`.
> If you don't want either, then use `typescript.core`.
>
> Both variants (default and biome) can be used in unison, and it will determine the appropriate config as best as it can.
## Default

This plugin pack does the following:

- Adds `typescript`, `javascript`, `tsx`, and `jsdoc` Treesitter parsers
Expand All @@ -19,7 +11,7 @@ This plugin pack does the following:
- Adds [package-info.nvim](https://github.com/vuki656/package-info.nvim) for project package management
- Adds [nvim-lsp-file-operations](https://github.com/antosha417/nvim-lsp-file-operations) to handles file imports on rename or move within neo-tree

### How do I disable Eslint format on save?
## How do I disable Eslint format on save?

To opt out of the Eslint format on save behaviour, you can disable the autocmd setup with the pack with this:

Expand All @@ -34,35 +26,3 @@ return {
},
}
```

## Biome

This plugin pack does the following:

- Adds `typescript`, `javascript`, `tsx`, and `jsdoc` Treesitter parsers
- Adds `vtsls` and `biome` language server
- Adds [JSON language support](../json)
- Adds support for dap for JS
- Adds [nvim-vtsls](https://github.com/yioneko/nvim-vtsls) for language specific tooling
- Adds [package-info.nvim](https://github.com/vuki656/package-info.nvim) for project package management
- Adds [nvim-lsp-file-operations](https://github.com/antosha417/nvim-lsp-file-operations) to handles file imports on rename or move within neo-tree

### How do I use biome without mason?

If you have biome as a dependency, then it's recommended to run the LSP through that dependency. This is because the biome linter and formatter
is prone to change between versions meaning your LSP can show different diagnostics compared to the actual version of biome you have installed.

```lua
return {
"AstroNvim/astrolsp",
servers = {
"biome",
},
config = {
biome = {
-- Use the package manager of your project: npx, yarn, pnpm, bun...
cmd = { "yarn", "biome", "lsp-proxy" }
}
}
}
```

0 comments on commit 99443c4

Please sign in to comment.