Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update readme for neovim setup #559

Merged
merged 7 commits into from
Jul 31, 2024
Merged

docs: update readme for neovim setup #559

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
568c760
docs: update readme for neovim setup
RayGuo-ergou Jul 21, 2024
11b71cd
chore: lint
RayGuo-ergou Jul 21, 2024
6a403f5
docs: add svelte filetype in readme
RayGuo-ergou Jul 21, 2024
2dcde29
docs: add {j,t}avascript.{t,j}sx filetype for neovim support
RayGuo-ergou Jul 22, 2024
ef3211b
chore: update
antfu Jul 31, 2024
7d77add
Merge branch 'main' into pr/RayGuo-ergou/559
antfu Jul 31, 2024
1bd1658
chore: update
antfu Jul 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
92 changes: 91 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,12 @@ For example:
}
```

## VS Code support (auto fix on save)
## IDE Support (auto fix on save)

<details>
<summary>🟦 VS Code support</summary>

<br>

Install [VS Code ESLint extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)

Expand Down Expand Up @@ -143,6 +148,7 @@ Add the following settings to your `.vscode/settings.json`:
"gql",
"graphql",
"astro",
"svelte",
"css",
"less",
"scss",
Expand All @@ -152,6 +158,90 @@ Add the following settings to your `.vscode/settings.json`:
}
```

</details>

<details>
<summary>🟩 Neovim Support</summary>

<br>

Update your configuration to use the following:

```lua
local customizations = {
{ rule = 'style/*', severity = 'off', fixable = true },
{ rule = 'format/*', severity = 'off', fixable = true },
{ rule = '*-indent', severity = 'off', fixable = true },
{ rule = '*-spacing', severity = 'off', fixable = true },
{ rule = '*-spaces', severity = 'off', fixable = true },
{ rule = '*-order', severity = 'off', fixable = true },
{ rule = '*-dangle', severity = 'off', fixable = true },
{ rule = '*-newline', severity = 'off', fixable = true },
{ rule = '*quotes', severity = 'off', fixable = true },
{ rule = '*semi', severity = 'off', fixable = true },
}

local lspconfig = require('lspconfig')
-- Enable eslint for all supported languages
lspconfig.eslint.setup(
{
filetypes = {
"javascript",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we also add all the default filetypes?

lua =require("lspconfig.server_configurations.eslint").default_config.filetypes
" { "javascript", "javascriptreact", "javascript.jsx", "typescript", "typescriptreact", "typescript.tsx", "vue", "svelte", "astro" }

We're only missing these two: javascript.jsx and typescript.tsx.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

svelte and yaml are missing too.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @thenbe Thanks for your review, as someone who is not doing a lot react. Can I ask why there's two filetype for tsx? E.g. The filetype I get from a tsx file is typescriptreact. Btw yaml is there.

image

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like they're included in nvim-lspconfig because both variants are widely used: neovim/nvim-lspconfig#2419 (comment). FWIW I also get typescriptreact.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interesting, I have added these two and I would guess it's a legacy issue ( since I cannot find a clear explanation )?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah that's pretty much the same conclusion I reached, that they're included for legacy reasons.

"javascriptreact",
"javascript.jsx",
"typescript",
"typescriptreact",
"typescript.tsx",
"vue",
"html",
"markdown",
"json",
"jsonc",
"yaml",
"toml",
"xml",
"gql",
"graphql",
"astro",
"svelte",
"css",
"less",
"scss",
"pcss",
"postcss"
},
settings = {
-- Silent the stylistic rules in you IDE, but still auto fix them
rulesCustomizations = customizations,
},
}
)
```

### Neovim format on save

There's few ways you can achieve format on save in neovim:

- `nvim-lspconfig` has a `EslintFixAll` command predefined, you can create a autocmd to call this command after saving file.

```lua
lspconfig.eslint.setup({
--- ...
on_attach = function(client, bufnr)
vim.api.nvim_create_autocmd("BufWritePre", {
buffer = bufnr,
command = "EslintFixAll",
})
end,
})
```

- Use [conform.nvim](https://github.com/stevearc/conform.nvim).
- Use [none-ls](https://github.com/nvimtools/none-ls.nvim)
- Use [nvim-lint](https://github.com/mfussenegger/nvim-lint)

</details>

## Customization

Since v1.0, we migrated to [ESLint Flat config](https://eslint.org/docs/latest/use/configure/configuration-files-new). It provides much better organization and composition.
Expand Down