chore: automate code-workspace creation with sort-workspaces

Author: gagik

mongosh.code-workspace

@@ -5,57 +5,33 @@
       "path": "."
     },
     {
-      "name": "📦 @mongosh/arg-parser",
-      "path": "packages/arg-parser"
+      "name": "📦 @mongodb-js/eslint-config-mongosh",
+      "path": "configs/eslint-config-mongosh"
     },
     {
-      "name": "📦 @mongosh/async-rewriter2",
-      "path": "packages/async-rewriter2"
+      "name": "📦 @mongodb-js/tsconfig-mongosh",
+      "path": "configs/tsconfig-mongosh"
     },
     {
-      "name": "📦 @mongosh/autocomplete",
-      "path": "packages/autocomplete"
+      "name": "📦 @mongosh/docker-build-scripts",
+      "path": "scripts/docker"
     },
     {
-      "name": "📦 @mongosh/browser-runtime-core",
-      "path": "packages/browser-runtime-core"
-    },
-    {
-      "name": "📦 @mongosh/browser-runtime-electron",
-      "path": "packages/browser-runtime-electron"
+      "name": "📦 @mongosh/async-rewriter2",
+      "path": "packages/async-rewriter2"
     },
     {
       "name": "📦 @mongosh/build",
       "path": "packages/build"
     },
-    {
-      "name": "📦 @mongosh/cli-repl",
-      "path": "packages/cli-repl"
-    },
-    {
-      "name": "📦 @mongosh/connectivity-tests",
-      "path": "packages/connectivity-tests"
-    },
-    {
-      "name": "📦 @mongosh/e2e-tests",
-      "path": "packages/e2e-tests"
-    }
-    {
-      "name": "📦 @mongosh/editor",
-      "path": "packages/editor"
-    },
     {
       "name": "📦 @mongosh/errors",
       "path": "packages/errors"
-    }
+    },
     {
       "name": "📦 @mongosh/history",
       "path": "packages/history"
     },
-    {
-      "name": "📦 @mongosh/i18n",
-      "path": "packages/i18n"
-    },
     {
       "name": "📦 @mongosh/java-shell",
       "path": "packages/java-shell"
@@ -64,13 +40,25 @@
       "name": "📦 @mongosh/js-multiline-to-singleline",
       "path": "packages/js-multiline-to-singleline"
     },
+    {
+      "name": "📦 @mongosh/types",
+      "path": "packages/types"
+    },
+    {
+      "name": "📦 @mongosh/i18n",
+      "path": "packages/i18n"
+    },
     {
       "name": "📦 @mongosh/logging",
       "path": "packages/logging"
     },
     {
-      "name": "📦 @mongosh/node-runtime-worker-thread",
-      "path": "packages/node-runtime-worker-thread"
+      "name": "📦 @mongosh/shell-bson",
+      "path": "packages/shell-bson"
+    },
+    {
+      "name": "📦 @mongosh/arg-parser",
+      "path": "packages/arg-parser"
     },
     {
       "name": "📦 @mongosh/service-provider-core",
@@ -85,8 +73,8 @@
       "path": "packages/shell-api"
     },
     {
-      "name": "📦 @mongosh/shell-bson",
-      "path": "packages/shell-bson"
+      "name": "📦 @mongosh/autocomplete",
+      "path": "packages/autocomplete"
     },
     {
       "name": "📦 @mongosh/shell-evaluator",
@@ -97,12 +85,40 @@
       "path": "packages/snippet-manager"
     },
     {
-      "name": "📦 @mongosh/types",
-      "path": "packages/types"
+      "name": "📦 @mongosh/browser-runtime-core",
+      "path": "packages/browser-runtime-core"
+    },
+    {
+      "name": "📦 @mongosh/editor",
+      "path": "packages/editor"
+    },
+    {
+      "name": "📦 @mongosh/browser-runtime-electron",
+      "path": "packages/browser-runtime-electron"
+    },
+    {
+      "name": "📦 @mongosh/cli-repl",
+      "path": "packages/cli-repl"
+    },
+    {
+      "name": "📦 @mongosh/e2e-tests",
+      "path": "packages/e2e-tests"
+    },
+    {
+      "name": "📦 mongosh",
+      "path": "packages/mongosh"
+    },
+    {
+      "name": "📦 @mongosh/node-runtime-worker-thread",
+      "path": "packages/node-runtime-worker-thread"
     },
     {
       "name": "📦 @mongosh/browser-repl",
       "path": "packages/browser-repl"
+    },
+    {
+      "name": "📦 @mongosh/connectivity-tests",
+      "path": "packages/connectivity-tests"
     }
   ],
   "settings": {
@@ -118,6 +134,8 @@
     "testExplorer.gutterDecoration": true
   },
   "extensions": {
-    "recommendations": ["hbenl.vscode-mocha-test-adapter"]
+    "recommendations": [
+      "hbenl.vscode-mocha-test-adapter"
+    ]
   }
 }

scripts/sort-workspaces.js

@@ -1,11 +1,11 @@
 #!/usr/bin/env node
 
-const fs = require('fs').promises;
-const path = require('path');
-const util = require('util');
-const exec = util.promisify(require('child_process').exec);
+const fs = require("fs").promises;
+const path = require("path");
+const util = require("util");
+const exec = util.promisify(require("child_process").exec);
 
-process.on('unhandledRejection', (err) => {
+process.on("unhandledRejection", (err) => {
   console.error();
   console.error(err?.stack || err?.message || err);
   process.exitCode = 1;
@@ -14,21 +14,47 @@ process.on('unhandledRejection', (err) => {
 async function main() {
   if (process.env.CI) return;
 
-  const monorepoRoot = path.resolve(__dirname, '..');
+  const monorepoRoot = path.resolve(__dirname, "..");
 
-  const packageJSON = JSON.parse(await fs.readFile(
-    path.join(monorepoRoot, 'package.json'),
-    'utf8'
-  ));
+  // Get sorted packages from lerna
+  const { stdout } = await exec("npx -y lerna ls --all --toposort --json");
+  const packages = JSON.parse(stdout);
 
-  // should use the scopes in lerna.json
-  const { stdout } = await exec('npx -y lerna ls --all --toposort --json');
-  packageJSON.workspaces = JSON.parse(stdout).map(({ location }) => path.relative(monorepoRoot, location));
+  // Update package.json
+  const packageJSON = JSON.parse(
+    await fs.readFile(path.join(monorepoRoot, "package.json"), "utf8")
+  );
+
+  packageJSON.workspaces = packages.map(({ location }) =>
+    path.relative(monorepoRoot, location)
+  );
+
+  await fs.writeFile(
+    path.join(monorepoRoot, "package.json"),
+    JSON.stringify(packageJSON, null, 2) + "\n",
+    "utf8"
+  );
+
+  // Update mongosh.code-workspace
+  const workspaceFile = path.join(monorepoRoot, "mongosh.code-workspace");
+  const workspace = JSON.parse(await fs.readFile(workspaceFile, "utf8"));
+
+  // Keep the root folder and regenerate package folders in topological order
+  workspace.folders = [
+    {
+      name: "mongosh",
+      path: ".",
+    },
+    ...packages.map(({ name, location }) => ({
+      name: `📦 ${name}`,
+      path: path.relative(monorepoRoot, location),
+    })),
+  ];
 
   await fs.writeFile(
-    path.join(monorepoRoot, 'package.json'),
-    JSON.stringify(packageJSON, null, 2) + '\n',
-    'utf8'
+    workspaceFile,
+    JSON.stringify(workspace, null, 2) + "\n",
+    "utf8"
   );
 }