Skip to content

Commit d7bdd0c

Browse files
authored
Docs: Fix checkParents documentation (#3184)
* Check on close modes were removed * Moving docs to configuration and away from ghcide README
1 parent 855a882 commit d7bdd0c

File tree

2 files changed

+2
-20
lines changed

2 files changed

+2
-20
lines changed

docs/configuration.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,8 @@ Here is a list of the additional settings currently supported by `haskell-langua
4242

4343
- Formatting provider (`haskell.formattingProvider`, default `ormolu`): what formatter to use; one of `floskell`, `ormolu`, `fourmolu`, `stylish-haskell`, or `brittany` (if compiled with the brittany plugin).
4444
- Max completions (`haskell.maxCompletions`, default 40): maximum number of completions sent to the LSP client.
45-
- Check project (`haskell.checkProject`, default true): whether to typecheck the entire project on load. As it is activated by default could drive to bad performance in large projects.
46-
- Check parents (`haskell.checkParents`, default `CheckOnSaveAndClose`): when to typecheck reverse dependencies of a file; one of `NeverCheck`, `CheckOnClose`, `CheckOnSaveAndClose`, or `AlwaysCheck`.
45+
- Check project (`haskell.checkProject`, default true): whether to typecheck the entire project on initial load. As it is activated by default could drive to bad performance in large projects.
46+
- Check parents (`haskell.checkParents`, default `CheckOnSave`): when to typecheck reverse dependencies of a file; one of `NeverCheck`, `CheckOnSave` (means dependent/parent modules will only be checked when you save), or `AlwaysCheck` (means re-typechecking them on every change).
4747

4848
#### Generic plugin configuration
4949

ghcide/README.md

-18
Original file line numberDiff line numberDiff line change
@@ -100,24 +100,6 @@ If you can't get `ghcide` working outside the editor, see [this setup troublesho
100100

101101
`ghcide` has been designed to handle projects with hundreds or thousands of modules. If `ghci` can handle it, then `ghcide` should be able to handle it. The only caveat is that this currently requires GHC >= 8.6, and that the first time a module is loaded in the editor will trigger generation of support files in the background if those do not already exist.
102102

103-
### Configuration
104-
105-
`ghcide` accepts the following lsp configuration options:
106-
107-
```typescript
108-
{
109-
// When to check the dependents of a module
110-
// AlwaysCheck means retypechecking them on every change
111-
// CheckOnSave means dependent/parent modules will only be checked when you save
112-
// "CheckOnSaveAndClose" by default
113-
checkParents : "NeverCheck" | "CheckOnClose" | "CheckOnSaveAndClose" | "AlwaysCheck" | ,
114-
// Whether to check the entire project on initial load
115-
// true by default
116-
checkProject : boolean
117-
118-
}
119-
```
120-
121103
### Using with VS Code
122104

123105
The [Haskell](https://marketplace.visualstudio.com/items?itemName=haskell.haskell) extension has a setting for ghcide.

0 commit comments

Comments
 (0)