build-strap 6.1.0-main.167 → 6.1.0-main.168

package/README.md

@@ -10,13 +10,41 @@ This project builds itself, so take a look in the `targets/` folder for an examp
 [![devDependencies](https://img.shields.io/david/dev/murrayju/build-strap.svg)](https://david-dm.org/murrayju/build-strap?type=dev)
 
 ## Create a "zero dependency" bootstrapped build
-You can set up your project to build with (practically) no pre-requisite dependencies.
-- Copy the [build-strap-cli](https://github.com/murrayju/build-strap-cli/) into the root of your project.
+You can set up your project to build with (practically) no pre-requisite dependencies. [nub-strap](https://github.com/murrayju/nub-strap/) downloads a pinned version of [nub](https://nubjs.com) into the project. Nub then provides the pinned versions of node and yarn.
+- Copy the `nub` script from nub-strap into the root of your project, and pin the nub version in it.
 
 ```
-curl -o bs https://raw.githubusercontent.com/murrayju/build-strap-cli/master/bs && chmod +x bs
-curl -o bs.ps1 https://raw.githubusercontent.com/murrayju/build-strap-cli/master/bs.ps1
-curl -o bs.bat https://raw.githubusercontent.com/murrayju/build-strap-cli/master/bs.bat
+curl -o nub https://raw.githubusercontent.com/murrayju/nub-strap/main/nub && chmod +x nub
+```
+
+- Pin the node and yarn versions in your `package.json`.
+
+```
+{
+  "devEngines": {
+    "runtime": { "name": "node", "version": "24.18.0" }
+  },
+  "packageManager": "yarn@1.22.22"
+}
+```
+
+- Add a `yarn` script, which runs the pinned yarn with nub.
+
+```
+#!/bin/bash
+set -euo pipefail
+
+yarnJs=$(./nub pm which)
+exec ./nub --node "$yarnJs" "$@"
+```
+
+- Add a `bs` script, which installs dependencies and runs your build targets.
+
+```
+#!/bin/bash
+
+./yarn install
+exec ./nub ./targets/run.ts "$@"
 ```
 
 ## Add the dependency reference
@@ -32,8 +60,6 @@ By default, the build tools read project-specific configuration from your `packa
   "name": "your-project-name",
   "version": "1.2.3",
   "buildStrap": {
-    "nodeVersion": "24.18.0",
-    "yarnVersion": "1.22.22",
     "repoType": "git",
     "copyright": "your company",
     "mainBranch": "main",
@@ -94,7 +120,7 @@ setPkg(pkg);
 ### runCli
 Useful when building your own build from scratch. Helps to interpret CLI arguments and invoke js files as build targets. Uses `buildLog` to timestamp everything.
 
-This example should serve as your entrypoint (from `yarn run`).
+This example should serve as your entrypoint (for example, `./nub ./targets/run.ts`).
 ```
 import { run, runCli, setPkg } from 'build-strap';
 import pkg from '../package.json';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "build-strap",
-  "version": "6.1.0-main.167",
+  "version": "6.1.0-main.168",
   "description": "Node scripts for building things",
   "license": "MIT",
   "author": "Justin Murray <justin@murrayju.com>",

package/src/npm.js

@@ -11,7 +11,8 @@ export function getNpmConfig() {
 export const envNpmCreds = (process.env.NPM_CREDS && JSON.parse(process.env.NPM_CREDS)) || null;
 const npmExe = (npmPath) => npmPath || (platform() === 'win32' ? 'npm.cmd' : 'npm');
 export async function npm({ args = [], npmPath, spawnOptions, } = {}) {
-    const localNpm = path.join(path.dirname(process.execPath), 'lib/node_modules/npm/bin/npm-cli.js');
+    // The node distribution puts npm next to the node binary.
+    const localNpm = path.join(path.dirname(process.execPath), platform() === 'win32' ? '' : '../lib', 'node_modules/npm/bin/npm-cli.js');
     const spawnOpts = {
         env: process.env,
         shell: true,

package/src/pkg.d.ts

@@ -21,10 +21,12 @@ export interface PackageJson {
     dependencies?: Record<string, string>;
     description?: string;
     devDependencies?: Record<string, string>;
+    devEngines?: Record<string, unknown>;
     engines?: Record<string, string>;
     license?: string;
     main?: string;
     name: string;
+    packageManager?: string;
     peerDependencies?: Record<string, string>;
     private?: boolean;
     repository?: string | {

package/src/yarn.js

@@ -15,11 +15,15 @@ export async function yarn({ args = [], spawnOptions, } = {}) {
         stdio: 'inherit',
         ...spawnOptions,
     };
+    const projectYarn = path.resolve('yarn');
     return (await fs.pathExists(localYarn))
         ? // prefer to use local copy of yarn
             spawn(process.execPath, [localYarn, ...args], spawnOpts)
-        : // fall back to globally installed yarn
-            spawn('yarn', args, spawnOpts);
+        : (await fs.pathExists(projectYarn))
+            ? // use the yarn wrapper script of the project (for example, with nub)
+                spawn(projectYarn, args, spawnOpts)
+            : // fall back to globally installed yarn
+                spawn('yarn', args, spawnOpts);
 }
 export const yarnFiles = ['./package.json', './yarn.lock'];
 // Smart yarn invocation, only if package changed