build.ps1/build_helpers.ps1 issues
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 35/100
- Issue type
- Refactor
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- powershell
- Domain
- build-system, tooling
Research direction
Read build.ps1 and tools/build-helpers.ps1, starting with ParseJasmine and RunSpecs, then review ExtractAtom and the build entry points against the linked lines. Done means the listed help, attribute, invocation, path, and parsing issues are addressed without breaking the build or Jasmine output.
Written by the indexing model from the issue text.
Description
Issue Description
build.ps1
- comment based help attempt to include an argument to the example statement, this causes PowerShell to invalidate the comment based help entirely.
https://github.com/PowerShell/EditorSyntax/blob/cf27d6e54ff9fc593bfb46d22a671898fb31c0a9/build.ps1#L10 [cmdletbinding()]and[parameter()]attributes are unnecessary.
https://github.com/PowerShell/EditorSyntax/blob/cf27d6e54ff9fc593bfb46d22a671898fb31c0a9/build.ps1#L28-L33- use of
&(call operator) to execute commands with an unquoted (and non-expanded) name are unnecessary. (3 occurrences total)
https://github.com/PowerShell/EditorSyntax/blob/cf27d6e54ff9fc593bfb46d22a671898fb31c0a9/build.ps1#L41
tools\build_helpers.ps1
function ExtractAtom
- doesn't support UNC paths due to
$PSScriptRootandResolve-Pathwill format with thefilesystem::provider, which notation is not acceptable to[System.IO.Compression.ZipFile]::ExtractToDirectory()method. This is informational only, due to the fact that UNC paths do not work for NPM anyway.
function ParseJasmine
- first line starts with using
$stringparameter, the rest use$_. Surprisingly it works, but only because inRunSpecsthe call toParseJasmineis part of aForEach-Objectwhich populates the$_automatic variable. - the
^\s+Expectedreplacement doesn't seem to be working correctly. Maybe Atom/Atom-Grammar-Test has changed? I think 'to equal' now is to be 'instead found'. - this function should really be a filter as it might provide a better fit. Note, also demonstrating the 'switch' statement with -regex parameter:
This requires changingfilter ParseJasmine { switch -regex ($_) { ^\s+at { '' break } ^\s+it { $_ -replace '^(\s+)(it)', '$1[-] It' break } ^\s+Expected { $_ -replace '^(\s*)(Expected.*?)\s(instead found .*)', "`$1`$2`n`$1`$3" break } default { $_ } } }RunSpecs:
https://github.com/PowerShell/EditorSyntax/blob/cf27d6e54ff9fc593bfb46d22a671898fb31c0a9/tools/build-helpers.ps1#L73
to read more like:& $script:ATOM_EXE_PATH --test $specpath *>&1 | ParseJasmine
function RunSpecs
- quotes around the variable
$script:ATOM_EXE_PATHare unneeded, probably old habit from CMD or another shell? (seen below) - test path 'specs' is literal on ATOM command, but yet in a variable
$specpathin a test previously. Only issue with using the variable is a chance to get the PowerShellfilesystem::provider notation injected.
https://github.com/PowerShell/EditorSyntax/blob/cf27d6e54ff9fc593bfb46d22a671898fb31c0a9/tools/build-helpers.ps1#L72-L73
I'll post a PR shortly demonstrating these changes.
- Dominant language
- PowerShell
- Stars
- 151
- Forks
- 55
- PR merge metrics
- No merged PRs in 30d
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from PowerShell/EditorSyntax
-
Difficulty 3/5 1-2 days Newbie friendliness 55/100
PowerShell/EditorSyntax#224 · 2 comments ·
-
Difficulty 3/5 1-2 days Newbie friendliness 48/100
PowerShell/EditorSyntax#222 · 2 comments ·
-
Difficulty 3/5 1-2 days Newbie friendliness 55/100
PowerShell/EditorSyntax#221 · 2 comments ·
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
PowerShell/EditorSyntax#220 · 2 comments · 1 reaction ·
-
Issue-Bug
Difficulty 3/5 1-2 days Newbie friendliness 48/100
PowerShell/EditorSyntax#219 · 2 comments ·
All issues in PowerShell/EditorSyntax
Similar issues
-
kind/bug
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
kubernetes-sigs/prow#953 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
zephyrproject-rtos/zephyr#119726 ·
-
out-of-date
Difficulty 1/5 Under an hour Newbie friendliness 82/100
CachyOS/CachyOS-PKGBUILDS#1894 ·
-
comp/dashboard P3 type/bug
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
NousResearch/hermes-agent#117722 ·
-
bug
Difficulty 1/5 Under an hour Newbie friendliness 92/100
objectionary/jeo-maven-plugin#1760 ·