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.

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

Enable users to configure linter settings in VS Code #1035

Open
dbanck opened this issue Apr 7, 2022 · 0 comments
Open

Enable users to configure linter settings in VS Code #1035

dbanck opened this issue Apr 7, 2022 · 0 comments
Labels
enhancement New feature or request linting Functionality related to linting and external linters

Comments

@dbanck
Copy link
Member

dbanck commented Apr 7, 2022

This is part of #635

Problem Statement

To allow a more straightforward configuration of linter settings for the language server, we expose those settings via the VS Code settings UI to the user.

We want to support running multiple linters simultaneously, so each supported linter will get an extra section for settings.

Expected User Experience

The settings UI for configuring a lint tool could look something like this:

CleanShot 2022-01-19 at 14 17 08

With an extra headline above and tflint specific wording.

A user should be able to specify:

  • A path to the binary
  • Arguments for the binary
  • When to run the binary, e.g. on save or off

Proposal

  • Extend the contributes object inside the package.json with the new settings UI
    • The keys for the new settings might look like:
      • terraform.languageServer.linters.tflint.binaryPath
      • terraform.languageServer.linters.tflint.binaryFlags
      • terraform.languageServer.linters.tflint.lintOnSave
  • Pass the settings to the language server on initialization
@dbanck dbanck added the enhancement New feature or request label Apr 7, 2022
@xiehan xiehan added the linting Functionality related to linting and external linters label Apr 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request linting Functionality related to linting and external linters
Projects
None yet
Development

No branches or pull requests

2 participants