https://github.com/sublimetext/syntax-test-action
Github Action to run syntax tests
https://github.com/sublimetext/syntax-test-action
github-actions hacktoberfest sublime-text
Last synced: 9 months ago
JSON representation
Github Action to run syntax tests
- Host: GitHub
- URL: https://github.com/sublimetext/syntax-test-action
- Owner: SublimeText
- License: mit
- Created: 2020-06-07T10:59:07.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-04-10T18:55:05.000Z (10 months ago)
- Last Synced: 2025-04-10T19:01:56.865Z (10 months ago)
- Topics: github-actions, hacktoberfest, sublime-text
- Language: Shell
- Homepage:
- Size: 52.7 KB
- Stars: 13
- Watchers: 6
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Sublime Text Syntax Test Action
Run syntax tests on your Sublime Text syntax definitions
using the ST syntax test binary.
## Usage
### Minimal Example
```yaml
name: Syntax Tests
on:
push:
paths:
- '**.sublime-syntax'
- '**/syntax_test_*'
- '**.tmPreferences'
pull_request:
paths:
- '**.sublime-syntax'
- '**/syntax_test_*'
- '**.tmPreferences'
jobs:
syntax_tests:
name: Syntax Tests (${{ matrix.build }})
runs-on: ubuntu-latest
timeout-minutes: 15 # default is 6 hours!
strategy:
matrix:
include:
- build: latest # This is the default
# packages: master # If you depend on a default syntax definition
- build: stable # Fetches the binary for the latest stable build
# packages: binary # Use respective tag for the selected binary build.
- build: 3210 # Latest known ST3 build with a test binary
# packages: v3189 # Latest ST3 tag on the Packages repo
steps:
- uses: actions/checkout@v4
- uses: SublimeText/syntax-test-action@v2
with:
build: ${{ matrix.build }}
# default_packages: ${{ matrix.packages }}
```
### Multiple Syntax Package Tests Example
```yaml
name: Multi Package Syntax Tests
on:
push:
paths:
- '**.sublime-syntax'
- '**/syntax_test_*'
- '**.tmPreferences'
pull_request:
paths:
- '**.sublime-syntax'
- '**/syntax_test_*'
- '**.tmPreferences'
jobs:
syntax_tests:
name: Syntax Tests (${{ matrix.build }})
runs-on: ubuntu-latest
timeout-minutes: 15 # default is 6 hours!
env:
package_name: My Package # install name as specified at packagecontrol.io
strategy:
matrix:
include:
- build: latest # This is the default
packages: master # default packages revision to use
less_ref: master # Less package revision to use
sass_ref: master # Sass package revision to use
- build: 3211 # Latest known ST3 build with a test binary
packages: v3211 # default packages revision to use
less_ref: master # Less package revision to use
sass_ref: master # Sass package revision to use
steps:
# Checkout primary package of this repository
# and all additionally required packages next to each other
# by specifying `path` for all.
# `path` should match the package's name from packagecontrol.io
# as this may be relevant for a package to work porperly.
- name: Checkout ${{ env.package_name }} (primary package)
uses: actions/checkout@v4
with:
path: ${{ env.package_name }}
- name: Checkout Less (dependency)
uses: actions/checkout@v4
with:
repository: SublimeText/Less
ref: ${{ matrix.less_ref }}
path: Less
- name: Checkout Sass/Scss (dependency)
uses: actions/checkout@v4
with:
repository: SublimeText/Sass
ref: ${{ matrix.sass_ref }}
path: Sass
# Run syntax test for primary package
# after installing default and additional packages
- name: Run Syntax Tests for Sublime Text ${{ matrix.build }}
uses: SublimeText/syntax-test-action@v2
with:
build: ${{ matrix.build }}
package_name: ${{ env.package_name }}
package_root: ${{ env.package_name }}
default_packages: ${{ matrix.packages }}
default_tests: false # default
additional_packages: Dummy,Less,Sass
additional_tests: false # default
# External syntax definitions,
# which are embedded without being tested in detail,
# can be created as empty dummies
# to just ensure their main scope is available.
dummy_syntaxes: source.livescript,source.postcss,source.sss,source.stylus
```
> **Note**
> You must use a separate job
> if you want to test multiple ST build
> or default packages versions.
> **Warning**
> It is important that you checkout your dependencies
> to a folder that is separate from your `package_root`,
> otherwise the dependency packages placed in a subfolder
> would be treated (and tested) as a part of your package.
## Inputs
| Name | Default | Description |
| :----------------------- | :-------------- | :---------- |
| **build** | `"latest"` | ST build that should be installed as an integer. `"latest"` is for the dev channel, `"stable"` for the stable channel. Not all builds are available. |
| **default\_packages** | `"false"` | Install the [default packages][] and which version. Accepts any git ref, e.g. `"master"`, or `"binary"` for the tag of the respective binary. Note that the corresponding tag may not always exist. |
| **default\_tests** | `false` | Whether to keep the tests of the default packages. |
| **additional\_packages** | `""` | Comma-separated list of paths to additionally checked out packages to install (e.g.: `LESS,third-party/Sass`). Uses the folders' base names as the package names to install as. |
| **additional\_tests** | `false` | Whether to keep the tests of the additional packages. |
| **package\_root** | `"."` | Path to the package root that is linked to the testing Packages folder. |
| **package\_name** | Repository name | Name to install the package as. |
| **dummy\_syntaxes** | `""` | Comma-separated list of base scopes to create empty syntaxes for, e.g. `source.postcss,source.stylus`. |
[default packages]: https://github.com/sublimehq/Packages/
## Changelog
### v2
### v2.5 (2025-04-10)
- Added support for the new syntax test output format of build 4181.
(@michaelblyons, #24, #25)
- Added support for multi-line error messages with the new format.
(@FichteFoll, #29)
- Added warnings for incorrectly named syntax test files
that the syntax test binary will ignore.
(@michaelblyons, #26, #27)
### v2.4 (2025-01-12)
- Added `dummy_syntaxes` input that creates empty syntax files
to satisfy external `embed`s that would otherwise result in CI failures.
(@FichteFoll, #13, #20)
- Added ability to specify `stable` for the `build` input,
which automatically determines the latest stable build.
(@FichteFoll, #21, #6)
- Added ability to specify `binary` for the `default_packages` input,
which automatically resolves to the closest tag on the repository.
(@FichteFoll, #21)
### v2.3 (2025-01-11)
- Fix dependencies for `ubuntu-24.04` runner.
(@deathaxe, #17, #18)
### v2.2 (2023-01-08)
- Support linking of multiple additional third-party packages
via `additional_packages` and `additional_tests`.
(@deathaxe, #12, #16)
### v2.1 (2021-06-07)
- Treat `'latest'` as an ST4 build now that the upstream URL has been updated.
(@FichteFoll)
- Group dependency installation, if necessary.
(@FichteFoll)
### v2.0 (2020-08-28)
- Updated to new upstream download paths. (@FichteFoll)
- Does not fetch dependencies anymore for 4077+. (@FichteFoll, #2)
- Changed from docker to composite action. (@FichteFoll)
### v1 (2020-06-07)
Initial working version
supporting ST3 and ST4 builds
as well as fetching the default packages.
(@FichteFoll)