Merge pull request #556 from jpogran/buildscript

(maint) Convert gulp script to psake file

Author: jpogran

.github/workflows/vscode-ci.yml

@@ -46,23 +46,44 @@ jobs:
           choco install pdk
         if: runner.os == 'Windows'
 
-      - name: npm install, build, and test
+      - name: Install psake
+        shell: pwsh
+        run: Install-Module psake -Force
+
+      - name: npm install
+        shell: pwsh
+        run: |
+          npm install -g vsce --silent;
+          npm install -g typescript --silent;
+          npm install --silent;
+
+      - name: npm build
+        shell: pwsh
+        run: |
+          invoke-psake -taskList 'build'
+
+      - name: npm test
         env:
-          BUILD_VERSION: "0.99.${{ github.event.number }}"
+          BUILD_VERSION: '0.99.${{ github.event.number }}'
           VSCODE_BUILD_VERBOSE: true
           DISPLAY: ':99.0'
+        shell: pwsh
         run: |
-          npm install -g vsce --silent;
-          npm install --silent;
-          node node_modules/gulp/bin/gulp.js bump --version $BUILD_VERSION;
-          node node_modules/gulp/bin/gulp.js initial;
           npm test --silent
+
+      - name: vsce package
+        if: runner.os == 'Linux'
+        env:
+          BUILD_VERSION: '0.99.${{ github.event.number }}'
+        shell: pwsh
+        run: |
+          invoke-psake -properties @{ packageVersion = $env:BUILD_VERSION } -tasklist bump
           mkdir artifacts
-          vsce package --out artifacts/puppet-vscode-$BUILD_VERSION.vsix
+          vsce package --out artifacts/puppet-vscode-$env:BUILD_VERSION.vsix
 
       - name: upload vsix
         if: runner.os == 'Linux'
         uses: actions/upload-artifact@master
         with:
-          name: "puppet-vscode"
+          name: 'puppet-vscode'
           path: artifacts

.travis.yml

@@ -24,6 +24,26 @@ env:
       nodejs_arch: "x64"
       VSCE_TASK: package
 
+matrix:
+  include:
+    - os: linux
+      dist: trusty
+      sudo: false
+      addons:
+        apt:
+          sources:
+            - sourceline: "deb [arch=amd64] https://packages.microsoft.com/ubuntu/14.04/prod trusty main"
+              key_url: "https://packages.microsoft.com/keys/microsoft.asc"
+          packages:
+            - powershell
+    - os: osx
+      osx_image: xcode9.1
+      before_install:
+        - brew tap caskroom/cask
+        - brew cask install powershell
+  fast_finish: true
+
+
 before_install: true
 
 install:
@@ -59,8 +79,8 @@ install:
       npm --version;
       npm install -g vsce --silent;
       npm install --silent;
-      node node_modules/gulp/bin/gulp.js bump --version $BUILD_VERSION;
-      node node_modules/gulp/bin/gulp.js initial;
+      # node node_modules/gulp/bin/gulp.js bump --version $BUILD_VERSION;
+      pwsh -command invoke-psake -taskList 'initial';
     fi
 
 script:

CHANGELOG.md

