DSH familySearch GitHub

hook / Classic

hook-dsh-workspace-monitor

Watches the workspace and sweeps it on a schedule

0.2.1 hook Classic

Facts

Package
@playform/hook-dsh-workspace-monitor
Version
0.2.1
Kind
hook
Release
Classic
Licence
CC0-1.0
Directory
Classic/packages/hook-dsh-workspace-monitor

What it does

Watches the workspace and sweeps it on a schedule.

Read the full description in the README.

Conversation

The turn as a document: the calls every plugin page shares, what this package changes in them, and the order its work happens in.

Conversational

Lane

The same run as time: one row per resource, a bar per span, and the clock every record shares. A wait is drawn as an outline, because nothing is busy.

Session

The tree, the document, and the inspector read one record list. The switch at the top of the document changes the face they read, and the run changes with it.

session 7c41e0a2 | deepseek-v4.1-flash | max | 3 turns | 9 steps | 40 records | simulated

*emit~waterfall=serial>parallel

Add the session view to the trace page. Read the specimens first, then build the lane strip, the tree, the document, and the inspector from one authored run. The family's plugins must be visible on the records they touch, and the page must read the same run with the family off.

Turn 1Read the specimens14 records | 3 steps

Step 12 calls, 265 chars

Step 24 calls, 313 chars

Step 33 calls, 153 chars

Turn 2Write the run13 records | 3 steps

Step 43 calls, 174 chars

Step 52 calls, 258 chars

Step 62 calls, 115 chars

Turn 3Repair the run13 records | 3 steps

Step 72 calls, 143 chars

Step 83 calls, 184 chars

Step 92 calls, 123 chars

The turn

The same 3 calls on every plugin page, so a reader who moves between plugins stays in the same frame.

The 3 calls every plugin page shares, in sequence order
SeqCallOutcome
20bash ls -laok
21write src/index.tsok
22read src/index.tsok

Change

The one line that differs with this package installed, transcribed from its source by the dissection.

  1. Model no watch entry
  2. Transcript monitor: watch /repo/src/a.ts version 1 (tsc,format)

52 character changed, from 14 to  52.

Property
A change watch
Knob
enabled, off in the bundle patch
Seam
fs/observed

This package ships disabled: the left side of the pair is what the harness does with the package installed but inactive, and enabling it is one line in the profile's bundle patch.

Flow

The order this package's work happens in, with the branch that decides it inline, transcribed from the source; the rule it obeys is the last band of Architecture.

  1. 01
    1. seam fs/observed
    why

    The event is the watch, and it is also the sweep's checkpoint.

  2. 02
    Read the path and the version, and classify the path into its check sets
    why

    The shipped catalog is tsc, format, cargo, and governance, and no command is ever run.

  3. 03
    branch The actor is the hook's own, the path is excluded, or it is outside include
    why

    The three guards run in order, before any entry is touched.

  4. 04
    fail ignored <path> (own actor | excluded | not included)
    why

    A malformed event is caught on the same path, and ledgered as failed rather than thrown.

  5. 05
    Record the watch entry: the version, the clock stamp, the check sets, and the debounce deadline
    why

    The deadline is computed from the module's clock, and a version change bumps the count.

  6. 06
    branch The watch map is over maxWatch
    why

    The oldest entry is the map head.

  7. 07
    fail capped <path> (maxWatch <n>)
    why

    The drop is ledgered, never silent.

  8. 08
    Sweep the deadlines the clock has passed
    why

    There is no setTimeout and no setInterval anywhere; the next event is the bound.

  9. 09
    store ~/.dsh/playform/hook-dsh-workspace-monitor.log
    why

    The health counters ride the probed state instead of the ledger.

Harness

The laws the package states, the line it writes when it loads, the seam the harness dispatches with none of the family, and the surface and knobs a run can set.

Default

What the harness does at this package's seam with none of the family installed, so the surface below has something to be a difference from.

The harness dispatches fs/observed as a emit and already has listeners there: fs-observation-policy, skill-filesystem, workspace-files.

An emit listener observes a fact that already happened, so the harness's own listeners can record it and cannot change it. This package records beside them, or acts on the world rather than on the payload.

Surface

