Rename 'node' target to 'bare-sidecar'

Author: kasperisager

README.md

@@ -30,23 +30,23 @@ module.exports = async function start(ipc, ready) {
 
 The `ipc` argument is a duplex byte stream. Anything written to it is delivered to the host, and `'data'` events fire when the host writes back.
 
-Stow it for the `node` target:
+Stow it for the `bare-sidecar` target:
 
 ```js
 const stow = require('bare-stow')
 
 const entry = new URL('file:///app/core.js')
 const out = new URL('file:///app/out/index.js')
 
-for await (const artifact of stow(entry, 'node', out)) {
+for await (const artifact of stow(entry, 'bare-sidecar', out)) {
   console.log(artifact.url.href)
 }
 ```
 
 Or equivalently from the command line:
 
 ```console
-$ bare-stow --target node --out ./out/index.js ./core.js
+$ bare-stow --target bare-sidecar --out ./out/index.js ./core.js
 ```
 
 This writes the harness to `out` and the bundle alongside it. The harness can then be required from the host and booted with `start()`. The harness awaits the worker's `ready` signal before resolving, so by the time `start()` returns the bundle is up:
@@ -118,7 +118,7 @@ await ipc.ready
 
 Bundle the module graph rooted at `entry` for a `target` runtime and write the resulting artifacts to disk at and alongside `out`. Returns an async generator that yields `{ url }` objects as each artifact is written, allowing callers to observe progress.
 
-`entry` is a `URL` (or `URL`-coercible string) pointing at the entry module. `target` selects the target runtime, given either as a built-in name (one of `'react-native'`, `'pear-runtime'`, or `'node'`) or as a [target provider](#targets-and-rpc-providers) object. It determines the harness format, bundle extension, host triples, and whether assets and addons are linked into the bundle or offloaded as sibling files. `out` is the output `URL` of the harness; the bundle is written next to it with the target's extension.
+`entry` is a `URL` (or `URL`-coercible string) pointing at the entry module. `target` selects the target runtime, given either as a built-in name (one of `'react-native'`, `'pear-runtime'`, or `'bare-sidecar'`) or as a [target provider](#targets-and-rpc-providers) object. It determines the harness format, bundle extension, host triples, and whether assets and addons are linked into the bundle or offloaded as sibling files. `out` is the output `URL` of the harness; the bundle is written next to it with the target's extension.
 
 The first artifact yielded is the harness at `out`; the second is the bundle alongside it; any further yields are offloaded assets and native addons when the target supports offloading.
 
@@ -203,13 +203,13 @@ Stow the module graph rooted at `<entry>`, writing the harness and bundle to the
 
 ##### `--target <name>`
 
-The target runtime. One of `react-native`, `pear-runtime`, or `node`. Required.
+The target runtime. One of `react-native`, `pear-runtime`, or `bare-sidecar`. Required.
 
 | Target         | Format       | Extension     | Linked | Offload |
 | -------------- | ------------ | ------------- | ------ | ------- |
 | `react-native` | `bundle.mjs` | `.bundle.mjs` | Yes    | No      |
 | `pear-runtime` | `bundle`     | `.bundle`     | No     | Yes     |
-| `node`         | `bundle`     | `.bundle`     | No     | Yes     |
+| `bare-sidecar` | `bundle`     | `.bundle`     | No     | Yes     |
 
 ##### `--client <name>` and `--server <name>`
 

bin.js

@@ -11,7 +11,7 @@ const cmd = command(
   summary(pkg.description),
   arg('<entry>', 'The entry point of the module graph'),
   flag('--version|-v', 'Print the current version'),
-  flag('--target <name>', 'The target runtime (react-native, pear-runtime, node)'),
+  flag('--target <name>', 'The target runtime (react-native, pear-runtime, bare-sidecar)'),
   flag('--client <name>', 'The RPC client harness to include (e.g. bare-rpc)'),
   flag('--server <name>', 'The RPC server harness to include (e.g. bare-rpc)'),
   flag('--base <path>', 'The base path of the bundle'),

index.d.ts

@@ -1,6 +1,6 @@
 import URL from 'bare-url'
 
-type TargetName = 'react-native' | 'pear-runtime' | 'node'
+type TargetName = 'react-native' | 'pear-runtime' | 'bare-sidecar'
 
 interface TargetContext {
   bundleSpecifier: string

lib/harness.js

@@ -1,7 +1,7 @@
 const registry = {
   'react-native': () => require('./harness/react-native'),
   'pear-runtime': () => require('./harness/pear-runtime'),
-  node: () => require('./harness/node')
+  'bare-sidecar': () => require('./harness/bare-sidecar')
 }
 
 module.exports = function harness(target, resolve) {

lib/harness/node.js lib/harness/bare-sidecar.jslib/harness/node.js renamed to lib/harness/bare-sidecar.js

@@ -1,4 +1,4 @@
-exports.name = 'node'
+exports.name = 'bare-sidecar'
 exports.linked = false
 exports.offload = true
 exports.format = 'bundle'

test.js

@@ -40,14 +40,14 @@ test('stow pear-runtime yields harness + bundle', async (t) => {
   t.alike(artifacts, [{ url: out }, { url: new URL('out/index.bundle', base) }])
 })
 
-test('stow node yields harness + bundle', async (t) => {
+test('stow bare-sidecar yields harness + bundle', async (t) => {
   const base = new URL('basic/', fixtures)
   const entry = new URL('core.js', base)
   const out = new URL('out/index.js', base)
 
   const artifacts = []
 
-  for await (const artifact of stow(entry, 'node', out, { base })) {
+  for await (const artifact of stow(entry, 'bare-sidecar', out, { base })) {
     artifacts.push(artifact)
   }
 
@@ -68,7 +68,7 @@ test('stow throws without target', async (t) => {
 
 test('stow throws without out', async (t) => {
   await t.exception(async () => {
-    for await (const _ of stow(new URL('basic/core.js', fixtures), 'node')) {
+    for await (const _ of stow(new URL('basic/core.js', fixtures), 'bare-sidecar')) {
       //
     }
   }, /'out' is required/)
@@ -81,7 +81,7 @@ test('stow accepts a subset of target hosts', async (t) => {
 
   const artifacts = []
 
-  for await (const artifact of stow(entry, 'node', out, {
+  for await (const artifact of stow(entry, 'bare-sidecar', out, {
     base,
     hosts: ['darwin-arm64']
   })) {
@@ -98,7 +98,7 @@ test('stow reroots offloaded assets resolved outside base', async (t) => {
 
   const artifacts = []
 
-  for await (const artifact of stow(entry, 'node', out, { base })) {
+  for await (const artifact of stow(entry, 'bare-sidecar', out, { base })) {
     artifacts.push(artifact)
   }
 
@@ -115,11 +115,11 @@ test('stow throws for host not supported by target', async (t) => {
   const out = new URL('out/index.js', base)
 
   await t.exception(async () => {
-    for await (const _ of stow(entry, 'node', out, {
+    for await (const _ of stow(entry, 'bare-sidecar', out, {
       base,
       hosts: ['ios-arm64']
     })) {
       //
     }
-  }, /Host 'ios-arm64' is not supported by target 'node'/)
+  }, /Host 'ios-arm64' is not supported by target 'bare-sidecar'/)
 })

test/fixtures/harness.snapshot.cjs

@@ -36,7 +36,7 @@ module.exports = {
 }
 `
 
-exports['harness node - should match snapshot - 0'] = `const path = require('path')
+exports['harness bare-sidecar - should match snapshot - 0'] = `const path = require('path')
 const Sidecar = require('bare-sidecar')
 const stow = require('bare-stow/host')
 
@@ -55,7 +55,7 @@ module.exports = {
 }
 `
 
-exports['harness node with bare-rpc client - should match snapshot - 0'] =
+exports['harness bare-sidecar with bare-rpc client - should match snapshot - 0'] =
   `const path = require('path')
 const Sidecar = require('bare-sidecar')
 const stow = require('bare-stow/host')

test/fixtures/shim.snapshot.cjs

@@ -104,7 +104,8 @@ try {
 }
 `
 
-exports['shim node - should match snapshot - 0'] = `import protocol from 'bare-stow/protocol'
+exports['shim bare-sidecar - should match snapshot - 0'] =
+  `import protocol from 'bare-stow/protocol'
 
 const ipc = protocol.attach(Bare.IPC)
 
@@ -214,7 +215,7 @@ try {
 }
 `
 
-exports['shim node with bare-rpc server - should match snapshot - 0'] =
+exports['shim bare-sidecar with bare-rpc server - should match snapshot - 0'] =
   `import protocol from 'bare-stow/protocol'
 
 const ipc = protocol.attach(Bare.IPC)

test/harness.js

@@ -16,15 +16,15 @@ test('harness pear-runtime', (t) => {
   t.snapshot(generate(target, './core.bundle'))
 })
 
-test('harness node', (t) => {
-  const target = harness('node')
+test('harness bare-sidecar', (t) => {
+  const target = harness('bare-sidecar')
 
   t.is(target.format, 'bundle')
   t.snapshot(generate(target, './core.bundle'))
 })
 
-test('harness node with bare-rpc client', (t) => {
-  const target = harness('node')
+test('harness bare-sidecar with bare-rpc client', (t) => {
+  const target = harness('bare-sidecar')
 
   t.snapshot(generate(target, './core.bundle', client(target)))
 })
@@ -42,7 +42,7 @@ test('harness pear-runtime with bare-rpc client', (t) => {
 })
 
 test('harness accepts a target provider object', (t) => {
-  const provided = harness('node')
+  const provided = harness('bare-sidecar')
 
   t.is(harness(provided), provided)
 })

test/shim.js

@@ -13,7 +13,7 @@ test('shim pear-runtime', (t) => {
   t.snapshot(shim(new URL(`${root}/app/entry.js`), new URL(`${root}/app/__main__.js`)))
 })
 
-test('shim node', (t) => {
+test('shim bare-sidecar', (t) => {
   t.snapshot(shim(new URL(`${root}/app/entry.js`), new URL(`${root}/app/__main__.js`)))
 })
 
@@ -25,7 +25,7 @@ test('shim react-native with bare-rpc server', (t) => {
   )
 })
 
-test('shim node with bare-rpc server', (t) => {
+test('shim bare-sidecar with bare-rpc server', (t) => {
   t.snapshot(
     shim(new URL(`${root}/app/entry.js`), new URL(`${root}/app/__main__.js`), {
       server: server()