agentleFS
Sign inStart free
NVIDIAKnown publisherNVIDIA/elements/projects/starters/lit-library/AGENTS.md

elements / lit-library

AGENTS.md115 starsChanged 54 days agoApache-2.0View on GitHub

This file only covers how this starter wires Elements into reusable Lit components. For component APIs, use the Elements CLI/MCP documentation. For production core components, use repository component guidance; this starter is for reusable domain components outside @nvidia-elements/core.

The file

We split this AGENTS.md into the rules it gives an agent

8 rules. About 0 are common, 1 is distinctive, and 7 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 7

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Put custom element registration in sibling define.ts files.

    line 8
  2. Very specific:

    Add every public deep import to package.json#exports and typesVersions.

    line 9
  3. Very specific:

    Keep .//define.js in sideEffects so bundlers preserve registration entrypoints.

    line 10
  4. Very specific:

    Import Elements classes from side-effect-free entrypoints when using a scoped registry.

    line 14
  5. Very specific:

    Use define.js entrypoints only for global registration tests or consuming app examples.

    line 16
  6. Distinctive:

    Keep public props primitive unless an ADR or local requirement justifies the exception.

    line 20
  7. Very specific:

    Prefer form-associated custom elements when the domain component behaves as one form control.

    line 22
  8. Very specific:

    Run pnpm run build, pnpm run test, and pnpm run lint in projects/starters/lit-library after component, export, or package changes.

    line 26

≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md

Elements Lit Library Starter

This file only covers how this starter wires Elements into reusable Lit components. For component APIs, use the Elements CLI/MCP documentation. For production core components, use repository component guidance; this starter is for reusable domain components outside @nvidia-elements/core.

Integration Points

  • Export side-effect-free classes from feature index.ts files.
  • Put custom element registration in sibling define.ts files.
  • Add every public deep import to package.json#exports and typesVersions.
  • Keep ./**/define.js in sideEffects so bundlers preserve registration entrypoints.

Composing Elements

  • Import Elements classes from side-effect-free entrypoints when using a scoped registry.
  • Define composed Elements in the same registry used by static shadowRootOptions.customElementRegistry.
  • Use define.js entrypoints only for global registration tests or consuming app examples.

Component Authoring

  • Keep public props primitive unless an ADR or local requirement justifies the exception.
  • Emit standard DOM events with bubbles: true and composed: true when crossing the shadow root.
  • Prefer form-associated custom elements when the domain component behaves as one form control.

Verification

  • Run pnpm run build, pnpm run test, and pnpm run lint in projects/starters/lit-library after component, export, or package changes.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free