Every listener, tool, service, and knob the README documents.

The surfaces hook-dsh-workspace-monitor registers
KindNameWhat
listenerfs/observedon the ROOT context (the factory's Wire registration) is the watch recorder (synchronous: no awaits, no subprocess work, and no file content ever read).
toolis noThere is no tool and no provided service, and the monitor never executes a command.

Install

The package as the profile adds it.

Install sh
pnpm add @playform/hook-dsh-workspace-monitor

Configuration

Every knob this plugin documents, with its default.

Configuration of hook-dsh-workspace-monitor
FieldTypeDefaultMeaning
enabledfalsethe master switch (IDLE-forever)
logtruethe ledger switch (shared cell)
logFile~/.dsh/playform/hook-dsh-workspace-monitor.logthe ledger
domainworkspace_monitorthe KV domain name
debounceMs250the watch debounce deadline
sweepIntervalMs600000the sweep schedule interval
maxWatch500the watch entry cap
policy.*D6 defaultsthe per-action allowlist (see below)

Family

The neighbours at the same seam, the arms beyond it, the twin in the other release tree, and the packages this one needs.

Neighbours

The behavior map lists 9 answers at fs/observed, in the order the family registers them.

The family's answers at fs/observed, in the order the behavior map lists them
AnswerEffectPosition
hook-dsh-cargo-governorrewriteneighbour
hook-dsh-package-governorrewriteneighbour
hook-dsh-package-pinnerrewriteneighbour
hook-dsh-workspace-approverecordneighbour
hook-dsh-workspace-auditrecordneighbour
hook-dsh-workspace-journalrecordneighbour
hook-dsh-workspace-mergerewriteneighbour
hook-dsh-workspace-monitorrecordthis package
hook-dsh-workspace-observerecordneighbour

Arms

The seams its source also registers, beyond the one its README documents.

Its source registers no seam beyond the one its README documents.

Twin

The same package in the other release tree, when one exists.

Its twin is ets-hook-dsh-workspace-monitor.

It registers the same listeners in the same order and composes the same ledger strings; the ledger file's name, which carries the package identity, and the factory base import are the only differences.

Dependencies

The packages this one imports, and whether each one is the family's own.

Dependencies of hook-dsh-workspace-monitor
PackageRole
@playform/lib-dsh-corefamily
@playform/plugin-dsh-factoryfamily

Person

What the person waits for, reads, and never sees.

The person sees the effect and not the record: the line that testifies to what happened sits in a file, and the page prints the line rather than a screen that shows it.

Architecture

This plugin's own structure: the shape the portrait gives it, the facts its source documents, and the rule its flow obeys.

Shape

Plugs into the fs/observed listener and the state probe on the context.

The watch and the sweep, with the next event as the only clock.

  • Records a watch entry per observed write, with its check sets and its debounce deadline
  • Classifies a path into the shipped check sets, and never executes one
  • Sweeps the deadlines the clock passed, inside the event rather than on a timer
  • Caps the watch map, and ledgers the entry it drops

Its shape machine belongs to Person.

Record

The release line, the source, and the files this page was read from.

Release

The versions the package's own changelog records, newest first.

  • 0.3.0
  • 0.2.1

Source

The package as the repository holds it.

Open the package source

Origin

The files this page was built from, and what each one supplies.

The files this page was read from 5
The files behind https://github.com/PlayForm/DeepSeek/tree/Current/Classic/packages/hook-dsh-workspace-monitor
FileContributedState
package.jsonThe name, the version, the private flag, and the dependencies.read
README.mdThe summary, the surface table, and the configuration table.read
CHANGELOG.mdThe release lines and their versions.read
cordis.patch.ymlActivation: the bundle entry that mounts the plugin.read
Source/Function/Apply.tsThe listeners, their registration order, and the service the flow calls.read
Data
The monorepo, read during the build
Connection
Build-time read; nothing is fetched at runtime
Capture
package.json, README.md, CHANGELOG.md, Source/Function/Apply.ts
Expand provenance source

This page is static. It cannot invoke the plugin, read a ledger, or change a configuration. Every figure comes from those files; a missing README falls back to the manifest's own description, and a package with no surface table shows no surface section.