incorrect assertions in test specs

Open
#176 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
48/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
powershell
Domain
testing-qa

Research direction

Start in spec/testfiles/syntax_test_TheBigTestFile.ps1 at the referenced ranges around lines 428, 569, 771, and 1181. Compare each assertion with the semantics described in issues #112, #62, and #132, then correct the misleading expectations and run the relevant spec tests to confirm the assertions match the grammar.

Written by the indexing model from the issue text.

Description

This is to point out some incorrect assertions in the spec tests.

https://github.com/PowerShell/EditorSyntax/blob/44eac8702f3cbe55a4ec70c1fdb163d42b4162fc/spec/testfiles/syntax_test_TheBigTestFile.ps1#L428-L430

The ++ is actually the unary increment operator, and PowerShell will flag this as an error because it cannot be used on a constant.
image

https://github.com/PowerShell/EditorSyntax/blob/44eac8702f3cbe55a4ec70c1fdb163d42b4162fc/spec/testfiles/syntax_test_TheBigTestFile.ps1#L569-L571

These are not operators in these instances, so even though the grammar scopes them as such, asserting these tests is misleading and will require correcting when the grammar is improved. This is covered in issue #112.

https://github.com/PowerShell/EditorSyntax/blob/44eac8702f3cbe55a4ec70c1fdb163d42b4162fc/spec/testfiles/syntax_test_TheBigTestFile.ps1#L771-L776

The # is this spec is not a line comment token. Its actually part of an unquoted non-expanding string that describes a function/command name. This is covered in issue #62.

(Example under PR #156)
image

https://github.com/PowerShell/EditorSyntax/blob/44eac8702f3cbe55a4ec70c1fdb163d42b4162fc/spec/testfiles/syntax_test_TheBigTestFile.ps1#L1181-L1187

Line 1186 specs the $ as definition.variable. This is covered in issue #132.

(Example under PR #156 I have scoped it as punctuation.section.embedded.begin)
image

This might only be a partial listing. This is some of the specs I am constantly looking at when checking my work. I list these more so that others can avoid needing to question these.

Dominant language
PowerShell
Stars
151
Forks
55
PR merge metrics
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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.