DSH familySearch GitHub

hook / EffectTS

ets-hook-dsh-workspace-observe

Observes the workspace so the family can reason about it

0.2.1 hook EffectTS

Facts

Package
@playform/ets-hook-dsh-workspace-observe
Version
0.2.1
Kind
hook
Release
EffectTS
Licence
CC0-1.0
Directory
EffectTS/packages/ets-hook-dsh-workspace-observe

What it does

Observes the workspace so the family can reason about it.

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 stamp
  2. Transcript observe: stamped /repo/src/a.ts version 1 (fs/observed)

55 character changed, from 8 to  55.

Property
A version stamp
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 listener registers on the root context, so it hears every emission.

  2. 02
    Read the display path and the observed version, verbatim
    why

    An absent observation is stamped absent, never a fabricated token.

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

    The own-actor check is an identity test on the actor object, not a name.

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

    Each refusal names its own reason, so a silent skip is never a guess.

  5. 05
    branch A repeat event: the same path at the same version inside the coalescing window
    why

    The version token identifies the file state, so the stamp for it already exists.

  6. 06
    pass Dropped silently: no sequence, no stamp, no line
    why

    A different version, or the same version after the window, is stamped normally.

  7. 07
    Increment the plugin's own sequence, and stamp the path
    why

    The counter is the plugin's own and never a wall clock.

  8. 08
    Emit observe/stamp on the trace bus, when the bus exists
    why

    The indexer's first source; a context without the bus records exactly as before.

  9. 09
    store workspace_observe: a record per path, and a bounded ring
    why

    The oldest drop is ledgered as capped rather than discarded in silence.

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 ets-hook-dsh-workspace-observe registers
KindNameWhat
listenerfs/observedon the ROOT context (the factory's Wire) is the only registration.
toolis noThere is no tool, no provided service, no file read, and no file write.

Install

The package as the profile adds it.

Install sh
pnpm add @playform/ets-hook-dsh-workspace-observe

Configuration

Every knob this plugin documents, with its default.

Configuration of ets-hook-dsh-workspace-observe
FieldTypeDefaultMeaning
readautowriteapprove
indexautocommitapprove
recordautospawnapprove
suggestautomessageauto

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-monitorrecordneighbour
hook-dsh-workspace-observerecordits twin

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 hook-dsh-workspace-observe.

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 ets-hook-dsh-workspace-observe
PackageRole
@playform/ets-base-dshfamily
@playform/ets-lib-dsh-tracefamily
@playform/ets-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 workspaceObserve service, the fs/observed listener on the root context, and the trace bus.

The first step of the invisible flow: one observation stamp per file state.

  • Stamps the event's display path and version verbatim, and stamps an absence as absent
  • Guards the own actor, the exclusion list, the include list, and a repeat event
  • Emits observe/stamp for the indexer, when the trace bus exists
  • Keeps the latest stamp per path plus a bounded ring, and ledgers the drop

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
  • 0.2.0
  • 0.1.0

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/EffectTS/packages/ets-hook-dsh-workspace-observe
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.