Sline TextMate Grammar

A professional TextMate grammar definition for the Sline template language with support for syntax highlighting across multiple platforms.

Features

✨ Comprehensive Syntax Highlighting

• Full Sline template language support
• Comment detection and highlighting
• Schema block recognition
• Tag and object syntax highlighting

🔗 Multi-Language Embedding

• Sline in HTML
• Sline in JavaScript
• Sline in CSS
• Sline in JSON

🎯 Platform Support

• Visual Studio Code
• GitHub.com

Installation

Via npm

npm install @shoplineos/sline-textmate
# or
yarn add @shoplineos/sline-textmate

Manual

Download the sline.tmLanguage.json file and place it in your TextMate/VSCode grammar folder.

Usage

In Visual Studio Code

1. Install the @shoplineos/sline-textmate package:

   npm install --save-dev @shoplineos/sline-textmate

2. Reference in your VSCode extension or copy the grammar file to your extension's grammars directory.

Configuration Example

In your VSCode extension's package.json:

{
  "contributes": {
    "grammars": [
      {
        "language": "sline",
        "scopeName": "text.html.sline",
        "path": "./node_modules/@shoplineos/sline-textmate/grammars/sline.tmLanguage.json"
      }
    ]
  }
}

Syntax Reference

Comments

{{!-- This is a Sline comment --}}

Conditional Tags

<div>
  {{#if condition}}
    Content here
  {{/if}}
</div>

Platform Compatibility

| Platform | Status | Notes | |----------|--------|-------| | Visual Studio Code | ✅ Fully Supported | Recommended way to use | | GitHub Linguist | ✅ Supported | For syntax highlighting on GitHub |

Related Projects

• Shopline Developer Plugin
• VSCode HTML Grammar

Testing

Run the test suite:

# Run all tests
npm test

# Update snapshots
npm run test:updateSnapshots

Development

Setup

# Install dependencies
npm install

# Convert YAML grammar to JSON
npm run yamlToJson

Project Structure

sline-textmate/
├── grammars/              # TextMate grammar files
│   ├── sline.tmLanguage.json
│   └── sline.tmLanguage.yaml
├── test/                  # Test files
│   ├── fixtures/          # Test fixtures
│   ├── snapshots/         # Test snapshots
│   └── helpers/           # Test helpers
├── scripts/               # Build scripts
└── package.json

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Support

For issues, questions, or suggestions, please open an issue on GitHub.

Maintained by: Shopline
Repository: github.com/shoplineos/sline-textmate