Skip to content

Commit

Permalink
Clarify developer setup
Browse files Browse the repository at this point in the history
  • Loading branch information
cleve-fauna committed Feb 5, 2024
1 parent 0b59d71 commit 7a92af4
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 4 deletions.
18 changes: 15 additions & 3 deletions DEVELOPERS.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,19 @@
## Developing the Extension
# Developing the Extension

Open vscode in this directory, and hit F5 to run a new version of
vscode, which will have this plugin running.
## Setup
Before launching you'll need to fetch the analzyer locally and compile this app:

```
yarn developer-setup
```


## Launching
Now to launch:

Open vscode in this directory, and select "Run -> Start Debugging" from the menu,
there is an `F5` shortcut for this on some systems with some keybindings. This will
launch a parallel instance of VS code with the local extension running.

Now in this new instance of vscode, press cmd+l/ctrl+l to open the FQL Playground.
This should have syntax highlighting, and a language server should give live
Expand Down
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@
"scripts": {
"vscode:prepublish": "yarn run compile",
"compile": "tsc -p ./",
"developer-setup": "yarn install && yarn compile && yarn download-analyzer",
"download-analyzer": "bash ./scripts/download-analyzer.sh",
"watch": "tsc -watch -p ./",
"pretest": "yarn run compile && yarn run lint && yarn run download-analyzer",
Expand All @@ -65,7 +66,7 @@
"fauna.dbSecret": {
"type": "string",
"default": "",
"description": "The secret to use to connnect to your fauna database.",
"description": "The secret used to connect to your fauna database.",
"scope": "window"
},
"fauna.endpoint": {
Expand Down

0 comments on commit 7a92af4

Please sign in to comment.