react-nprogress AGENTS.md

Agent Instructions for react-nprogress

Keep these instructions concise. Only add information here that meaningfully changes agent behaviour and cannot be inferred from the codebase or tooling.

Project

TypeScript React library providing a slim progress bar primitive via two patterns: useNProgress hook and NProgress render-props component. Exports logic only, not rendering. All exports go through src/index.tsx. Types live in src/types.ts. There are no runtime dependencies: React and React DOM are peers.

Key Commands

npm test          # full suite: format and type checks, lint, build, size
                  # gate, then every test:* script
npm run build     # clean, then bundle with tsdown; the postbuild hook runs
                  # publint and arethetypeswrong over the packed tarball
npm run test:src  # source-only tests, the loop to use while developing
npm run format    # fix lint and formatting

Code Standards

Comments

• Use // line comments only, never /* */ or /** */
• Explain why, not what; wrap at 80 characters
• End every comment with a full stop, even single-line comments

Language

Use New Zealand English in all user-facing text, variable names, and comments (e.g. "colour", "behaviour", "organisation"). Standardised API names (color, textAlign) are fixed: leave them unchanged.

const progressColour = '#0066cc'
const centredLayout = { textAlign: 'center' } // API name stays 'center'

Commits

Subject line (max 50 chars)

Body wrapped at 72 chars. Present tense, imperative mood. Capitalise
subject, no trailing period, blank line between subject and body.

Dependencies

Managed by Renovate (config:js-lib preset):

• devDependencies: pinned exact versions (no ^ or ~)
• dependencies: caret ranges (^)
• peerDependencies: explicit OR ranges (e.g. ^16.8.0 || ^17.0.0 || ^18.0.0 || ^19.0.0)
• Do not add allowedVersions to renovate.json without a documented reason