Enable Sublime Syntax testing framework

Open
#124 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
45/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
powershell
Domain
documentation, testing-qa

Research direction

Start with spec/testfiles/syntax_test_TheBigTestFile.ps1 and compare its header and assertion lines with Sublime Text's syntax test format. Review the contribution guidelines for the appropriate location, then run Sublime Text's built-in or headless syntax test runner. Done means the repository tests use a supported format and contributors have instructions for running them.

Written by the indexing model from the issue text.

Description

Up-for-Grabs

Please include in your contribution guidelines, instructions on how to run the syntax tests.
I tried using the built in Sublime Text build system for Syntax Tests, and found that the files in this repo are using an invalid format for Sublime Text's test runner.

The header line refers to a scope, but it should be a syntax definition path/file name.
Some test assertion lines contain gaps on the assertions, which are currently not supported in Sublime Text.
image

If this is fixed, it would be possible to use continuous integration with Sublime Text's headless syntax test runner, to verify that PRs have no failing tests.

Dominant language
PowerShell
Stars
151
Forks
55
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from PowerShell/EditorSyntax

All issues in PowerShell/EditorSyntax

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.