Rewrite the prose without em-dashes across docs, comments and copy

Author: meliharik

CHANGELOG.md

@@ -3,7 +3,7 @@
 ## Unreleased
 
 - `appVersion` stays required here, while the Swift and Flutter SDKs now detect
-  it. React Native exposes nothing that reads the host app's version — reaching
+  it. React Native exposes nothing that reads the host app's version. Reaching
   the bundle needs a native module, and this package having none is worth more
   than saving a caller one argument. Documented rather than papered over.
 - Removed the kill switch, following its removal from the protocol. Evaluation
@@ -16,8 +16,8 @@ First release.
 
 - Force update, soft update, kill switch and maintenance mode, decided by the
   protocol's evaluation order and verified against the golden vectors.
-- Remote config values in the same signed payload — no extra request.
+- Remote config values in the same signed payload, so there is no extra request.
 - Ed25519 verification of the exact response bytes, with SHA-512 wired for
-  runtimes without `crypto.subtle` — which is all of React Native.
+  runtimes without `crypto.subtle`, which is all of React Native.
 - Signed cache, re-verified on read. AsyncStorage adapter, no dependency on it.
 - `RipstopProvider` with prebuilt walls, or `useRipstop()` and draw your own.

README.md

@@ -9,12 +9,12 @@
   <a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License: MIT"></a>
 </p>
 
-<p align="center"><b>Remote config, update walls and maintenance mode for React Native — decided at the edge, verified on device.</b></p>
+<p align="center"><b>Remote config, update walls and maintenance mode for React Native. Decided at the edge, verified on device.</b></p>
 
 ## Installation
 
 `@ripstop/react-native` is not on npm yet. Until it is, install straight from
-GitHub — the package builds itself on install:
+GitHub. The package builds itself on install:
 
 ```bash
 npm install github:ripstop-dev/ripstop-react-native
@@ -47,13 +47,13 @@ says otherwise, then shows the right wall.
 
 ## Why you still pass `appVersion`
 
-The other Ripstop SDKs read the installed version themselves — Swift from
-`CFBundleShortVersionString`, Flutter from `package_info_plus`. React Native
+The other Ripstop SDKs read the installed version themselves, Swift from
+`CFBundleShortVersionString` and Flutter from `package_info_plus`. React Native
 cannot. Nothing in the framework exposes the host app's version: `Platform.OS`
 and `Platform.Version` describe the operating system, and
 `Platform.constants.reactNativeVersion` describes React Native. Reading the
-bundle means a native module, and this package has none — see the installation
-note above, which is a promise worth more than saving you one argument.
+bundle means a native module, and this package has none. See the installation
+note above; that promise is worth more than saving you one argument.
 
 So pass it, from whichever of these you already have:
 
@@ -62,7 +62,7 @@ import DeviceInfo from 'react-native-device-info';   // DeviceInfo.getVersion()
 import Constants from 'expo-constants';              // Constants.expoConfig?.version
 ```
 
-Pass the version only — `1.4.0`, not `1.4.0 (312)`. Build numbers are not part
+Pass the version only: `1.4.0`, not `1.4.0 (312)`. Build numbers are not part
 of a semantic version, and the rules are compared as semantic versions.
 
 ## Or draw your own
@@ -78,7 +78,7 @@ Pass `walls={false}` to the provider and nothing is rendered for you.
 ## Storage
 
 The cache is in-memory unless you give it somewhere to live. AsyncStorage is a
-separate package and the SDK will not add it to your app on your behalf — pass
+separate package and the SDK will not add it to your app on your behalf. Pass
 your existing instance through `asyncStorageAdapter` and the cache survives
 restarts.
 
@@ -87,7 +87,7 @@ restarts.
 | Situation | What your app does |
 | --- | --- |
 | No network | Uses the last **signed** payload |
-| No network, no cache | `none` — your app runs, unrestricted |
+| No network, no cache | `none`, so your app runs unrestricted |
 | Server returns 500, or times out | Cache, then normal |
 | Signature doesn't verify | Discarded. A forged payload can never wall your app |
 | Cache tampered with | Re-verified on read, so it grants nothing |
