mongodb-connection-string-url AGENTS.md

AGENTS.md

Instructions for AI coding agents working in this repository. This file is the source of truth; tool-specific files (e.g. CLAUDE.md) should only import it.

Project Overview

A parser library for MongoDB connection string URLs.

Commands

npm run build        # compile TypeScript to lib/ and generate ESM wrapper
npm test             # build, run tsd type tests, then mocha with coverage
npm run lint         # runs an eslint pass
npm run compile-ts   # type-check/compile only (fastest feedback)

Structure

• src/index.ts — parsing logic
• src/redact.ts — credential redactors for connection strings
• test/*.ts — mocha + chai tests;
• test/types/* — tsd type-level tests

Code Conventions

• Public API stability — everything exported from src/index.ts is public API. Renaming, removing, or narrowing exported types/signatures is a breaking change; confirm with a maintainer first.
• Errors — throw MongoParseError for invalid connection strings; messages in sentence case, no trailing period. Never include the raw URI (credentials) in error messages.
• Formatting — Prettier via eslint: single quotes, 2-space indent. Run npm run lint before committing.
• Tests — every behavior change needs a mocha test; type-signature changes need a tsd test in test/types/.

Other Important Information

• Changes must be compliant with the connection string spec.

Commit Messages

Conventional Commits optionally with a Jira ticket: <type>(NODE-XXXX): <subject> — types: feat, fix, docs, style, refactor, perf, test, chore; breaking changes use ! (e.g. feat(NODE-XXXX)!: …). This rule is mandatory for PR descriptions, because that is what ends up in the history. The individual commits inside a PR do not have to follow this convention, because we squash PR commits.