@@ -7,6 +7,7 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
 ## [Unreleased]
 
 - ([GH-557](https://github.com/lingua-pupuli/puppet-vscode/issues/557)) Remove Docker Connection Handler
+- [maint] Convert gulp build script to psake
 
 ## [0.20.0] - 2019-08-30
 

README_BUILD.md

@@ -37,22 +37,24 @@ The following resources are vendored into the extension;
 
 * Puppet Editor Services (`editor-services`)
 
-* Puppet Editor Syntax (`editor-syntax`)
+* Puppet Editor Syntax (`editorSyntax`)
 
-By default the extension will use the specified versions in the `editor-components.json` file when vendoring resources.
+By default the extension will use the specified versions in the `package.json` file when vendoring resources.
 
 #### Example configuration
 
-The following examples use `editor-services`, however the configuration settings can be used on any resource.
+The following examples use `editorServices`, however the configuration settings can be used on any resource.
 
 ##### By release tag
 
 To use version `0.10.0` of the Editor Services;
 
 ``` json
 {
-  "editor-services": {
-    "release": "0.10.0"
+  "editorComponents":{
+    "editorServices": {
+      "release": "0.10.0"
+    }
   }
 }
 ```
@@ -63,17 +65,19 @@ To use a specific GitHub repository that contains the Puppet Editor services, us
 
 ``` json
 {
-  "editor-services": {
-    "githubuser": "Alice",
-    "githubrepo": "puppet-editing",
-    "githubref": "testing"
+  "editorComponents":{
+    "editorServices": {
+      "githubuser": "Alice",
+      "githubrepo": "puppet-editing",
+      "githubref": "testing"
+    }
   }
 }
 ```
 
-Note - For `editor-services` the default the githubuser is `lingua-pupuli` and the githubrepo is `puppet-editor-services`
+Note - For `editorServices` the default the githubuser is `lingua-pupuli` and the githubrepo is `puppet-editor-services`
 
-Note - For `editor-syntax` the default the githubuser is `lingua-pupuli` and the githubrepo is `puppet-editor-syntax`
+Note - For `editorSyntax` the default the githubuser is `lingua-pupuli` and the githubrepo is `puppet-editor-syntax`
 
 Note - Use the full length commit SHA for `githubref`, not the abbreviated eight character SHA
 
@@ -93,19 +97,29 @@ Note - Backslashes in the path must be escaped.
 
 ### Vendoring the resources into the extension
 
-* Use gulp to vendor the resources
-
-```bash
-> node node_modules/gulp/bin/gulp.js --series clean vendor
-[15:00:21] Using gulpfile C:\Source\puppet-vscode\gulpfile.js
-[15:00:21] Starting 'clean'...
-[15:00:21] Finished 'clean' after 7.9 ms
-[15:00:21] Starting 'vendor'...
-[15:00:21] Starting 'vendor_editor_services'...
-[15:00:25] Finished 'vendor_editor_services' after 3.88 s
-[15:00:25] Starting 'vendor_editor_syntax'...
-[15:00:27] Finished 'vendor_editor_syntax' after 2.24 s
-[15:00:27] Finished 'vendor' after 6.13 s
+* Use psake to vendor the resources
+
+```powershell
+> ./build.ps1 -task clean,vendor
+psake version 4.8.0
+Copyright (c) 2010-2018 James Kovacs & Contributors
+
+Executing clean
+Executing VendorEditorServices
+Executing VendorEditorSyntax
+
+psake succeeded executing C:\Users\james\src\lingua\client\psakefile.ps1
+
+----------------------------------------------------------------------
+Build Time Report
+----------------------------------------------------------------------
+Name                 Duration
+----                 --------
+Clean                00:00:00.075
+VendorEditorServices 00:00:01.601
+VendorEditorSyntax   00:00:00.338
+Vendor               00:00:00.000
+Total:               00:00:02.023
 ```
 
 * Start VS Code

appveyor.yml

@@ -35,22 +35,24 @@ install:
        & npm install --silent
 
        Write-Host "Set the package.json version..."
-       & node node_modules\gulp\bin\gulp.js bump --specific $ENV:APPVEYOR_BUILD_VERSION
+       invoke-psake -properties @{ packageVersion = $ENV:APPVEYOR_BUILD_VERSION } -tasklist bump
+
+       Install-Module -Name psake -Force
 
        Write-Host "Setting up initial configuration..."
-       & node node_modules\gulp\bin\gulp.js initial
+       invoke-psake -taskList 'initial'
      }
 - cmd: choco install pdk
 - ps: pdk --version
 
 build_script:
 - cmd: npm test --silent
-- cmd: IF NOT [%GULP_BUILD_TASK%] == [] node node_modules\gulp\bin\gulp.js %GULP_BUILD_TASK%
+- ps: if($env:GULP_BUILD_TASK) { invoke-psake -taskList $env:GULP_BUILD_TASK }
 - cmd: IF NOT [%VSCE_TASK%] == [] vsce %VSCE_TASK%
 
 test_script:
 - cmd: IF NOT [%NPM_TASK%] == [] npm run %NPM_TASK%
-- cmd: IF NOT [%GULP_TASK%] == [] node node_modules\gulp\bin\gulp.js %GULP_TASK%
+- ps: if($env:GULP_BUILD_TASK) { invoke-psake -taskList $env:GULP_BUILD_TASK }
 
 artifacts:
 - path: .\*.vsix

build.ps1

@@ -0,0 +1,15 @@
+[cmdletbinding()]
+param(
+  [string[]]$Task = 'default',
+  $properties
+)
+
+if (!(Get-Module -Name psake -ListAvailable)) {
+  Install-Module -Name psake -Scope CurrentUser
+}
+
+Invoke-psake `
+  -buildFile "$PSScriptRoot\psakefile.ps1" `
+  -properties $properties `
+  -taskList $Task `
+  -Verbose:$VerbosePreference