@@ -98,12 +98,12 @@ restarts.
 React Native doesn't have it. `@noble/ed25519` backs its SHA-512 with WebCrypto
 by default, so a naive integration verifies fine in every test and throws on the
 first real device. This package wires SHA-512 explicitly from `@noble/hashes`,
-and has a test that deletes `crypto.subtle` before importing anything — because
+and has a test that deletes `crypto.subtle` before importing anything, because
 a test that runs on Node's fallback would pass whether or not the fix was there.
 
 ## Conformance
 
-Every Ripstop SDK runs the same `vectors.json` — version ordering, evaluation
+Every Ripstop SDK runs the same `vectors.json`: version ordering, evaluation
 order, snooze accounting, the fail-open state machine. `npm test` runs it here.
 
 Full docs: **[ripstop.dev/docs/react-native](https://ripstop.dev/docs/react-native)**

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ripstop/react-native",
   "version": "0.1.0",
-  "description": "Remote config, update walls and maintenance mode for React Native — signed at the edge, verified on device.",
+  "description": "Remote config, update walls and maintenance mode for React Native. Signed at the edge, verified on device.",
   "license": "MIT",
   "repository": { "type": "git", "url": "git+https://github.com/ripstop-dev/ripstop-react-native.git" },
   "homepage": "https://ripstop.dev/docs/react-native",

src/client.ts

@@ -27,7 +27,7 @@ export interface RipstopOptions {
    * bundle means a native module. This package has none, and that is worth
    * more than saving a caller one argument.
    *
-   * The version only — `1.4.0`, not `1.4.0 (312)`. Build numbers are not part
+   * The version only: `1.4.0`, not `1.4.0 (312)`. Build numbers are not part
    * of a semantic version, and these are compared as semantic versions.
    */
   appVersion: string;
@@ -186,8 +186,8 @@ export class Ripstop {
 
   /**
    * Adopts a payload only if it still verifies. Cached payloads get the same
-   * scrutiny as fresh ones — localStorage is editable from the console, so
-   * trusting it would make every wall a suggestion.
+   * scrutiny as fresh ones, because localStorage is editable from the console
+   * and trusting it would make every wall a suggestion.
    */
   private async adopt(
     body: string,

src/evaluate.ts

@@ -51,7 +51,7 @@ export function evaluate(config: RipstopConfig, ctx: EvaluateContext): Decision
   const locale = ctx.locale ?? FALLBACK_LOCALE;
   const version = parseVersion(ctx.appVersion);
 
-  // 1. Maintenance — `active` is server-evaluated at fetch time; starts_at/ends_at are display-only.
+  // 1. Maintenance. `active` is server-evaluated at fetch time; starts_at/ends_at are display-only.
   const maintenance = config.maintenance;
   if (maintenance.active) {
     return {
@@ -65,7 +65,7 @@ export function evaluate(config: RipstopConfig, ctx: EvaluateContext): Decision
     };
   }
 
-  // 2–3. Force / soft — need a platform entry and a parseable version; otherwise fail open.
+  // 2–3. Force / soft need a platform entry and a parseable version; otherwise fail open.
   const entry = config.update[ctx.platform];
   if (entry === undefined || version === null) return { type: 'none' };
 

src/storage.ts

@@ -2,7 +2,7 @@
  * Where the last signed payload and the snooze ledger live.
  *
  * The payload is stored *with* its signature and re-verified on read, so a
- * cached config carries exactly as much authority as a fresh one — and no more.
+ * cached config carries exactly as much authority as a fresh one, and no more.
  * On the web this matters more than on mobile: localStorage is two keystrokes
  * away in devtools, so a cache that were trusted would make a maintenance wall
  * a polite request.

src/types.ts

@@ -5,7 +5,7 @@
  * ~14 KB gzipped and would be the largest thing in a package whose whole point
  * is to be small enough that nobody thinks twice about adding it. The server
  * already guarantees the shape, the signature guarantees the bytes came from
- * the server, and anything unreadable falls open — so a schema library here
+ * the server, and anything unreadable falls open, so a schema library here
  * would buy a nicer error message on a path that is already safe.
  */
 

src/verify.ts

@@ -3,7 +3,7 @@
  *
  * React Native has no `crypto.subtle`, so `@noble/ed25519` cannot fall back to
  * WebCrypto for its SHA-512 the way it does in a browser. The hash is wired up
- * explicitly from `@noble/hashes` — without this the SDK would throw on the
+ * explicitly from `@noble/hashes`. Without this the SDK would throw on the
  * first verification, on device, in production, and nowhere in a JSDOM test.
  *
  * The signature covers the raw response body, so verification happens before
@@ -17,7 +17,7 @@ import { sha512 } from '@noble/hashes/sha2';
 //
 // `@noble/ed25519` ships an async SHA-512 backed by `crypto.subtle`, which is
 // exactly what React Native does not have. Left alone, the first signature
-// check would throw on a real device and never in a Node test — so both the
+// check would throw on a real device and never in a Node test, so both the
 // sync and async hooks are pointed at `@noble/hashes` instead.
 // The copy also normalises the backing buffer: noble's types require a plain
 // `ArrayBuffer`, and a hash may return a view onto a shared one.
@@ -39,9 +39,9 @@ export class SignatureVerifier {
   constructor(private readonly keys: Record<string, string>) {}
 
   /**
-   * True only for a genuine signature by the named pinned key. Every failure —
-   * unknown key, malformed base64, wrong length, bad signature — is a plain
-   * false, and callers then fall back to cache.
+   * True only for a genuine signature by the named pinned key. Every failure
+   * is a plain false: an unknown key, malformed base64, the wrong length, a
+   * bad signature. Callers then fall back to cache.
    */
   async verify(body: string, signature: string, keyId: string): Promise<boolean> {
     const encoded = this.keys[keyId];

test/client.test.ts

@@ -1,9 +1,9 @@
 /**
- * What the client promises when things go wrong — the only time anybody finds
- * out whether a config SDK was written carefully.
+ * What the client promises when things go wrong, which is the only time
+ * anybody finds out whether a config SDK was written carefully.
  *
  * These sign with a real key pair and stub `fetch`. Importing the client pulls
- * in `verify.ts`, which is where the SHA-512 hook is installed — so these also
+ * in `verify.ts`, which is where the SHA-512 hook is installed, so these also
  * prove that verification works without `crypto.subtle`, which is the thing
  * React Native lacks and a browser hides.
  */
@@ -122,7 +122,7 @@ describe('the client', () => {
 
   it('has no opinion about a version it cannot read', async () => {
     // `appVersion` is required here because React Native will not tell us the
-    // installed version, which puts the value in the caller's hands — so the
+    // installed version, which puts the value in the caller's hands, so the
     // common mistakes have to fail open rather than wall somebody. A display
     // string with the build number in it is the one people reach for.
     const { impl } = server(config());

test/vectors.json

@@ -1,6 +1,6 @@
 {
   "version": 1,
-  "notes": "Golden vectors — every implementation (TS reference + all SDKs) must pass all cases. `compare` expects sign of compare(a,b); harnesses must also assert compare(b,a) === -expect. `evaluate` cases: config = top-level replacement of `patch` keys over `base_config` (no deep merge); `expect` is a subset match — listed fields must equal, extra fields in the actual decision are allowed. `config_source` covers the fail-open state machine. Adding a vector is feat:, changing one is an ADR.",
+  "notes": "Golden vectors. Every implementation (TS reference + all SDKs) must pass all cases. `compare` expects sign of compare(a,b); harnesses must also assert compare(b,a) === -expect. `evaluate` cases: config = top-level replacement of `patch` keys over `base_config` (no deep merge); `expect` is a subset match, so listed fields must equal, and extra fields in the actual decision are allowed. `config_source` covers the fail-open state machine. Adding a vector is feat:, changing one is an ADR.",
   "base_config": {
     "v": 1,
     "app": "app_test",