# AGENTS.md

⏰ Day.js 2kB immutable date-time library alternative to Moment.js with the same modern API

## Setup

```
npm ci
```

## Commands

```
npm run build            # produce a build
npm run test             # run the test suite, must pass before any commit
npm run lint             # lint
npm run test-tz
npm run test-tz-plugin
npm run prettier
npm run babel
npm run sauce
```

## Layout

- `src/`   184 source files
- `test/`  95 source files
- `types/` 40 source files
- `build/` 3 source files
- `docs/`  1 source file

## Conventions

- Tests live alongside the code they cover, following `.github/workflows/lint-test.yml`.
- CI defines what passing means. See `.github/workflows/check.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- Generated output is committed (`build/`). Search will return the compiled copy, so edit the source, not that.

---

Drafted by agentreadme.com from what is in this repository. Everything marked TODO
needs a human. Check it in as AGENTS.md at the root.