@streamorchard/grapevine 0.7.0 → 0.7.2

package/README.md

@@ -157,10 +157,22 @@ peer.link.on('event', (from, name, params) => {
 
 Give your app the same `GRAPEVINE_DIR` (or `place: { env: { GRAPEVINE_DIR: testDir } }`), so tests never touch the real folder.
 
-From the command line, for launch tests, it prints a JSON line for everything that happens and takes commands on stdin:
+As a process of its own, for launch tests, it prints a JSON line for everything that happens and takes commands on stdin:
 
-```sh
-npx grapevine-stand-in --as com.glowingpear.streammultiview --dir /tmp/test --uses drops.farming@1.0 --provides players@1.0
+```js
+// The installed copy, by its path: never `npx grapevine-stand-in`, which would fetch a package of
+// that name from npm if Grapevine weren't installed.
+const child = spawn(process.execPath, [
+  require.resolve('@streamorchard/grapevine/stand-in-peer'),
+  '--as',
+  'com.glowingpear.streammultiview',
+  '--dir',
+  testDir,
+  '--uses',
+  'drops.farming@1.0',
+  '--provides',
+  'players@1.0',
+]);
 ```
 
 Example messages for every capability version, good and bad, are in `@streamorchard/grapevine/fixtures`. Check that what your app sends passes them.
@@ -197,12 +209,20 @@ When it ships a release that uses Grapevine, record it (next section).
 
 Once an app ships a capability version, Grapevine records it. From then on that version can't change in place, and other apps can say which release to update to.
 
-In the app's repo, at the start of every change:
+Give the app a script for it, in its `package.json`:
+
+```json
+"scripts": { "grapevine:check": "grapevine-check" }
+```
+
+Then, in the app's repo, at the start of every change:
 
 ```sh
-npx grapevine-check
+npm run grapevine:check
 ```
 
+Use the script, not `npx grapevine-check`: in a checkout where Grapevine isn't installed yet, `npx` would fetch and run whatever package on npm has that name. `npm run` only uses what's installed.
+
 - **It reads** the `grapevine` field from each of the app's release tags (`v*`), and Grapevine's record from GitHub (the installed copy if it's offline, or with `--offline`).
 - **It lists** any capability version a release shipped that isn't recorded yet, with the command to record it, e.g. `npm run released -- com.streamorchard.peardrops 0.1.6 drops.farming@1.0 players@1.0`.
 - **That command runs in a Grapevine checkout** (its `app-shipped` skill), followed by a pull request and a patch release.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@streamorchard/grapevine",
-  "version": "0.7.0",
+  "version": "0.7.2",
   "description": "Lets desktop apps on the same computer find each other and talk, privately: local sockets, JSON-RPC, pairing and versioned capabilities.",
   "license": "GPL-3.0-only",
   "author": "StreamOrchard",

package/scripts/check-shipped.js

@@ -1,5 +1,6 @@
 #!/usr/bin/env node
-// Run in an app's repo (npx grapevine-check): lists the capability versions the app's releases
+// Run in an app's repo, through a script ("grapevine:check": "grapevine-check"; never npx, which
+// would fetch a package of that name when Grapevine isn't installed): lists the capability versions the app's releases
 // have shipped that Grapevine hasn't recorded yet, with the command that records them (Grapevine's
 // app-shipped skill). Until they're recorded, those versions can still be changed in place, and
 // other apps can't say which release to update to.
@@ -7,9 +8,9 @@
 // The app says what it speaks in its package.json, so every release tag has it:
 //   "grapevine": { "app": "com.streamorchard.peardrops", "provides": { "drops.farming": "1.0" }, "uses": { "players": "1.0" } }
 //
-//   npx grapevine-check            prints what needs recording (exit 0)
-//   npx grapevine-check --strict   exits 1 when something does
-//   npx grapevine-check --offline  uses the record in the installed package, not GitHub's
+//   npm run grapevine:check                prints what needs recording (exit 0)
+//   npm run grapevine:check -- --strict    exits 1 when something does
+//   npm run grapevine:check -- --offline   uses the record in the installed package, not GitHub's
 'use strict';
 
 const fs = require('fs');