sku 13.4.0 → 13.4.1

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # sku
 
+## 13.4.1
+
+### Patch Changes
+
+- `sku init`: Add a `pnpm.onlyBuiltDependencies` field to the `package.json` file if `pnpm` v10 is detected ([#1160](https://github.com/seek-oss/sku/pull/1160))
+
+  As of [`pnpm` v10], dependency lifecycle scripts are no longer run by default. Instead, explicit permission must be given on a per-dependency basis.
+
+  New `sku` projects will have this field added automatically if `pnpm` v10 is detected in order to ensure `sku` and its dependencies can run necessary lifecycle scripts after installation.
+
+  [`pnpm` v10]: https://github.com/pnpm/pnpm/releases/tag/v10.0.0
+
 ## 13.4.0
 
 ### Minor Changes

package/lib/packageManager.js

@@ -37,15 +37,24 @@ const validatePackageManager = (packageManager) => {
 const getPackageManagerFromUserAgent = () => {
   const userAgent = process.env.npm_config_user_agent || '';
 
+  // Default to 'npm'
+  let packageManager = 'npm';
+
+  let version = null;
+  if (userAgent) {
+    // User agents typically look like `pnpm/9.12.1 npm/? node/v20.17.0 linux x64`
+    version = userAgent.split(' ')?.[0].split('/')?.[1];
+  }
+
   if (userAgent.includes('yarn')) {
-    return 'yarn';
+    packageManager = 'yarn';
   }
 
   if (userAgent.includes('pnpm')) {
-    return 'pnpm';
+    packageManager = 'pnpm';
   }
 
-  return 'npm';
+  return { packageManager, version };
 };
 
 /** @type {Record<SupportedPackageManager, string>} */
@@ -61,8 +70,9 @@ const lockfileByPackageManager = {
  * If the project does not have a root directory, `rootDir` will be `null`.
  */
 const getPackageManager = () => {
+  const userAgentPackageManager = getPackageManagerFromUserAgent();
   const packageManager = validatePackageManager(
-    skuArgs?.packageManager || getPackageManagerFromUserAgent(),
+    skuArgs?.packageManager || userAgentPackageManager.packageManager,
   );
 
   const lockFile = lockfileByPackageManager[packageManager];
@@ -72,10 +82,14 @@ const getPackageManager = () => {
   /** @type {string | null} */
   const rootDir = lockFilePath ? path.dirname(lockFilePath) : null;
 
-  return { packageManager, rootDir };
+  return {
+    packageManager,
+    rootDir,
+    packageManagerVersion: userAgentPackageManager.version,
+  };
 };
 
-const { rootDir, packageManager } = getPackageManager();
+const { rootDir, packageManager, packageManagerVersion } = getPackageManager();
 
 /**
  * @param {SupportedPackageManager} agent
@@ -178,6 +192,7 @@ const getPackageManagerInstallPage = () => INSTALL_PAGE[packageManager];
 module.exports = {
   rootDir,
   packageManager,
+  packageManagerVersion,
   isYarn,
   isPnpm,
   isNpm,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sku",
-  "version": "13.4.0",
+  "version": "13.4.1",
   "description": "Front-end development toolkit, powered by Webpack, Babel, Vanilla Extract and Jest",
   "types": "./sku-types.d.ts",
   "bin": {
@@ -152,6 +152,7 @@
     "@types/prettier": "^2.7.3",
     "@types/react": "^18.2.3",
     "@types/react-dom": "^18.2.3",
+    "@types/semver": "^7.5.8",
     "@types/webpack-bundle-analyzer": "^4.7.0",
     "@types/wrap-ansi": "^3.0.0",
     "@vanilla-extract/css": "^1.0.0",

package/scripts/init.js

@@ -5,6 +5,7 @@ const {
   getRunCommand,
   getPackageManagerInstallPage,
   getInstallCommand,
+  packageManagerVersion,
 } = require('../lib/packageManager');
 
 const chalk = require('chalk');
@@ -22,6 +23,7 @@ const toPosixPath = require('../lib/toPosixPath');
 const trace = require('debug')('sku:init');
 const { fdir: Fdir } = require('fdir');
 const { Eta } = require('eta');
+const semver = require('semver');
 
 const args = require('../config/args');
 
@@ -145,6 +147,23 @@ const packageNameRegex =
       format: 'sku format',
     },
   };
+
+  const isAtLeastPnpmV10 =
+    packageManager === 'pnpm' &&
+    packageManagerVersion &&
+    semver.satisfies(packageManagerVersion, '>=10.0.0');
+
+  if (isAtLeastPnpmV10) {
+    trace(
+      'PNPM version is >= 10.0.0, adding "pnpm.onlyBuiltDependencies" to package.json',
+    );
+    // Allows `pnpm` to run `sku`'s, and its dependencies', build scripts
+    // See https://pnpm.io/package_json#pnpmonlybuiltdependencies
+    packageJson.pnpm = {
+      onlyBuiltDependencies: ['sku', '@swc/core', 'esbuild'],
+    };
+  }
+
   const packageJsonString = JSON.stringify(packageJson, null, 2);
 
   await fs.writeFile(path.join(root, 'package.json'), packageJsonString);