Convert scripts package to type: "module" (#1579)

Author: askoufis

scripts/build-dts.ts

@@ -1,6 +1,7 @@
 import { existsSync } from 'fs';
 import fs from 'fs/promises';
 import path from 'path';
+import { pathToFileURL } from 'url';
 
 import glob from 'fast-glob';
 import { legacy, resolve } from 'resolve.exports';
@@ -90,41 +91,45 @@ async function removePreconstructDeclarations(
   });
 }
 
-(async () => {
-  const packages = await glob('packages/*', {
-    onlyDirectories: true,
-    absolute: true,
-  });
+const packages = await glob('packages/*', {
+  onlyDirectories: true,
+  absolute: true,
+});
 
-  const entryPaths: [string, string][] = [];
+const entryPaths: [string, string][] = [];
 
-  for (const packageDir of packages) {
-    const pkg = require(path.resolve(packageDir, 'package.json'));
+for (const packageDir of packages) {
+  const pkg = await import(
+    // oathToFileURL enables the result of `path.resolve` to work with `import()` on windows
+    pathToFileURL(path.resolve(packageDir, 'package.json')).toString(),
+    {
+      with: { type: 'json' },
+    }
+  );
 
-    if (pkg.exports) {
-      const pkgExports = Object.keys(pkg.exports);
+  if (pkg.exports) {
+    const pkgExports = Object.keys(pkg.exports);
 
-      for (const entryName of pkgExports) {
-        if (entryName.endsWith('package.json')) continue;
+    for (const entryName of pkgExports) {
+      if (entryName.endsWith('package.json')) continue;
 
-        entryPaths.push([packageDir, resolveEntry(pkg, entryName)]);
-      }
-    } else {
-      entryPaths.push([packageDir, resolveEntry(pkg)]);
+      entryPaths.push([packageDir, resolveEntry(pkg, entryName)]);
     }
+  } else {
+    entryPaths.push([packageDir, resolveEntry(pkg)]);
   }
+}
 
-  await Promise.all(
-    entryPaths.map(([packageDir, entryPath]) =>
-      buildEntry(packageDir, entryPath),
-    ),
-  ).then((writes) => writes.map((write) => write?.()));
-
-  // Entry points might reference each other so remove old declaration files
-  // after we're done with everything
-  await Promise.all(
-    entryPaths.map(([packageDir, entryPath]) =>
-      removePreconstructDeclarations(packageDir, entryPath),
-    ),
-  );
-})();
+await Promise.all(
+  entryPaths.map(([packageDir, entryPath]) =>
+    buildEntry(packageDir, entryPath),
+  ),
+).then((writes) => writes.map((write) => write?.()));
+
+// Entry points might reference each other so remove old declaration files
+// after we're done with everything
+await Promise.all(
+  entryPaths.map(([packageDir, entryPath]) =>
+    removePreconstructDeclarations(packageDir, entryPath),
+  ),
+);

scripts/copy-next-plugin.ts

@@ -1,32 +1,30 @@
-import { glob } from 'fast-glob';
+import glob from 'fast-glob';
 import { existsSync } from 'fs';
 import fs from 'fs/promises';
 import path from 'path';
 
 // We need to use distinct next plugins for each next fixutre
 // due to different next versions / mini-css-extract-plugin serializer registration
-(async () => {
-  const nextPluginDistDir = path.join(
-    __dirname,
-    '../packages/next-plugin/dist',
-  );
+const nextPluginDistDir = path.join(
+  import.meta.dirname,
+  '../packages/next-plugin/dist',
+);
 
-  if (!existsSync(nextPluginDistDir)) {
-    throw new Error('packages/next-plugin/dist is missing.');
-  }
+if (!existsSync(nextPluginDistDir)) {
+  throw new Error('packages/next-plugin/dist is missing.');
+}
 
-  const nextFixtureDirs = await glob('fixtures/next-*', {
-    onlyDirectories: true,
-    absolute: true,
-  });
+const nextFixtureDirs = await glob('fixtures/next-*', {
+  onlyDirectories: true,
+  absolute: true,
+});
 
-  if (nextFixtureDirs.length === 0) {
-    throw new Error('No next fixtures found.');
-  }
+if (nextFixtureDirs.length === 0) {
+  throw new Error('No next fixtures found.');
+}
 
-  for (const dir of nextFixtureDirs) {
-    await fs.cp(nextPluginDistDir, path.join(dir, 'next-plugin', 'dist'), {
-      recursive: true,
-    });
-  }
-})();
+for (const dir of nextFixtureDirs) {
+  await fs.cp(nextPluginDistDir, path.join(dir, 'next-plugin', 'dist'), {
+    recursive: true,
+  });
+}

scripts/copy-readme-to-packages.ts

@@ -3,17 +3,15 @@ import path from 'path';
 
 import glob from 'fast-glob';
 
-(async () => {
-  const packages = await glob('packages/*', {
-    onlyDirectories: true,
-    absolute: true,
-    ignore: ['packages/sprinkles', 'packages/integration'],
-  });
+const packages = await glob('packages/*', {
+  onlyDirectories: true,
+  absolute: true,
+  ignore: ['packages/sprinkles', 'packages/integration', 'packages/compiler'],
+});
 
-  for (const packageDir of packages) {
-    await fs.copyFile(
-      path.join(__dirname, '../README.md'),
-      path.join(packageDir, 'README.md'),
-    );
-  }
-})();
+for (const packageDir of packages) {
+  await fs.copyFile(
+    path.join(import.meta.dirname, '../README.md'),
+    path.join(packageDir, 'README.md'),
+  );
+}

scripts/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@vanilla-extract/scripts",
   "private": true,
+  "type": "module",
   "devDependencies": {
     "fast-glob": "^3.2.7",
     "resolve.exports": "^2.0.2",