@doikayt/typescript-build-config 0.1.10 → 0.1.12

package/README.md

@@ -23,8 +23,8 @@ Shared build configuration presets for TypeScript-based projects.
 
 ## Purpose
 
-This package centralises common build tooling configuration and release policy across all
-TypeScript projects maintained under the `@doikayt` scope. The goal is a
+This package centralises common build tooling configuration, release policy, and content assets
+across all TypeScript projects maintained under the `@doikayt` scope. The goal is a
 single source of truth for such settings that should be held constant across
 projects, avoiding drift between repos over time.
 The plugin encapsulates common build **policy** and release **workflow logic**
@@ -62,6 +62,28 @@ versions of these tools may produce peer dependency conflicts.
 - Auto-changeset script (`scripts/auto-changeset.sh`)
 - NPM token diagnostic workflow (`.github/workflows/verify-npm-token.yml`) — see
   [Troubleshooting Publish Auth](docs/RELEASE-PROCESS.md#troubleshooting-publish-auth)
+- Playwright config helper (`@doikayt/typescript-build-config/playwright`) — `nixChromiumLaunchOptions()`
+  discovers the system Chromium on quirky NixOS; `definePlaywrightConfig()` wraps `defineConfig` and
+  merges the result in. Transparent no-op on platforms where Playwright's bundled browser works.
+  `@playwright/test` is an **optional peer dependency** — it is not installed automatically.
+  Any project that imports from `@doikayt/typescript-build-config/playwright` must declare it
+  explicitly in its own `devDependencies`:
+
+  ```bash
+  npm install --save-dev @playwright/test
+  ```
+
+  ```ts
+  import { definePlaywrightConfig } from "@doikayt/typescript-build-config/playwright";
+  export default definePlaywrightConfig({
+      testDir: "code/tests/e2e",
+      testMatch: "**/*.spec.ts",
+      use: { baseURL: "http://localhost:8080" },
+  });
+  ```
+
+- Brand assets (`assets/doikayt-logo.png`, `assets/doikayt-logo.svg`) — shared logos for use
+  across all `@doikayt` project READMEs and documentation
 
 ## Delivery Model
 
@@ -73,9 +95,10 @@ _states_ it:
         ┌─────────────────────────────────────────────────┐
         │        @doikayt/typescript-build-config        │
         │                                                 │
-        │  presets     src/eslint.js  prettier  tsconfig  │
+        │  presets  eslint  prettier  tsconfig  playwright│
         │  stubs       src/top-level/*                    │
         │  pipeline    src/pipeline/*                     │
+        │  assets      assets/*                           │
         │  policy      docs/RELEASE-PROCESS.md            │
         └─────────┬───────────────┬───────────────┬───────┘
                   │               │               │
@@ -83,10 +106,11 @@ _states_ it:
      IN PLACE     │    ON INSTALL │  NEVER COPIED │
                   │               │               │
  presets stay in  │ postinstall   │ cited by URL  │
- node_modules —   │ seeds stubs + │ only; one     │
- updates flow     │ pipeline once;│ canonical     │
- with npm update  │ consumer owns │ copy — drift  │
-                  │ them; drift ⇒ │ is impossible │
+ node_modules —   │ seeds stubs,  │ only; one     │
+ updates flow     │ pipeline, and │ canonical     │
+ with npm update  │ assets once;  │ copy — drift  │
+                  │ consumer owns │ is impossible │
+                  │ them; drift ⇒ │               │
                   │ diff warning  │               │
                   ▼               ▼               ▼
         ┌─────────────────────────────────────────────────┐
@@ -98,6 +122,7 @@ _states_ it:
         │                         node_modules  (chan. 1) │
         │  owned pipeline:  .github/workflows/release.yml │
         │                   scripts/auto-changeset.sh     │
+        │  owned assets:    docs/assets/doikayt-logo.*    │
         │  CONTRIBUTING.md ─cites URL─► RELEASE-PROCESS.md│
         └─────────────────────────────────────────────────┘
 ```
@@ -116,6 +141,10 @@ _states_ it:
 - **Owned pipeline** — the release workflow and scripts, copied on install. "Owned" by
   the **consumer repo**: it may edit its copies, upstream never overwrites them, and
   postinstall prints a diff warning when a copy drifts from the canonical template.
+- **Assets** — brand logos seeded once into `docs/assets/` by the postinstall script.
+  Same channel-2 treatment as the pipeline: copied if absent, skipped if identical,
+  warning (without a text diff) if diverged. Consumer owns the copy; it will not be
+  silently overwritten.
 - **Policy** — the release process itself, stated once in
   [docs/RELEASE-PROCESS.md](docs/RELEASE-PROCESS.md). Consumers reference it by URL from
   their own contributor docs (as the consumer box shows) — never copied, so it cannot
@@ -278,3 +307,4 @@ npm run update-all-format && npm run ci
 ## License
 
 MIT
+