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

Lack of documentation of cabal-fmt & cabal-gild #4313

Open
0rphee opened this issue Jun 12, 2024 · 1 comment · May be fixed by #4322
Open

Lack of documentation of cabal-fmt & cabal-gild #4313

0rphee opened this issue Jun 12, 2024 · 1 comment · May be fixed by #4322
Assignees
Labels
component: cabal-formatters Issues related to cabal file formatters documentation type: enhancement New feature or request

Comments

@0rphee
Copy link
Collaborator

0rphee commented Jun 12, 2024

Is your enhancement request related to a problem? Please describe.

I tried to format a cabal file with hls through the cabal-fmt plugin, but failed. Looking at the logs, I found that I needed cabal-gild:

Details

2024-06-11T15:28:37.314 helix_term::application [WARN] unhandled window/showMessage: ShowMessageParams { typ: Error, message: "Error condition, please check your setup and/or the [issue tracker](https://github.com/haskell/haskell-language-server/issues): \ncabal-gild: Internal Error: No installation of cabal-gild could be found. Please install it globally, or provide the full path to the executable." }

I looked through the latest docs and didn't find anything...

(Looked here: https://haskell-language-server.readthedocs.io/en/latest/features.html#formatting and here: https://haskell-language-server.readthedocs.io/en/latest/support/plugin-support.html#current-plugin-support-tiers)

Describe the solution you'd like

Add documentation about:

  • cabal-gild (I didn't find any mention to it in the docs)
  • the default cabal formatter used
  • how to configure the cabal formatter used

Describe alternatives you've considered

Additional context

@0rphee 0rphee changed the title Lack of documentation for cabal-fmt cabal-gild Lack of documentation of cabal-fmt cabal-gild Jun 12, 2024
@0rphee 0rphee changed the title Lack of documentation of cabal-fmt cabal-gild Lack of documentation of cabal-fmt & cabal-gild Jun 12, 2024
@fendor
Copy link
Collaborator

fendor commented Jun 14, 2024

Thanks for the reminder! I will update the docs.

@fendor fendor self-assigned this Jun 14, 2024
@fendor fendor added component: cabal-formatters Issues related to cabal file formatters documentation and removed status: needs triage labels Jun 14, 2024
@fendor fendor linked a pull request Jun 14, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: cabal-formatters Issues related to cabal file formatters documentation type: enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants