Add local-vscode-extension-rig and migrate VS Code extensions to it

common/config/rush/nonbrowser-approved-packages.json

@@ -276,7 +276,7 @@
     },
     {
       "name": "@rushstack/heft-vscode-extension-rig",
-      "allowedCategories": [ "vscode-extensions" ]
+      "allowedCategories": [ "libraries" ]
     },
     {
       "name": "@rushstack/heft-web-rig",
@@ -700,7 +700,7 @@
     },
     {
       "name": "fast-glob",
-      "allowedCategories": [ "libraries" ]
+      "allowedCategories": [ "libraries", "vscode-extensions" ]
     },
     {
       "name": "fastify",
@@ -718,10 +718,6 @@
       "name": "git-repo-info",
       "allowedCategories": [ "libraries" ]
     },
-    {
-      "name": "glob",
-      "allowedCategories": [ "libraries", "vscode-extensions" ]
-    },
     {
       "name": "heft-action-plugin",
       "allowedCategories": [ "tests" ]
@@ -862,6 +858,10 @@
       "name": "local-node-rig",
       "allowedCategories": [ "libraries", "tests", "vscode-extensions" ]
     },
+    {
+      "name": "local-vscode-extension-rig",
+      "allowedCategories": [ "vscode-extensions" ]
+    },
     {
       "name": "local-web-rig",
       "allowedCategories": [ "libraries", "tests", "vscode-extensions" ]

rigs/local-vscode-extension-rig/README.md

@@ -0,0 +1,6 @@
+# local-vscode-extension-rig
+
+A rig package for VSCode Extension projects that build using Heft inside the RushStack repository. This
+package extends `local-node-rig` and adds some options that are specific to VScode extensions.
+
+Note that this rig is not published to the NPM registry.

rigs/local-vscode-extension-rig/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "local-vscode-extension-rig",
+  "version": "1.0.0",
+  "description": "A rig package for VSCode extension projects that build using Heft inside the RushStack repository.",
+  "license": "MIT",
+  "private": true,
+  "scripts": {
+    "build": "",
+    "_phase:build": ""
+  },
+  "dependencies": {
+    "@rushstack/heft-vscode-extension-plugin": "workspace:*",
+    "@rushstack/heft-vscode-extension-rig": "workspace:*",
+    "@rushstack/heft": "workspace:*",
+    "@rushstack/webpack-preserve-dynamic-require-plugin": "workspace:*",
+    "eslint": "~9.37.0",
+    "local-eslint-config": "workspace:*",
+    "local-node-rig": "workspace:*",
+    "typescript": "~5.8.2"
+  }
+}

rigs/local-vscode-extension-rig/profiles/default/config/api-extractor-base.json

@@ -0,0 +1,5 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+
+  "extends": "local-node-rig/profiles/default/config/api-extractor-base.json"
+}

rigs/local-vscode-extension-rig/profiles/default/config/api-extractor-task.json

@@ -0,0 +1,5 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/heft/v0/api-extractor-task.schema.json",
+
+  "extends": "local-node-rig/profiles/default/config/api-extractor-task.json"
+}

rigs/local-vscode-extension-rig/profiles/default/config/heft.json

@@ -0,0 +1,25 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/heft/v0/heft.schema.json",
+
+  "extends": "@rushstack/heft-vscode-extension-rig/profiles/default/config/heft.json",
+
+  "phasesByName": {
+    "build": {
+      "cleanFiles": [{ "includeGlobs": ["lib-esnext"] }],
+
+      "tasksByName": {
+        "lint": {
+          "taskPlugin": {
+            "options": {
+              "sarifLogPath": "temp/build/lint/lint.sarif"
+            }
+          }
+        }
+      }
+    },
+
+    "test": {
+      "cleanFiles": [{ "includeGlobs": ["coverage"] }]
+    }
+  }
+}

rigs/local-vscode-extension-rig/profiles/default/config/jest.config.json

@@ -0,0 +1,3 @@
+{
+  "extends": "local-node-rig/profiles/default/config/jest.config.json"
+}

