@amykit/plugin-file-notes

Friction as a directory of notes: written by hand, by a hook, or by a tick that failed.

A plugin for amy. It provides the notes port.

Install

npm install -g @amykit/plugin-file-notes

Then name it in ~/.amy/config.yaml:

workflows:
  your-profile:
    plugins:
      - "@amykit/plugin-file-notes"

Configuration

plugins:
  "@amykit/plugin-file-notes":
    directory: "notes"
    repo: ""
    writeFailureNotes: true

| Setting | Type | Required | Default | What it is | | :-- | :-- | :-- | :-- | :-- | | directory | string | no | notes | where the notes are watched for, relative to the state directory | | repo | string | no | "" | the repository a note is about when it does not say, which is also the one this machine's own failures are filed against | | writeFailureNotes | boolean | no | true | whether a tick this machine gave up on leaves a note behind, so the thing that broke becomes the thing that gets fixed |

Every field is checked at boot against the schema this package declares. A key that is not one of the above is a refusal naming the plugin and the key, not a setting that silently never applied.

Where the reasoning is

• Writing a plugin
• Reference: plugins
• Ports and the registry

Licence

MIT