Skip to content
This repository was archived by the owner on Nov 2, 2022. It is now read-only.

Commit e0a087b

Browse files
author
Peter Appleby
authored
Update README.md
1 parent 99d1da1 commit e0a087b

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

VSCodeExtension/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,13 @@ This extension is developed independently of Secret Lab Pty Ltd and the Yarn Spi
1010

1111
To learn more about Yarn Spinner, head to the [official site](https://yarnspinner.dev)!
1212

13+
## Importing / Overriding via JSON
14+
If you want to import command and function definitions for a language other than C#, or you want to override information that the language server parses from C#, add a JSON file with the extension ".ysls.json" to your project's folder using the [ysls.json schema](/LanguageServer/src/Server/Documentation/ysls.schema.json).
15+
16+
For examples, take a look at this [import example](/LanguageServer/ImportExample.ysls.json) or the [yarn spinner built in Commands and Functions file](/LanguageServer/src/Server/Documentation/BuiltInFunctionsAndCommands.ysls.json).
17+
18+
One caveat to note; the language server does not automatically reload ysls.json files (nor .cs files). To force the server to reload function and command definitions, go to the extension settings and toggle the "CSharp Lookup" property. (This will be fixed in an upcoming release!)
19+
1320
## Demo
1421
<img src="https://user-images.githubusercontent.com/408888/133907128-ab3fe7a3-b2cf-4ce6-98d7-65f048fbae1f.gif" alt="Demonstration of hover tooltip, Go to references, and Go to definition" />
1522

0 commit comments

Comments
 (0)