Add packaging script and placeholder files

benmcmorran · benmcmorran · commit 4d8eee8c64e4 · 2023-01-26T17:03:49.000-08:00
diff --git a/.vscodeignore b/.vscodeignore
@@ -17,4 +17,8 @@ webpack.config.js
 node_modules/**
 vendor/**
 azure-pipelines.yml
-build/**
+build/**
+assets/platform/**
+
+# A platform-specific directory in assets/platform/ will be added to the end of
+# this file by the packaging script.
diff --git a/assets/platform/alpine-arm64/placeholder.txt b/assets/platform/alpine-arm64/placeholder.txt
@@ -0,0 +1 @@
+This is a placeholder file that should only be installed on alpine-arm64.
diff --git a/assets/platform/alpine-x64/placeholder.txt b/assets/platform/alpine-x64/placeholder.txt
@@ -0,0 +1 @@
+This is a placeholder file that should only be installed on alpine-x64.
diff --git a/assets/platform/darwin-arm64/placeholder.txt b/assets/platform/darwin-arm64/placeholder.txt
@@ -0,0 +1 @@
+This is a placeholder file that should only be installed on darwin-arm64.
diff --git a/assets/platform/darwin-x64/placeholder.txt b/assets/platform/darwin-x64/placeholder.txt
@@ -0,0 +1 @@
+This is a placeholder file that should only be installed on darwin-x64.
diff --git a/assets/platform/linux-arm64/placeholder.txt b/assets/platform/linux-arm64/placeholder.txt
@@ -0,0 +1 @@
+This is a placeholder file that should only be installed on linux-arm64.
diff --git a/assets/platform/linux-armhf/placeholder.txt b/assets/platform/linux-armhf/placeholder.txt
@@ -0,0 +1 @@
+This is a placeholder file that should only be installed on linux-armhf.
diff --git a/assets/platform/linux-x64/placeholder.txt b/assets/platform/linux-x64/placeholder.txt
@@ -0,0 +1 @@
+This is a placeholder file that should only be installed on linux-x64.
diff --git a/assets/platform/win32-arm64/placeholder.txt b/assets/platform/win32-arm64/placeholder.txt
@@ -0,0 +1 @@
+This is a placeholder file that should only be installed on win32-arm64.
diff --git a/assets/platform/win32-ia32/placeholder.txt b/assets/platform/win32-ia32/placeholder.txt
@@ -0,0 +1 @@
+This is a placeholder file that should only be installed on win32-ia32.
diff --git a/assets/platform/win32-x64/placeholder.txt b/assets/platform/win32-x64/placeholder.txt
@@ -0,0 +1 @@
+This is a placeholder file that should only be installed on win32-x64.
diff --git a/azure-pipelines.yml b/azure-pipelines.yml
@@ -66,7 +66,7 @@ steps:
     displayName: Use Node 16.x
     inputs:
       versionSpec: 16.x
-  - script: npm install --global gulp node-gyp vsce
+  - script: npm install --global gulp node-gyp @vscode/vsce
     displayName: Install global dependencies
   - script: npm install
     displayName: Install project dependencies
@@ -87,14 +87,14 @@ steps:
   # Pack the extension now even though it's unsigned so that we ignore files
   # from .vscodeignore. This will reduce load on the signing server later and
   # ensure we only attempt to sign shipping files.
-  - script: vsce package --out vscode-arduino.vsix
+  - script: node build/package.js
     displayName: Build and pack extension
 
-  # Extract the VSIX, sign what we can, then pack it back up and publish it.
+  # Extract the VSIXes, sign what we can, then pack it back up and publish it.
   - task: ExtractFiles@1
     displayName: Extract extension for signing
     inputs:
-      archiveFilePatterns: vscode-arduino.vsix
+      archiveFilePatterns: out\vsix\*.vsix
       destinationFolder: $(Build.StagingDirectory)\vscode-arduino
   - task: NuGetToolInstaller@1
     displayName: Install NuGet
diff --git a/build/package.js b/build/package.js
@@ -0,0 +1,41 @@
+// Copyright (c) Microsoft Corporation.
+
+const { execSync } = require("child_process");
+const { mkdirSync, readFileSync, writeFileSync } = require("fs");
+const { resolve } = require("path");
+const { argv } = require("process");
+
+const flags = argv.slice(2).join(" ");
+
+// Taken from https://code.visualstudio.com/api/working-with-extensions/publishing-extension#platformspecific-extensions
+const platforms = [
+  "win32-x64",
+  "win32-ia32",
+  "win32-arm64",
+  "linux-x64",
+  "linux-arm64",
+  "linux-armhf",
+  "alpine-x64",
+  "alpine-arm64",
+  "darwin-x64",
+  "darwin-arm64",
+];
+
+// We include different files for each platform, so we need to build a custom
+// .vscodeignore file based on common file and platform-specific path.
+const ignoreFile = readFileSync(resolve(__dirname, "..", ".vscodeignore"), "utf8");
+const customIgnoreFilePath = resolve(__dirname, "..", "out", ".vscodeignore");
+
+execSync('npm run build', { cwd: resolve(__dirname, ".."), stdio: "inherit" });
+mkdirSync(resolve(__dirname, "..", "out", "vsix"), { recursive: true });
+for (const platform of platforms) {
+  writeFileSync(
+    customIgnoreFilePath,
+    ignoreFile + `!assets/platform/${platform}/**`
+  );
+  const command = `vsce package --target ${platform} --out out/vsix/vscode-arduino-${platform}.vsix ${flags}`;
+  execSync(command, {
+    cwd: resolve(__dirname, ".."),
+    stdio: "inherit",
+  });
+}
diff --git a/package.json b/package.json
@@ -6,7 +6,7 @@
   "publisher": "vsciot-vscode",
   "preview": true,
   "engines": {
-    "vscode": "^1.56.0"
+    "vscode": "^1.61.0"
   },
   "icon": "images/arduino.png",
   "license": "SEE LICENSE IN LICENSE.txt",
@@ -595,7 +595,7 @@
     ]
   },
   "scripts": {
-    "vscode:prepublish": "gulp build --mode=production",
+    "build": "gulp build --mode=production",
     "postinstall": "cd ./src/views && npm install",
     "test": "gulp test"
   },
@@ -669,5 +669,8 @@
     "node-sass": "^7.0.0",
     "es5-ext": "0.10.53",
     "string_decoder": "https://github.com/microsoft/vscode-arduino/releases/download/v0.4.12-rc2/string_decoder-10.0.0.tgz"
+  },
+  "vsce": {
+    "ignoreFile": "out/.vscodeignore"
   }
 }

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+This is a placeholder file that should only be installed on alpine-arm64.`