rigs/local-vscode-extension-rig/profiles/default/config/rush-project.json

@@ -0,0 +1,3 @@
+{
+  "extends": "local-node-rig/profiles/default/config/rush-project.json"
+}

rigs/local-vscode-extension-rig/profiles/default/config/typescript.json

@@ -0,0 +1,5 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/heft/v0/typescript.schema.json",
+
+  "extends": "local-node-rig/profiles/default/config/typescript.json"
+}

rigs/local-vscode-extension-rig/profiles/default/includes/eslint/flat/mixins/friendly-locals.js

@@ -0,0 +1,6 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+
+const friendlyLocalsMixin = require('local-eslint-config/flat/mixins/friendly-locals');
+
+module.exports = [...friendlyLocalsMixin];

rigs/local-vscode-extension-rig/profiles/default/includes/eslint/flat/mixins/packlets.js

@@ -0,0 +1,6 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+
+const packletsMixin = require('local-eslint-config/flat/mixins/packlets');
+
+module.exports = [...packletsMixin];

rigs/local-vscode-extension-rig/profiles/default/includes/eslint/flat/mixins/react.js

@@ -0,0 +1,6 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+
+const reactMixin = require('local-eslint-config/flat/mixins/react');
+
+module.exports = [...reactMixin];

rigs/local-vscode-extension-rig/profiles/default/includes/eslint/flat/mixins/tsdoc.js

@@ -0,0 +1,6 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+
+const tsdocMixin = require('local-eslint-config/flat/mixins/tsdoc');
+
+module.exports = [...tsdocMixin];

rigs/local-vscode-extension-rig/profiles/default/includes/eslint/flat/patch/eslint-bulk-suppressions.js

@@ -0,0 +1,4 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+
+require('@rushstack/eslint-patch/eslint-bulk-suppressions');

rigs/local-vscode-extension-rig/profiles/default/includes/eslint/flat/profile/node-trusted-tool.js

@@ -0,0 +1,6 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+
+const nodeTrustedToolProfile = require('local-eslint-config/flat/profile/node-trusted-tool');
+
+module.exports = [...nodeTrustedToolProfile];

rigs/local-vscode-extension-rig/profiles/default/includes/eslint/flat/profile/node.js

@@ -0,0 +1,6 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+
+const nodeProfile = require('local-eslint-config/flat/profile/node');
+
+module.exports = [...nodeProfile];

rigs/local-vscode-extension-rig/profiles/default/tsconfig-base.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "http://json.schemastore.org/tsconfig",
+  "extends": "../../node_modules/local-node-rig/profiles/default/tsconfig-base.json"
+}

rigs/local-vscode-extension-rig/profiles/default/webpack.config.base.js

@@ -0,0 +1 @@
+module.exports = require('@rushstack/heft-vscode-extension-rig/profiles/default/webpack.config.base');

rush.json

@@ -1413,6 +1413,12 @@
       "reviewCategory": "libraries",
       "shouldPublish": false
     },
