Documentation

The context a cursor can be in within a cabal file.

We can be in stanzas or the top level, and additionally we can be in a context where we have already written a keyword but no value for it yet

Context inside a cabal file. Used to decide which keywords to suggest.

Keyword context in a cabal file.

Used to decide whether to suggest values or keywords.

Information regarding the current completion status

Example: "dir1/fi having been written to the file would correspond to:

   completionPrefix = "dir1/fi"
   isStringNotation = LeftSide
   ...
 

We define this type instead of simply using VFS.PosPrefixInfo since e.g. for filepaths we need more than just the word before the cursor (as can be seen above), since we want to capture the whole filepath before the cursor.

We also use this type to wrap all information necessary to complete filepaths and other values in a cabal file.

Where are the apostrophes around the item to be completed?

Surrounded means the item to complete already has the necessary apostrophes, while LeftSide means, a closing apostrophe has to be added after the completion item.

Wraps a completion in apostrophes where appropriate.

If a completion starts with an apostrophe we want to end it with an apostrophe. If a completed filepath contains a space, it can only be written in the cabal file if it is wrapped in apostrophes, thus we wrap it.

Convert an LSP Position to a Position.

Cabal Positions start their indexing at 1 while LSP starts at 0. This helper makes sure, the translation is done properly.