Crie um plugin com ação e evento

Um plugin do Herdr é um diretório com manifesto e executáveis. Neste exemplo, uma ação consulta os workspaces e grava um registro no diretório de estado fornecido pelo Herdr. O mesmo script responde ao evento de criação de workspace.

Crie o manifesto

Crie uma pasta para o exemplo e escreva o arquivo herdr-plugin.toml:

1
id = "promovaweb.workspace-log"
2
name = "Registro de workspaces"
3
version = "0.1.0"
4
min_herdr_version = "0.9.5"
5
platforms = ["linux"]
6

7
[[actions]]
8
id = "registrar"
9
title = "Registrar workspaces"
10
command = ["node", "index.mjs"]
11

12
[[events]]
13
on = "workspace.created"
14
command = ["node", "index.mjs"]

Consulte a sessão correta

Escreva este código no arquivo index.mjs na mesma pasta. Ele usa o binário e o socket recebidos do Herdr, inclusive quando a ação ocorre em uma sessão nomeada.

1
import { execFileSync } from 'node:child_process'
2
import { appendFileSync, mkdirSync } from 'node:fs'
3
import { join } from 'node:path'
4

5
const binary = process.env.HERDR_BIN_PATH
6
const directory = process.env.HERDR_PLUGIN_STATE_DIR
7
if (!binary || !directory) throw new Error('Execute pelo Herdr.')
8
const output = execFileSync(binary, ['workspace', 'list'], {
9
  encoding: 'utf8', timeout: 5000
10
})
11
mkdirSync(directory, { recursive: true })
12
appendFileSync(join(directory, 'workspaces.jsonl'), JSON.stringify({
13
  date: new Date().toISOString(),
14
  event: process.env.HERDR_PLUGIN_EVENT ?? 'action',
15
  response: JSON.parse(output)
16
}) + '\n')

O registro inclui nomes e identificadores de workspaces. Guarde-o como informação do seu ambiente. O exemplo é didático e acrescenta uma linha por evento, sem rotação automática do arquivo.

Vincule e execute

Dentro da pasta do plugin, execute:

1
herdr --session tutorial plugin link "$PWD"
2
herdr --session tutorial plugin action invoke promovaweb.workspace-log.registrar
3
herdr --session tutorial workspace create --cwd "$PWD" --label Evento
4
herdr --session tutorial plugin log list --plugin promovaweb.workspace-log

A chamada da ação retorna antes de o processo terminar. Consulte os logs até verificar succeeded e exit_code: 0. O teste local confirmou esse resultado para a ação e para o evento workspace.created.

Remova o vínculo

1
herdr plugin unlink promovaweb.workspace-log

O comando remove o registro do plugin e preserva os arquivos de desenvolvimento. Plugins vinculados ficam disponíveis para as sessões do mesmo usuário. O teste desta página usou diretórios XDG temporários para manter a instalação pessoal separada.