Skip to content

AGENTS.md

Latest commit

 

History

History
58 lines (38 loc) · 2.15 KB

AGENTS.md

File metadata and controls

58 lines (38 loc) · 2.15 KB
Raw

Agent Guide — ep_public_view

USE THIS PLUGIN WITH CAUTION. This plugin will help make content indexable by evil search engines and the hordes of social networks waiting to suckle on the bussum of your content. This plugin Allows search engines to get pad text contents, use with robots override plugin for publicly indexable pads .. This plugin supercedes ep_text_content_in_noscripts_tag.

Tech stack

  • Etherpad plugin framework (hooks declared in ep.json)

Project structure

ep_public_view/
├── AGENTS.md
├── CONTRIBUTING.md
├── LICENSE.md
├── ep.json
├── index.js
├── package.json
├── static/
│   ├── tests/

Helpers used

None — ep_plugin_helpers is not a dependency. Adoption is part of the helpers-adoption sweep (Phase 4).

Helpers NOT used

To be audited in the helpers-adoption sweep (Phase 4).

Running tests locally

ep_public_view runs inside Etherpad's test harness. From an etherpad checkout that has installed this plugin via pnpm run plugins i --path ../ep_public_view:

# Backend (Mocha) — harness boots its own server
pnpm --filter ep_etherpad-lite run test

# Playwright — needs `pnpm run dev` in a second terminal
pnpm --filter ep_etherpad-lite run test-ui

Standing rules for agent edits

  • PRs target main. Linear commits, no merge commits.
  • Every bug fix includes a regression test in the same commit.
  • All user-facing strings in locales/. No hardcoded English in templates.
  • No hardcoded aria-label on icon-only controls — etherpad's html10n auto-populates aria-label from the localized string when (a) the element has a data-l10n-id and (b) no author-supplied aria-label is present. Adding a hardcoded English aria-label blocks that and leaves it untranslated. (See etherpad-lite/src/static/js/vendors/html10n.ts:665-678.)
  • No nested interactive elements (no <button> inside <a>).
  • LLM/Agent contributions are explicitly welcomed by maintainers.

Quick reference: hooks declared in ep.json

  • Server: expressCreateServer

When adding a hook, register it in both ep.json and the matching exports.<hook> = ... in the JS file.