@flux-lang/vscode-flux 0.1.13 → 0.1.14

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +26 -22
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -1,35 +1,39 @@
1
1
  # Flux VS Code Extension
2
2
  [![VS Code Marketplace](https://img.shields.io/visual-studio-marketplace/v/cbassuarez.flux-language-support)](https://marketplace.visualstudio.com/items?itemName=cbassuarez.flux-language-support)
3
3
  [![VS Code Installs](https://img.shields.io/visual-studio-marketplace/i/cbassuarez.flux-language-support)](https://marketplace.visualstudio.com/items?itemName=cbassuarez.flux-language-support)
4
- [![Flux IR v0.1](https://img.shields.io/badge/Flux%20IR-v0.1-00CDFE)](./docs/flux-v0_1.md)
4
+ [![Flux Spec](https://img.shields.io/badge/Flux-spec-00CDFE)](../../spec/overview.md)
5
5
  [![License: MIT](https://img.shields.io/github/license/cbassuarez/flux)](../../LICENSE)
6
6
 
7
- This extension adds first-class editor support for the **Flux** score language — a grid-based notation and rule language for spatial music and graphic scores.
7
+ 1) **What this package is**
8
+ Language support for the Flux score language (syntax highlighting + diagnostics).
8
9
 
9
- ## Features
10
+ 2) **When you use it**
11
+ Use it in VS Code to edit `.flux` files with syntax and diagnostic support.
10
12
 
11
- - Syntax highlighting for `.flux` files:
12
- - Core keywords (`document`, `state`, `grid`, `cell`, `rule`, `when`, `then`, `runtime`, etc.).
13
- - Logical operators, event types, and the `neighbors.*` namespace.
14
- - On-the-fly diagnostics powered by `@flux-lang/core`:
15
- - Parse errors surfaced as editor diagnostics.
16
- - Basic static checks (unknown `grid = ...`, invalid timers, unsupported `neighbors.*` methods).
17
- - Plays nicely with the `flux` CLI:
18
- - `flux parse` → canonical IR JSON.
19
- - `flux check` → parse + static checks, same engine as the extension.
13
+ 3) **Install**
20
14
 
21
- ## Flux IR
15
+ ```bash
16
+ code --install-extension cbassuarez.flux-language-support
17
+ ```
22
18
 
23
- Flux has a well-defined JSON IR (intermediate representation) that mirrors the TypeScript `FluxDocument` AST.
19
+ 4) **Basic usage**
20
+ - Open a `.flux` file and run the command **Flux: Show IR JSON for Current File**.
24
21
 
25
- - IR docs: `packages/core/docs/flux-v0_1.md` (or wherever you’ve put the spec).
26
- - Programmatically: `parseDocument(source)` from `@flux-lang/core` + `JSON.stringify`.
22
+ 5) **Reference**
23
+ - **Language ID**: `flux`
24
+ - **File extension**: `.flux`
25
+ - **Command**: `flux.showIR` (shows IR JSON for the current file)
27
26
 
28
- ## Repository
27
+ 6) **How it relates to IR/runtime**
28
+ The extension uses `@flux-lang/core` to parse documents and surface diagnostics/IR tooling inside the editor.
29
29
 
30
- This extension lives in the `flux` monorepo:
30
+ 7) **Gotchas & troubleshooting**
31
+ - The extension only activates for `.flux` files.
31
32
 
32
- - GitHub: https://github.com/cbassuarez/flux
33
- - Core library: `packages/core`
34
- - CLI: `packages/cli`
35
- - VS Code extension: `packages/vscode-flux`
33
+ 8) **Versioning / compatibility notes**
34
+ TBD / Not yet implemented.
35
+
36
+ 9) **Links**
37
+ - Root Flux manual: [`../../README.md`](../../README.md)
38
+ - Extension package.json: [`package.json`](package.json)
39
+ - Source: [`src/`](src/)
package/package.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "name": "@flux-lang/vscode-flux",
3
3
  "displayName": "Flux Language Support",
4
4
  "publisher": "cbassuarez",
5
- "version": "0.1.13",
5
+ "version": "0.1.14",
6
6
  "description": "Language support for the Flux score language (syntax + diagnostics).",
7
7
  "license": "MIT",
8
8
  "author": "Sebastian Suarez-Solis",
@@ -71,7 +71,7 @@
71
71
  "theme": "dark"
72
72
  },
73
73
  "dependencies": {
74
- "@flux-lang/core": "^0.1.13"
74
+ "@flux-lang/core": "^0.1.14"
75
75
  },
76
76
  "devDependencies": {
77
77
  "@types/vscode": "^1.85.0",