+    {
+      "packageName": "local-vscode-extension-rig",
+      "projectFolder": "rigs/local-vscode-extension-rig",
+      "reviewCategory": "libraries",
+      "shouldPublish": false
+    },
     {
       "packageName": "local-web-rig",
       "projectFolder": "rigs/local-web-rig",

vscode-extensions/debug-certificate-manager-vscode-extension/config/heft.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://developer.microsoft.com/json-schemas/heft/v0/heft.schema.json",
 
-  "extends": "@rushstack/heft-vscode-extension-rig/profiles/default/config/heft.json",
+  "extends": "local-vscode-extension-rig/profiles/default/config/heft.json",
 
   "phasesByName": {
     "build": {

vscode-extensions/debug-certificate-manager-vscode-extension/config/rig.json

@@ -1,5 +1,5 @@
 {
   "$schema": "https://developer.microsoft.com/json-schemas/rig-package/rig.schema.json",
 
-  "rigPackageName": "@rushstack/heft-vscode-extension-rig"
+  "rigPackageName": "local-vscode-extension-rig"
 }

vscode-extensions/debug-certificate-manager-vscode-extension/config/rush-project.json

@@ -1,4 +1,4 @@
 {
   "$schema": "https://developer.microsoft.com/json-schemas/rush/v5/rush-project.schema.json",
-  "extends": "@rushstack/heft-vscode-extension-rig/profiles/default/config/rush-project.json"
+  "extends": "local-vscode-extension-rig/profiles/default/config/rush-project.json"
 }

vscode-extensions/debug-certificate-manager-vscode-extension/eslint.config.js

@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
 
-const nodeTrustedToolProfile = require('@rushstack/heft-vscode-extension-rig/profiles/default/includes/eslint/flat/profile/node-trusted-tool');
-const friendlyLocalsMixin = require('@rushstack/heft-vscode-extension-rig/profiles/default/includes/eslint/flat/mixins/friendly-locals');
+const nodeTrustedToolProfile = require('local-vscode-extension-rig/profiles/default/includes/eslint/flat/profile/node-trusted-tool');
+const friendlyLocalsMixin = require('local-vscode-extension-rig/profiles/default/includes/eslint/flat/mixins/friendly-locals');
 
 module.exports = [...nodeTrustedToolProfile, ...friendlyLocalsMixin];

vscode-extensions/debug-certificate-manager-vscode-extension/package.json

@@ -122,11 +122,11 @@
     "tslib": "~2.8.1"
   },
   "devDependencies": {
-    "@rushstack/heft-vscode-extension-rig": "workspace:*",
     "@rushstack/heft": "workspace:*",
     "@types/node": "20.17.19",
     "@types/vscode": "1.103.0",
-    "@types/webpack-env": "1.18.8"
+    "@types/webpack-env": "1.18.8",
+    "local-vscode-extension-rig": "workspace:*"
   },
   "sideEffects": false
 }

vscode-extensions/debug-certificate-manager-vscode-extension/src/certificates.ts

@@ -1,10 +1,11 @@
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
 
-import { getConfig } from './config';
 import { CertificateManager, CertificateStore } from '@rushstack/debug-certificate-manager';
 import type { ITerminal } from '@rushstack/terminal';
 
+import { getConfig } from './config';
+
 export function getCertificateManager(terminal: ITerminal): CertificateManager {
   const { caCertificateFilename, keyFilename, certificateFilename, storePath } = getConfig(terminal);
   const certificateManager: CertificateManager = new CertificateManager({

vscode-extensions/debug-certificate-manager-vscode-extension/src/config.ts

@@ -1,10 +1,13 @@
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
 
-import * as vscode from 'vscode';
 import * as path from 'node:path';
+
+import * as vscode from 'vscode';
+
 import type { ITerminal } from '@rushstack/terminal';
 import type { ICertificateStoreOptions } from '@rushstack/debug-certificate-manager';
+
 import {
   CONFIG_AUTOSYNC,
   CONFIG_SECTION,
@@ -29,8 +32,7 @@ export function getConfig(terminal: ITerminal): IExtensionConfig {
     config.get(CONFIG_CERTIFICATE_FILENAME) || 'rushstack-serve.pem';
   const keyFilename: string | undefined = config.get(CONFIG_KEY_FILENAME) || 'rushstack-serve.key';
   const autoSync: boolean = config.get(CONFIG_AUTOSYNC) ?? false;
-  const homeDirectory: string | undefined =
-    config.get<string>(CONFIG_HOME_DIRECTORY) || undefined;
+  const homeDirectory: string | undefined = config.get<string>(CONFIG_HOME_DIRECTORY) || undefined;
   let storePath: string | undefined = undefined;
 
   const platformMap: Record<string, keyof StorePaths> = {

vscode-extensions/debug-certificate-manager-vscode-extension/src/constants.ts

@@ -1,5 +1,6 @@
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
+
 import packageJson from '../package.json';
 
 export const EXTENSION_DISPLAY_NAME: string = 'Debug Certificate Manager';