vscode-just - GitLite

KO | EN

gitlite — search

#react #llm #go #machine-learning #deep-learning #docker #macos #java #windows #kubernetes #security #ios #mcp #open-source

vscode-just

(★ 267)

VSCode syntax highlighting for just files

File Explorer

Download Latest Version (.zip)

- devcontainer.json
- - ci.yml
- dependabot.template..yml
- pull_request_template.md
- extensions.json
- launch.json
- settings.json
- tasks.json
- example.just
- example.png
- robot.png
- - extension.test.ts
- const.ts
- extension.ts
- format.ts
- genScopes.ts
- launcher.ts
- logger.ts
- lsp.ts
- recipe.ts
- tasks.ts
- types.ts
- utils.ts
- - JavaScript.tmLanguage.json
  - MagicPython.tmLanguage.json
  - MagicRegExp.tmLanguage.json
  - perl.tmLanguage.json
  - perl6.tmLanguage.json
  - ruby.tmLanguage.json
  - shell-unix-bash.tmLanguage.json
  - TypeScript.tmLanguage.json
- just.tmLanguage.json
- just.tmLanguage.yml
- scopes
.dockerignore
.gitattributes
.gitignore
.prettierignore
.prettierrc.yaml
.vscode-test.mjs
.vscodeignore
CHANGELOG.md
CONTRIBUTING.md
docker-compose.yml
Dockerfile
eslint.config.mjs
justfile
language-configuration.json
LICENSE
package.json
README.md
tsconfig.json
webpack.config.mjs
yarn.lock

# Installation Guide

1. Get the code

git clone https://github.com/nefrob/vscode-just

Downloads the entire project code from GitHub to your computer.

cd vscode-just

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

docker compose up -d --build

Builds and starts all defined containers (server, database, etc.) at once, in the background.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Node.js

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# vscode-just

![license](https://img.shields.io/github/license/nefrob/vscode-just?style=flat-square)
![ci](https://github.com/nefrob/vscode-just/actions/workflows/ci.yml/badge.svg?branch=main)
[![Gitmoji](https://img.shields.io/badge/gitmoji-%20😜%20😍-FFDD67.svg?style=flat-square)](https://gitmoji.dev)

VSCode syntax highlighting extension for the [just](https://github.com/casey/just) language.

Contents:

- [Features](#features)
- [Known Issues](#known-issues)
- [Publishing](#publishing)
- [Release Notes](#release-notes)
- [Roadmap](#roadmap)
- [Contributing](#contributing)
- [References](#references)

## Features

Basic syntax highlighting for `just` files:

- Comments
- Variable assignment and settings
- Strings & interpolation blocks
- Recipes: recipe attributes, names, params and dependencies
- Keywords, constants and operators
- Some embedded languages
- Integration with [just-lsp](https://github.com/terror/just-lsp)

Commands:

- Format on save
- Run recipe
- Task running

Demo:

-  VSCode with `just` syntax highlighting
   <img src="./assets/example.png" style="max-width: 75%;" alt="syntax highlight example" />

- GitHub syntax highlighting
    
    ```just
    # Demo

set tempdir := "/tmp"

export MY_VAR := `./my_script.sh`

[confirm("Continue?")]
    @foo PARAM_1="hello" PARAM_2="world" +ARGS="":
        echo {{ PARAM_1 }} {{ PARAM_2 }} {{ ARGS }}

python:
        #!/usr/bin/env python3
        print('Hello from python!')

```

## Known Issues

This extension does simple and/or best effort syntax highlighting. It is not intended to be 100% comprehensive, but rather provide a good enough experience for most users. That being said, if you find a bug or missing feature, please open an issue or a pull request.

### Nesting and scoping

Since expressions can have deep nesting and we cannot tell the scope based on indentation or other markers, we run into the following issues. These are limitations of TextMate grammars and is not easily fixable. 
  
- Expression and recipe specific rules pollute the global repository scopes, meaning we apply `just` highlighting within recipe bodies. This means `just` keywords/operators/etc, like `if`, will highlight everywhere. This is necessary to highlight expressions correctly elsewhere.

- Some nested expressions will break due to lack of awareness of depth and preemptively match a closing character. Ex.

```just
    echo {{ '{{ string }}' }}
    ```

will echo `{{ string }}` since braces within the string are escaped and part of the string's scope. Textmate can't handle this without a full parser, so will match on the first closing brace it finds.

- Line breaking and expressions that span multiple lines may not highlight correctly. As a simple example

```just
    foo param1 \
        param2='foo':
    echo {{param1}} {{param2}}
    ```

## Publishing

This extension is available on the following marketplaces:

- [VSCode](https://marketplace.visualstudio.com/items?itemName=nefrob.vscode-just-syntax)
- [OpenVSX](https://open-vsx.org/extension/nefrob/vscode-just-syntax)

If you are using an open source build of VSCode, you might need to install the extension manually. To do so:

1. Navigate to the latest [release](https://github.com/nefrob/vscode-just/releases) and download the `.vsix` file.
2. Copy the file to your `.vscode/extensions` directory.
3. Install via the command line: `code --install-extension .vscode/extensions/vscode-just-X.Y.Z.vsix`

## Release Notes

See [CHANGELOG.md](CHANGELOG.md).

## Roadmap

Outstanding:

- [ ] Improve handling of recipe body highlighting
- [ ] Improve handling of embedded languages
- [ ] Inline command runner
- [ ] Support code outline

Completed:

- [x] Initial release
- [x] Update with new `just` releases
- [x] Migrate to `yaml` grammar for composability and readability
- [x] Add snapshot testing
- [x] Publish to [open source marketplaces](https://open-vsx.org/)
- [x] Format on save
- [x] Run recipe
- [x] Default formatter support
- [x] Integrate [just-lsp](https://github.com/terror/just-lsp)

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md).

## References

- [TextMate Language Grammars](https://macromates.com/manual/en/language_grammars)

- Previous iterations on `just` syntax grammars
  - [shellock/vscode-just](https://github.com/skellock/vscode-just)
  - [sclu1034/vscode-just](https://github.com/sclu1034/vscode-just/)
- [Example language grammars](https://github.com/microsoft/vscode-textmate/tree/09effd8b7429b71010e0fa34ea2e16e622692946/test-cases/themes/syntaxes)
- [Just manual](https://just.systems/man/en/)
- [Packaging and publishing extensions](https://code.visualstudio.com/api/working-with-extensions/publishing-extension)