Skip to content

Commit

Permalink
docs: add starlark writing tips
Browse files Browse the repository at this point in the history
  • Loading branch information
leeederek committed Dec 4, 2023
1 parent f7fd938 commit 8a2ced3
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/docs/api-reference/starlark-reference/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,22 @@ pagination_next: api-reference/starlark-reference/standard-library

This section details the Kurtosis Starlark DSL used to manipulate the contents of enclaves. Feel free to use the [official Kurtosis Starlark VS Code extension][vscode-plugin] when writing Starlark with VSCode for features like syntax highlighting, method signature suggestions, hover preview for functions, and auto-completion for Kurtosis custom types.

Useful tips for using and writing Starlark
------------------------------------------
If you're using Visual Studio Code, you may find our [Kurtosis VS Code Extension][vscode-plugin] helpful when writing Starlark.

If you're using Vim, you can add the following to your `.vimrc` to get Starlark syntax highlighting:

```
" Add syntax highlighting for Starlark files
autocmd FileType *.star setlocal filetype=python
```

or if you use Neovim:
```
autocmd BufNewFile,BufRead *.star set filetype=python
```

Parameter Naming Convention
---------------------------

Expand Down
4 changes: 4 additions & 0 deletions docs/docs/get-started/write-your-first-package.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,10 @@ If you're using Vim, you can add the following to your `.vimrc` to get Starlark
autocmd FileType *.star setlocal filetype=python
```

or if you use Neovim:
```
autocmd BufNewFile,BufRead *.star set filetype=python
```
:::

Finally, [run][kurtosis-run-reference] the script (we'll explain enclaves in the "Review" section):
Expand Down

0 comments on commit 8a2ced3

Please sign in to comment.