|
| 1 | +# Getting started with VSCode |
| 2 | + |
| 3 | +VSCode works with Nevermore relatively easily. We have default extensions.json setup. Follow the general setup tips. This types should generally work for Cursor and other VS-Code based IDEs. |
| 4 | + |
| 5 | +## Extensions |
| 6 | + |
| 7 | +Nevermore uses standard community extensions, including the following: |
| 8 | + |
| 9 | +* quenty.nevermore-vscode |
| 10 | +* kampfkarren.selene-vscode |
| 11 | +* johnnymorganz.luau-lsp |
| 12 | +* johnnymorganz.stylua |
| 13 | + |
| 14 | +These will provide snippets, styling, and linking. |
| 15 | + |
| 16 | +## Configuration of Luau-LSP |
| 17 | + |
| 18 | +You currently must use the forked version of luau-lsp. You can use the default extension. |
| 19 | + |
| 20 | +in `settings.json` configure the luau-lsp server to point towards a custom exe path. This should be your Luau-lsp exe path installed via aftman.toml. |
| 21 | + |
| 22 | +```json |
| 23 | + "luau-lsp.server.path": "C:/Users/James Onnen/.aftman/tool-storage/quenty/luau-lsp/1.58.0-quenty.1/luau-lsp.exe", |
| 24 | +``` |
| 25 | + |
| 26 | +## Other helpful settings for consumption |
| 27 | + |
| 28 | +In your user-settings the following settings can be helpful: |
| 29 | + |
| 30 | +```json |
| 31 | + "[lua]": { |
| 32 | + "editor.defaultFormatter": "JohnnyMorganz.stylua", |
| 33 | + "editor.formatOnSave": true, |
| 34 | + "editor.formatOnSaveMode": "file" |
| 35 | + }, |
| 36 | + "[luau]": { |
| 37 | + "editor.defaultFormatter": "JohnnyMorganz.stylua", |
| 38 | + "editor.formatOnSave": true, |
| 39 | + "editor.formatOnSaveMode": "file" |
| 40 | + }, |
| 41 | + |
| 42 | + // Explorer |
| 43 | + "explorer.confirmDragAndDrop": false, |
| 44 | + "explorer.compactFolders": false, |
| 45 | + |
| 46 | + // Make init files not horrible |
| 47 | + "explorer.fileNesting.enabled": true, |
| 48 | + "explorer.fileNesting.patterns": { |
| 49 | + "init.lua": "*.lua", |
| 50 | + "*": "${basename}.*.${extname}" |
| 51 | + }, |
| 52 | + "workbench.editor.customLabels.patterns": { |
| 53 | + "**/init.lua": "${dirname}.lua" |
| 54 | + }, |
| 55 | +``` |
0 commit comments