vscode-spx

Language and intelliSense support for the SPX JavaScript/TypeScript framework. Provides syntax highlighting, directive completions and various enhancements those leveraging SPX in their projects.

Key Features

Syntax Highlighting for spx-* annotations in markup.
Supports grammar targeting for highlight customizations.
SPX Specific Directive Completions with descriptions.
Event Directive Completions with MDN descriptions.
Component Completions with state defined referencing.
IntelliSense for state, events and nodes within workspace.

Usage

The extension exposes an enabled/disable workspace settings which can be used to either activate or deactivate directive completions. Syntax highlighting is automatically applied using HTML grammar injections, as such all spx-* attribute occurrences within markup languages apply highlighting.

Given the large data set applied to event directives, one may prefer to disable the extension when they are not working with SPX.

Settings

The below workspace settings are made available:

{
  "spx.enable": true,   // Enable/Disable directive completions
  "spx.files": [],      // Provide components glob for completions in markup files
  "spx.languages": [      // Additional languages extensions which enable spx
    "html",
    "liquid
  ]
}

Contributing

Contributions are welcome! This project uses pnpm for package management and is written in TypeScript.

Ensure pnpm is installed globally npm i pnpm -g
Leverage pnpm env if you need to align node versions
Clone this repository git clone https://github.com/panoply/vscode-spx.git
Run pnpm i in the root directory
Run pnpm dev for development mode

Developing

The project uses tsup for producing the distributed bundle. You can produce a VSIX by running the pnpm build command. The .vscode/launch.json file contains the extension host logic.

pnpm dev         # Development in watch mode
pnpm build       # Builds extension and packages VSIX
pnpm data        # Generates the html-data schema files

Support

Follow me on X and say hello! Thought there is no obligation, but coffee is always appreciated.

PayPal: Donate
BTC: 35wa8ChA5XvzfFAn5pMiWHWg251xDqxT51

🥛 Νίκος Σαβίδης

License

Licensed under MIT

SPX

panoply