An open API service indexing awesome lists of open source software.

https://github.com/sdm-lang/sdml-sublime-text

Sublime Text package for SDML
https://github.com/sdm-lang/sdml-sublime-text

sdml sublime-package sublime-snippets sublime-syntax

Last synced: about 2 months ago
JSON representation

Sublime Text package for SDML

Awesome Lists containing this project

README

          

# SDML Package for Sublime Text

![SDML Logo Text](https://raw.githubusercontent.com/sdm-lang/.github/main/profile/horizontal-text.svg)

This is a reasonably complete [package](https://www.sublimetext.com/docs/packages.html) for the [Sublime Text](https://www.sublimetext.com/) editor. The provided syntax highlighting is mostly complete
except for formal constraints and type-class method definitions.

Additionally, the invaluable [bat](https://github.com/sharkdp/bat) command-line tool uses `.sublime-syntax` files to do
terminal source highlighting.

A Github workflow attaches a downloadable `.sublime-package` file to each [release](https://github.com/sdm-lang/sdml-sublime-text/releases/).

## Features

Syntax highlighting based on a [`.sublime-syntax`](https://www.sublimetext.com/docs/syntax.html) grammar.

![Sublime Text Highlighting](./images/sublime.png)

Grammar integrated into the `bat` pager.

![Bat Highlighting](./images/sublime-bat.png)

## Installation

The install script provided will clone this repository into your Sublime Text package location and, if you have `bat`
installed, link the repository into the `bat` configuration folder.

```bash
curl https://raw.githubusercontent.com/sdm-lang/sdml-sublime-text/main/install.sh | sh
```

Alternatively, you can download a release zip file from Github and unzip on the Sublime Text Packages directory.

## License(s)

The contents of this repository are made available under the following
licenses:

### Apache-2.0

> ```text
> Copyright 2025 Simon Johnston
>
> Licensed under the Apache License, Version 2.0 (the "License");
> you may not use this file except in compliance with the License.
> You may obtain a copy of the License at
>
> http://www.apache.org/licenses/LICENSE-2.0
>
> Unless required by applicable law or agreed to in writing, software
> distributed under the License is distributed on an "AS IS" BASIS,
> WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
> See the License for the specific language governing permissions and
> limitations under the License.
> ```

See the enclosed file [LICENSE-Apache](https://github.com/sdm-lang/sdml-sublime-text/blob/main/LICENSE-APACHE).

### MIT

> ```text
> Copyright 2025 Simon Johnston
>
> Permission is hereby granted, free of charge, to any person obtaining a copy
> of this software and associated documentation files (the “Software”), to deal
> in the Software without restriction, including without limitation the rights to
> use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
> the Software, and to permit persons to whom the Software is furnished to do so,
> subject to the following conditions:
>
> The above copyright notice and this permission notice shall be included in all
> copies or substantial portions of the Software.
>
> THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
> INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
> PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
> HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
> OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
> SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
> ```

See the enclosed file [LICENSE-MIT](https://github.com/sdm-lang/sdml-sublime-text/blob/main/LICENSE-MIT).

### Contributions

Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall
be dual licensed as above, without any additional terms or conditions.

## Changes

**Version: 0.1.0**

* Initial release, syntax highlighting only.

## TODO

1. Copy over snippets from the TextMate bundle.
1. Add configuration for a [build system](https://www.sublimetext.com/docs/build_systems.html).