Skip to content

Commit cd4ef82

Browse files
committed
test: copy markdown reference over to ghc94 & 98
1 parent e84845f commit cd4ef82

File tree

2 files changed

+132
-0
lines changed

2 files changed

+132
-0
lines changed
Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
## hlint
2+
| Property | Description | Default | Allowed values |
3+
| --- | --- | --- | --- |
4+
| `flags` | Flags used by hlint | `TODO: Array values` |   |
5+
6+
## cabal-fmt
7+
| Property | Description | Default | Allowed values |
8+
| --- | --- | --- | --- |
9+
| `path` | Set path to 'cabal-fmt' executable | `"cabal-fmt"` |   |
10+
11+
## ghcide-completions
12+
| Property | Description | Default | Allowed values |
13+
| --- | --- | --- | --- |
14+
| `autoExtendOn` | Extends the import list automatically when completing a out-of-scope identifier | `True` |   |
15+
| `snippetsOn` | Inserts snippets when using code completions | `True` |   |
16+
17+
## eval
18+
| Property | Description | Default | Allowed values |
19+
| --- | --- | --- | --- |
20+
| `exception` | Enable marking exceptions with `*** Exception:` similarly to doctest and GHCi. | `False` |   |
21+
| `diff` | Enable the diff output (WAS/NOW) of eval lenses | `True` |   |
22+
23+
## ghcide-type-lenses
24+
| Property | Description | Default | Allowed values |
25+
| --- | --- | --- | --- |
26+
| `mode` | Control how type lenses are shown | `Always` | <ul> <li><code>Always</code></li> <li><code>Exported</code></li> <li><code>Diagnostics</code></li> </ul> |
27+
28+
## ormolu
29+
| Property | Description | Default | Allowed values |
30+
| --- | --- | --- | --- |
31+
| `external` | Call out to an external "ormolu" executable, rather than using the bundled library | `False` | &nbsp; |
32+
33+
## rename
34+
| Property | Description | Default | Allowed values |
35+
| --- | --- | --- | --- |
36+
| `crossModule` | Enable experimental cross-module renaming | `False` | &nbsp; |
37+
38+
## semanticTokens
39+
| Property | Description | Default | Allowed values |
40+
| --- | --- | --- | --- |
41+
| `variableToken` | LSP semantic token type to use for variables | `SemanticTokenTypes_Variable` | <ul> <li><code>SemanticTokenTypes_Namespace</code></li> <li><code>SemanticTokenTypes_Type</code></li> <li><code>SemanticTokenTypes_Class</code></li> <li><code>SemanticTokenTypes_Enum</code></li> <li><code>SemanticTokenTypes_Interface</code></li> <li><code>SemanticTokenTypes_Struct</code></li> <li><code>SemanticTokenTypes_TypeParameter</code></li> <li><code>SemanticTokenTypes_Parameter</code></li> <li><code>SemanticTokenTypes_Variable</code></li> <li><code>SemanticTokenTypes_Property</code></li> <li><code>SemanticTokenTypes_EnumMember</code></li> <li><code>SemanticTokenTypes_Event</code></li> <li><code>SemanticTokenTypes_Function</code></li> <li><code>SemanticTokenTypes_Method</code></li> <li><code>SemanticTokenTypes_Macro</code></li> <li><code>SemanticTokenTypes_Keyword</code></li> <li><code>SemanticTokenTypes_Modifier</code></li> <li><code>SemanticTokenTypes_Comment</code></li> <li><code>SemanticTokenTypes_String</code></li> <li><code>SemanticTokenTypes_Number</code></li> <li><code>SemanticTokenTypes_Regexp</code></li> <li><code>SemanticTokenTypes_Operator</code></li> <li><code>SemanticTokenTypes_Decorator</code></li> </ul> |
42+
| `functionToken` | LSP semantic token type to use for functions | `SemanticTokenTypes_Function` | <ul> <li><code>SemanticTokenTypes_Namespace</code></li> <li><code>SemanticTokenTypes_Type</code></li> <li><code>SemanticTokenTypes_Class</code></li> <li><code>SemanticTokenTypes_Enum</code></li> <li><code>SemanticTokenTypes_Interface</code></li> <li><code>SemanticTokenTypes_Struct</code></li> <li><code>SemanticTokenTypes_TypeParameter</code></li> <li><code>SemanticTokenTypes_Parameter</code></li> <li><code>SemanticTokenTypes_Variable</code></li> <li><code>SemanticTokenTypes_Property</code></li> <li><code>SemanticTokenTypes_EnumMember</code></li> <li><code>SemanticTokenTypes_Event</code></li> <li><code>SemanticTokenTypes_Function</code></li> <li><code>SemanticTokenTypes_Method</code></li> <li><code>SemanticTokenTypes_Macro</code></li> <li><code>SemanticTokenTypes_Keyword</code></li> <li><code>SemanticTokenTypes_Modifier</code></li> <li><code>SemanticTokenTypes_Comment</code></li> <li><code>SemanticTokenTypes_String</code></li> <li><code>SemanticTokenTypes_Number</code></li> <li><code>SemanticTokenTypes_Regexp</code></li> <li><code>SemanticTokenTypes_Operator</code></li> <li><code>SemanticTokenTypes_Decorator</code></li> </ul> |
43+
| `dataConstructorToken` | LSP semantic token type to use for data constructors | `SemanticTokenTypes_EnumMember` | <ul> <li><code>SemanticTokenTypes_Namespace</code></li> <li><code>SemanticTokenTypes_Type</code></li> <li><code>SemanticTokenTypes_Class</code></li> <li><code>SemanticTokenTypes_Enum</code></li> <li><code>SemanticTokenTypes_Interface</code></li> <li><code>SemanticTokenTypes_Struct</code></li> <li><code>SemanticTokenTypes_TypeParameter</code></li> <li><code>SemanticTokenTypes_Parameter</code></li> <li><code>SemanticTokenTypes_Variable</code></li> <li><code>SemanticTokenTypes_Property</code></li> <li><code>SemanticTokenTypes_EnumMember</code></li> <li><code>SemanticTokenTypes_Event</code></li> <li><code>SemanticTokenTypes_Function</code></li> <li><code>SemanticTokenTypes_Method</code></li> <li><code>SemanticTokenTypes_Macro</code></li> <li><code>SemanticTokenTypes_Keyword</code></li> <li><code>SemanticTokenTypes_Modifier</code></li> <li><code>SemanticTokenTypes_Comment</code></li> <li><code>SemanticTokenTypes_String</code></li> <li><code>SemanticTokenTypes_Number</code></li> <li><code>SemanticTokenTypes_Regexp</code></li> <li><code>SemanticTokenTypes_Operator</code></li> <li><code>SemanticTokenTypes_Decorator</code></li> </ul> |
44+
| `typeVariableToken` | LSP semantic token type to use for type variables | `SemanticTokenTypes_TypeParameter` | <ul> <li><code>SemanticTokenTypes_Namespace</code></li> <li><code>SemanticTokenTypes_Type</code></li> <li><code>SemanticTokenTypes_Class</code></li> <li><code>SemanticTokenTypes_Enum</code></li> <li><code>SemanticTokenTypes_Interface</code></li> <li><code>SemanticTokenTypes_Struct</code></li> <li><code>SemanticTokenTypes_TypeParameter</code></li> <li><code>SemanticTokenTypes_Parameter</code></li> <li><code>SemanticTokenTypes_Variable</code></li> <li><code>SemanticTokenTypes_Property</code></li> <li><code>SemanticTokenTypes_EnumMember</code></li> <li><code>SemanticTokenTypes_Event</code></li> <li><code>SemanticTokenTypes_Function</code></li> <li><code>SemanticTokenTypes_Method</code></li> <li><code>SemanticTokenTypes_Macro</code></li> <li><code>SemanticTokenTypes_Keyword</code></li> <li><code>SemanticTokenTypes_Modifier</code></li> <li><code>SemanticTokenTypes_Comment</code></li> <li><code>SemanticTokenTypes_String</code></li> <li><code>SemanticTokenTypes_Number</code></li> <li><code>SemanticTokenTypes_Regexp</code></li> <li><code>SemanticTokenTypes_Operator</code></li> <li><code>SemanticTokenTypes_Decorator</code></li> </ul> |
45+
| `classMethodToken` | LSP semantic token type to use for typeclass methods | `SemanticTokenTypes_Method` | <ul> <li><code>SemanticTokenTypes_Namespace</code></li> <li><code>SemanticTokenTypes_Type</code></li> <li><code>SemanticTokenTypes_Class</code></li> <li><code>SemanticTokenTypes_Enum</code></li> <li><code>SemanticTokenTypes_Interface</code></li> <li><code>SemanticTokenTypes_Struct</code></li> <li><code>SemanticTokenTypes_TypeParameter</code></li> <li><code>SemanticTokenTypes_Parameter</code></li> <li><code>SemanticTokenTypes_Variable</code></li> <li><code>SemanticTokenTypes_Property</code></li> <li><code>SemanticTokenTypes_EnumMember</code></li> <li><code>SemanticTokenTypes_Event</code></li> <li><code>SemanticTokenTypes_Function</code></li> <li><code>SemanticTokenTypes_Method</code></li> <li><code>SemanticTokenTypes_Macro</code></li> <li><code>SemanticTokenTypes_Keyword</code></li> <li><code>SemanticTokenTypes_Modifier</code></li> <li><code>SemanticTokenTypes_Comment</code></li> <li><code>SemanticTokenTypes_String</code></li> <li><code>SemanticTokenTypes_Number</code></li> <li><code>SemanticTokenTypes_Regexp</code></li> <li><code>SemanticTokenTypes_Operator</code></li> <li><code>SemanticTokenTypes_Decorator</code></li> </ul> |
46+
| `patternSynonymToken` | LSP semantic token type to use for pattern synonyms | `SemanticTokenTypes_Macro` | <ul> <li><code>SemanticTokenTypes_Namespace</code></li> <li><code>SemanticTokenTypes_Type</code></li> <li><code>SemanticTokenTypes_Class</code></li> <li><code>SemanticTokenTypes_Enum</code></li> <li><code>SemanticTokenTypes_Interface</code></li> <li><code>SemanticTokenTypes_Struct</code></li> <li><code>SemanticTokenTypes_TypeParameter</code></li> <li><code>SemanticTokenTypes_Parameter</code></li> <li><code>SemanticTokenTypes_Variable</code></li> <li><code>SemanticTokenTypes_Property</code></li> <li><code>SemanticTokenTypes_EnumMember</code></li> <li><code>SemanticTokenTypes_Event</code></li> <li><code>SemanticTokenTypes_Function</code></li> <li><code>SemanticTokenTypes_Method</code></li> <li><code>SemanticTokenTypes_Macro</code></li> <li><code>SemanticTokenTypes_Keyword</code></li> <li><code>SemanticTokenTypes_Modifier</code></li> <li><code>SemanticTokenTypes_Comment</code></li> <li><code>SemanticTokenTypes_String</code></li> <li><code>SemanticTokenTypes_Number</code></li> <li><code>SemanticTokenTypes_Regexp</code></li> <li><code>SemanticTokenTypes_Operator</code></li> <li><code>SemanticTokenTypes_Decorator</code></li> </ul> |
47+
| `typeConstructorToken` | LSP semantic token type to use for type constructors | `SemanticTokenTypes_Enum` | <ul> <li><code>SemanticTokenTypes_Namespace</code></li> <li><code>SemanticTokenTypes_Type</code></li> <li><code>SemanticTokenTypes_Class</code></li> <li><code>SemanticTokenTypes_Enum</code></li> <li><code>SemanticTokenTypes_Interface</code></li> <li><code>SemanticTokenTypes_Struct</code></li> <li><code>SemanticTokenTypes_TypeParameter</code></li> <li><code>SemanticTokenTypes_Parameter</code></li> <li><code>SemanticTokenTypes_Variable</code></li> <li><code>SemanticTokenTypes_Property</code></li> <li><code>SemanticTokenTypes_EnumMember</code></li> <li><code>SemanticTokenTypes_Event</code></li> <li><code>SemanticTokenTypes_Function</code></li> <li><code>SemanticTokenTypes_Method</code></li> <li><code>SemanticTokenTypes_Macro</code></li> <li><code>SemanticTokenTypes_Keyword</code></li> <li><code>SemanticTokenTypes_Modifier</code></li> <li><code>SemanticTokenTypes_Comment</code></li> <li><code>SemanticTokenTypes_String</code></li> <li><code>SemanticTokenTypes_Number</code></li> <li><code>SemanticTokenTypes_Regexp</code></li> <li><code>SemanticTokenTypes_Operator</code></li> <li><code>SemanticTokenTypes_Decorator</code></li> </ul> |
48+
| `classToken` | LSP semantic token type to use for typeclasses | `SemanticTokenTypes_Class` | <ul> <li><code>SemanticTokenTypes_Namespace</code></li> <li><code>SemanticTokenTypes_Type</code></li> <li><code>SemanticTokenTypes_Class</code></li> <li><code>SemanticTokenTypes_Enum</code></li> <li><code>SemanticTokenTypes_Interface</code></li> <li><code>SemanticTokenTypes_Struct</code></li> <li><code>SemanticTokenTypes_TypeParameter</code></li> <li><code>SemanticTokenTypes_Parameter</code></li> <li><code>SemanticTokenTypes_Variable</code></li> <li><code>SemanticTokenTypes_Property</code></li> <li><code>SemanticTokenTypes_EnumMember</code></li> <li><code>SemanticTokenTypes_Event</code></li> <li><code>SemanticTokenTypes_Function</code></li> <li><code>SemanticTokenTypes_Method</code></li> <li><code>SemanticTokenTypes_Macro</code></li> <li><code>SemanticTokenTypes_Keyword</code></li> <li><code>SemanticTokenTypes_Modifier</code></li> <li><code>SemanticTokenTypes_Comment</code></li> <li><code>SemanticTokenTypes_String</code></li> <li><code>SemanticTokenTypes_Number</code></li> <li><code>SemanticTokenTypes_Regexp</code></li> <li><code>SemanticTokenTypes_Operator</code></li> <li><code>SemanticTokenTypes_Decorator</code></li> </ul> |
49+
| `typeSynonymToken` | LSP semantic token type to use for type synonyms | `SemanticTokenTypes_Type` | <ul> <li><code>SemanticTokenTypes_Namespace</code></li> <li><code>SemanticTokenTypes_Type</code></li> <li><code>SemanticTokenTypes_Class</code></li> <li><code>SemanticTokenTypes_Enum</code></li> <li><code>SemanticTokenTypes_Interface</code></li> <li><code>SemanticTokenTypes_Struct</code></li> <li><code>SemanticTokenTypes_TypeParameter</code></li> <li><code>SemanticTokenTypes_Parameter</code></li> <li><code>SemanticTokenTypes_Variable</code></li> <li><code>SemanticTokenTypes_Property</code></li> <li><code>SemanticTokenTypes_EnumMember</code></li> <li><code>SemanticTokenTypes_Event</code></li> <li><code>SemanticTokenTypes_Function</code></li> <li><code>SemanticTokenTypes_Method</code></li> <li><code>SemanticTokenTypes_Macro</code></li> <li><code>SemanticTokenTypes_Keyword</code></li> <li><code>SemanticTokenTypes_Modifier</code></li> <li><code>SemanticTokenTypes_Comment</code></li> <li><code>SemanticTokenTypes_String</code></li> <li><code>SemanticTokenTypes_Number</code></li> <li><code>SemanticTokenTypes_Regexp</code></li> <li><code>SemanticTokenTypes_Operator</code></li> <li><code>SemanticTokenTypes_Decorator</code></li> </ul> |
50+
| `typeFamilyToken` | LSP semantic token type to use for type families | `SemanticTokenTypes_Interface` | <ul> <li><code>SemanticTokenTypes_Namespace</code></li> <li><code>SemanticTokenTypes_Type</code></li> <li><code>SemanticTokenTypes_Class</code></li> <li><code>SemanticTokenTypes_Enum</code></li> <li><code>SemanticTokenTypes_Interface</code></li> <li><code>SemanticTokenTypes_Struct</code></li> <li><code>SemanticTokenTypes_TypeParameter</code></li> <li><code>SemanticTokenTypes_Parameter</code></li> <li><code>SemanticTokenTypes_Variable</code></li> <li><code>SemanticTokenTypes_Property</code></li> <li><code>SemanticTokenTypes_EnumMember</code></li> <li><code>SemanticTokenTypes_Event</code></li> <li><code>SemanticTokenTypes_Function</code></li> <li><code>SemanticTokenTypes_Method</code></li> <li><code>SemanticTokenTypes_Macro</code></li> <li><code>SemanticTokenTypes_Keyword</code></li> <li><code>SemanticTokenTypes_Modifier</code></li> <li><code>SemanticTokenTypes_Comment</code></li> <li><code>SemanticTokenTypes_String</code></li> <li><code>SemanticTokenTypes_Number</code></li> <li><code>SemanticTokenTypes_Regexp</code></li> <li><code>SemanticTokenTypes_Operator</code></li> <li><code>SemanticTokenTypes_Decorator</code></li> </ul> |
51+
| `recordFieldToken` | LSP semantic token type to use for record fields | `SemanticTokenTypes_Property` | <ul> <li><code>SemanticTokenTypes_Namespace</code></li> <li><code>SemanticTokenTypes_Type</code></li> <li><code>SemanticTokenTypes_Class</code></li> <li><code>SemanticTokenTypes_Enum</code></li> <li><code>SemanticTokenTypes_Interface</code></li> <li><code>SemanticTokenTypes_Struct</code></li> <li><code>SemanticTokenTypes_TypeParameter</code></li> <li><code>SemanticTokenTypes_Parameter</code></li> <li><code>SemanticTokenTypes_Variable</code></li> <li><code>SemanticTokenTypes_Property</code></li> <li><code>SemanticTokenTypes_EnumMember</code></li> <li><code>SemanticTokenTypes_Event</code></li> <li><code>SemanticTokenTypes_Function</code></li> <li><code>SemanticTokenTypes_Method</code></li> <li><code>SemanticTokenTypes_Macro</code></li> <li><code>SemanticTokenTypes_Keyword</code></li> <li><code>SemanticTokenTypes_Modifier</code></li> <li><code>SemanticTokenTypes_Comment</code></li> <li><code>SemanticTokenTypes_String</code></li> <li><code>SemanticTokenTypes_Number</code></li> <li><code>SemanticTokenTypes_Regexp</code></li> <li><code>SemanticTokenTypes_Operator</code></li> <li><code>SemanticTokenTypes_Decorator</code></li> </ul> |
52+
| `operatorToken` | LSP semantic token type to use for operators | `SemanticTokenTypes_Operator` | <ul> <li><code>SemanticTokenTypes_Namespace</code></li> <li><code>SemanticTokenTypes_Type</code></li> <li><code>SemanticTokenTypes_Class</code></li> <li><code>SemanticTokenTypes_Enum</code></li> <li><code>SemanticTokenTypes_Interface</code></li> <li><code>SemanticTokenTypes_Struct</code></li> <li><code>SemanticTokenTypes_TypeParameter</code></li> <li><code>SemanticTokenTypes_Parameter</code></li> <li><code>SemanticTokenTypes_Variable</code></li> <li><code>SemanticTokenTypes_Property</code></li> <li><code>SemanticTokenTypes_EnumMember</code></li> <li><code>SemanticTokenTypes_Event</code></li> <li><code>SemanticTokenTypes_Function</code></li> <li><code>SemanticTokenTypes_Method</code></li> <li><code>SemanticTokenTypes_Macro</code></li> <li><code>SemanticTokenTypes_Keyword</code></li> <li><code>SemanticTokenTypes_Modifier</code></li> <li><code>SemanticTokenTypes_Comment</code></li> <li><code>SemanticTokenTypes_String</code></li> <li><code>SemanticTokenTypes_Number</code></li> <li><code>SemanticTokenTypes_Regexp</code></li> <li><code>SemanticTokenTypes_Operator</code></li> <li><code>SemanticTokenTypes_Decorator</code></li> </ul> |
53+
| `moduleToken` | LSP semantic token type to use for modules | `SemanticTokenTypes_Namespace` | <ul> <li><code>SemanticTokenTypes_Namespace</code></li> <li><code>SemanticTokenTypes_Type</code></li> <li><code>SemanticTokenTypes_Class</code></li> <li><code>SemanticTokenTypes_Enum</code></li> <li><code>SemanticTokenTypes_Interface</code></li> <li><code>SemanticTokenTypes_Struct</code></li> <li><code>SemanticTokenTypes_TypeParameter</code></li> <li><code>SemanticTokenTypes_Parameter</code></li> <li><code>SemanticTokenTypes_Variable</code></li> <li><code>SemanticTokenTypes_Property</code></li> <li><code>SemanticTokenTypes_EnumMember</code></li> <li><code>SemanticTokenTypes_Event</code></li> <li><code>SemanticTokenTypes_Function</code></li> <li><code>SemanticTokenTypes_Method</code></li> <li><code>SemanticTokenTypes_Macro</code></li> <li><code>SemanticTokenTypes_Keyword</code></li> <li><code>SemanticTokenTypes_Modifier</code></li> <li><code>SemanticTokenTypes_Comment</code></li> <li><code>SemanticTokenTypes_String</code></li> <li><code>SemanticTokenTypes_Number</code></li> <li><code>SemanticTokenTypes_Regexp</code></li> <li><code>SemanticTokenTypes_Operator</code></li> <li><code>SemanticTokenTypes_Decorator</code></li> </ul> |
54+
55+
## fourmolu
56+
| Property | Description | Default | Allowed values |
57+
| --- | --- | --- | --- |
58+
| `external` | Call out to an external "fourmolu" executable, rather than using the bundled library. | `False` | &nbsp; |
59+
| `path` | Set path to executable (for "external" mode). | `"fourmolu"` | &nbsp; |
60+
61+
## cabal-gild
62+
| Property | Description | Default | Allowed values |
63+
| --- | --- | --- | --- |
64+
| `path` | Set path to 'cabal-gild' executable | `"cabal-gild"` | &nbsp; |
65+
66+

0 commit comments

Comments
 (0)