New-VSCodeTask.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
<#PSScriptInfo
.VERSION 1.2.0
.AUTHOR Roman Kuzmin
.COPYRIGHT (c) Roman Kuzmin
.TAGS Invoke, Task, Invoke-Build, VSCode
.GUID b8b2b532-28f6-443a-b0b1-079a66dd4ce3
.LICENSEURI http://www.apache.org/licenses/LICENSE-2.0
.PROJECTURI https://github.com/nightroman/Invoke-Build
#>


<#
.Synopsis
    Makes VSCode tasks from Invoke-Build tasks
 
.Description
    The script creates "./.vscode/tasks.json". The existing file is replaced.
    Change to the VSCode workspace directory before invoking the script.
    Generated VSCode tasks call Invoke-Build tasks.
 
    Do not edit "tasks.json" directly. Edit the build script instead. When you
    add, remove, rename tasks, or change script locations then regenerate.
 
    The default task becomes the so called VSCode build task (Ctrl+Shift+B).
    The default task is "." if it exists, otherwise it is the first task.
 
    To invoke another task from VSCode, hit F1 or Ctrl+Shift+P, type "Run
    Task", type a task name or select it from the task list. Even better,
    set your keyboard shortcut for "workbench.action.tasks.runTask".
 
    Only tasks with certain names are included. They contain alphanumeric
    characters, "_", ".", and "-", with the first character other than "-".
 
.Parameter BuildFile
        Specifies the build script path, absolute or relative. By default it is
        the default script in the current location, i.e. in the workspace root.
.Parameter InvokeBuild
        Specifies the Invoke-Build.ps1 path, absolute or relative. If it is not
        specified then any found in the workspace is used. If there is none
        then the command Invoke-Build is used.
.Parameter Shell
        Specifies the name or path of the powershell or pwsh executable.
        The default is "powershell.exe".
.Parameter WhereTask
        Tells to filter tasks and specifies the filter script block. The script
        checks the task $_ and gets $true/$false in order to include/exclude.
 
.Example
    > New-VSCodeTask
 
    This command binds to the default build script in the workspace root and
    Invoke-Build.ps1 either in the workspace root or subdirectory or in the
    path or the module command.
 
.Example
    > New-VSCodeTask ./Scripts/Build.ps1 ./packages/InvokeBuild/Invoke-Build.ps1
 
    This command uses relative build and engine script paths. The second may be
    omitted, Invoke-Build.ps1 will be discovered. But it is needed if there may
    be several Invoke-Build.ps1 in the workspace.
 
.Example
    > New-VSCodeTask -WhereTask {$_.Name -notlike "_*" -and $_.Jobs.Count -ge 2}
 
    This command filters tasks and tells to exclude tasks like "_*" and include
    tasks with two or more jobs.
#>


[CmdletBinding()]
param(
    [string]$BuildFile,
    [string]$InvokeBuild,
    [string]$Shell = 'powershell.exe',
    [scriptblock]$WhereTask
)

function Add-Text([string]$Text) {if ($args) {$out.Write($Text, $args)} else {$out.Write($Text)}}
function Add-Line([string]$Text) {if ($args) {$out.WriteLine($Text, $args)} else {$out.WriteLine($Text)}}

trap {$PSCmdlet.ThrowTerminatingError($_)}
$ErrorActionPreference = 'Stop'

# resolve Invoke-Build.ps1
if (!$InvokeBuild) {
    $InvokeBuild2 = @(Get-ChildItem . -Name -Recurse -Filter Invoke-Build.ps1)
    $InvokeBuild = if ($InvokeBuild2) {
        './{0}' -f $InvokeBuild2[0]
    } else {
        'Invoke-Build'
    }
}
$InvokeBuild2 = if ($InvokeBuild -eq 'Invoke-Build') {
    'Invoke-Build'
}
else {
    "& '{0}'" -f $InvokeBuild.Replace('\', '/').Replace("'", "''")
}

### write tasks.json header
$out = New-Object System.IO.StringWriter
$Header = '// Do not edit! This file is generated by New-VSCodeTask.ps1'
Add-Line $Header
Add-Line '// Modify the build script instead and regenerate this file.'
Add-Line '{'
Add-Line ' "version": "2.0.0",'
Add-Line ' "windows": {'
Add-Line ' "options": {'
Add-Line ' "shell": {'
Add-Line ' "executable": "{0}",' ($Shell.Replace('\', '\\'))
Add-Line ' "args": [ "-NoProfile", "-ExecutionPolicy", "Bypass", "-Command" ]'
Add-Line ' }'
Add-Line ' }'
Add-Line ' },'
Add-Line ' "linux": {'
Add-Line ' "options": {'
Add-Line ' "shell": {'
Add-Line ' "executable": "/usr/bin/pwsh",'
Add-Line ' "args": [ "-NoProfile", "-Command" ]'
Add-Line ' }'
Add-Line ' }'
Add-Line ' },'
Add-Line ' "osx": {'
Add-Line ' "options": {'
Add-Line ' "shell": {'
Add-Line ' "executable": "/usr/local/bin/pwsh",'
Add-Line ' "args": [ "-NoProfile", "-Command" ]'
Add-Line ' }'
Add-Line ' }'
Add-Line ' },'
Add-Line ' "tasks": ['

# get all tasks and the default task
$all = & $InvokeBuild ?? -File $BuildFile
$dot = if ($all['.']) {'.'} else {$all.Item(0).Name}

# get task list, optionally filtered
if ($WhereTask) {
    $tasks = @($all.Values | Where-Object $WhereTask)
}
else {
    $tasks = $all.Values
}

### write tasks.json tasks
$BuildFile2 = if ($BuildFile) {" -File '{0}'" -f $BuildFile.Replace('\', '/').Replace("'", "''")} else {''}
foreach($task in $tasks) {
    $name = $task.Name
    if ($name -match '[^\w\.\-]|^-') {
        continue
    }
    Add-Line ' {'
    Add-Line ' "label": "{0}",' $name
    Add-Line ' "type": "shell",'
    Add-Line ' "problemMatcher": [ "$msCompile" ],'
    if ($name -eq $dot) {
        Add-Line ' "group": {'
        Add-Line ' "kind": "build",'
        Add-Line ' "isDefault": true'
        Add-Line ' },'
    }
    Add-Line ' "command": "{0} -Task {1}{2}"' $InvokeBuild2 $name $BuildFile2
    Add-Line ' },'
}

### write ? task and ending
Add-Line ' {'
Add-Line ' "label": "?",'
Add-Line ' "type": "shell",'
Add-Line ' "problemMatcher": [],'
Add-Line ' "command": "{0} -Task ?{1}"' $InvokeBuild2 $BuildFile2
Add-Line ' }'
Add-Line ' ]'
Add-Text '}'

### save the file
if (!(Test-Path .vscode)) {
    $null = mkdir .vscode
}
elseif (Test-Path ./.vscode/tasks.json) {
    $line1, $null = Get-Content ./.vscode/tasks.json
    if ($line1 -ne $Header) {
        Remove-Item ./.vscode/tasks.json -Confirm
        if (Test-Path ./.vscode/tasks.json) {return}
    }
}
Set-Content ./.vscode/tasks.json $out.ToString() -Encoding UTF8