You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: AGENTS.md
+4-2Lines changed: 4 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,11 +6,11 @@ Welcome! This file keeps lightweight coordination notes for anyone (human or AI)
6
6
7
7
1. Follow `docs/PLANS.md` for the prioritized maintenance backlog.
8
8
2. When picking up a task, append a short status note under the relevant section in `docs/PLANS.md` (e.g. `- [started YYYY-MM-DD] <task>`), then remove or update it when you finish.
9
-
3. Build pipeline now uses `tsdown` for dual ESM/CJS bundles into `dist/` plus `tsc` for typed transpilation (`yarn build` and `yarn typecheck`). Local sanity checks confirm `yarn build`, `yarn test:lint`, and `yarn test:prettier` pass (lint only warns on crypto key_size/iv_size/at_size camelCase). Full `yarn test` still needs a running MongoDB (e.g., docker compose up) until tests migrate to mongodb-memory-server.
9
+
3. Build pipeline now uses `tsdown` for dual ESM/CJS bundles into `dist/` plus `tsc` for typed transpilation (`npm run build` and `npm run typecheck`). Local sanity checks confirm `npm run build`, `npm run test:lint`, and `npm run test:prettier` pass (lint only warns on crypto key_size/iv_size/at_size camelCase). Full `npm test` still needs a running MongoDB (e.g., docker compose up) until tests migrate to mongodb-memory-server.
10
10
11
11
## Workflow Expectations
12
12
13
-
- Run `yarn install && yarn build && yarn test` locally before opening or updating a PR unless the change is docs-only.
13
+
- Run `npm ci && npm run build && npm test` locally before opening or updating a PR unless the change is docs-only.
14
14
- Record any assumptions, surprises, or TODOs at the bottom of the touched file(s) in `// TODO(agent): ...` comments or in `docs/PLANS.md`.
15
15
- When working on a task, always follow PLAN, EDIT and REVIEW steps.
16
16
- When working on a task, always check if CHANGELOG.md or README.md need updates. If encounter breaking changes, add a note to CHANGELOG.md and also create separate migration docs if needed.
@@ -23,3 +23,5 @@ Welcome! This file keeps lightweight coordination notes for anyone (human or AI)
23
23
- For complex changes, request a human review to ensure the change aligns with project goals and also ask for clarification on any ambiguous points in the plan.
24
24
25
25
Thanks for helping keep the project healthy!
26
+
27
+
// TODO(agent): Husky install failed in this sandbox because `.git/config` was not writable; rerun `npm install` in a normal checkout to populate hooks.
Copy file name to clipboardExpand all lines: README.md
+9-10Lines changed: 9 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -39,7 +39,6 @@ MongoDB session store for [Connect](https://github.com/senchalabs/connect) and [
39
39
40
40
```
41
41
npm install connect-mongo
42
-
yarn add connect-mongo
43
42
```
44
43
45
44
* Install `mongodb` alongside `connect-mongo`; it is a required peer dependency so you pick the driver version that matches your cluster.
@@ -308,14 +307,14 @@ One of the following options should be provided. If more than one option are pro
308
307
## Development
309
308
310
309
```
311
-
yarn install
310
+
npm install
312
311
docker compose up -d
313
-
yarn watch:test
312
+
npm run watch:test
314
313
```
315
314
316
315
### TLS & SRV fixtures
317
316
318
-
- Generate local certificates once with `yarn tls:setup` (drops files in `docker/tls`).
317
+
- Generate local certificates once with `npm run tls:setup` (drops files in `docker/tls`).
319
318
- Launch the optional TLS container with `docker compose -f docker-compose.yaml -f docker-compose.tls.yaml --profile tls up -d`.
320
319
- Copy `example/.env.example` to `example/.env` and point `MONGO_URL` to the TLS port (`mongodb://root:example@127.0.0.1:27443/example-db?authSource=admin`). Add `MONGO_TLS_CA_FILE=../docker/tls/ca.crt` so the driver trusts the self-signed CA. Set `MONGO_TLS_CERT_KEY_FILE=../docker/tls/client.pem` if you need mutual TLS.
321
320
- To exercise SRV/TLS against a managed cluster (Atlas, DocumentDB, CosmosDB), set `MONGO_URL` to your `mongodb+srv://` string and either `MONGO_TLS_CA_FILE` or `NODE_EXTRA_CA_CERTS` to the provider CA bundle. The example scripts automatically reuse those settings in every variant (plain JS, Mongoose, and TS).
@@ -325,12 +324,12 @@ yarn watch:test
325
324
```
326
325
# from the repo root
327
326
cp example/.env.example example/.env
328
-
yarn link
327
+
npm link
329
328
cd example
330
-
yarn link "connect-mongo" # optional if you want live code from this checkout
331
-
yarn install
332
-
yarn start:js
333
-
# or yarn start:mongoose / yarn start:ts
329
+
npm link "connect-mongo" # optional if you want live code from this checkout
330
+
npm install
331
+
npm run start:js
332
+
# or npm run start:mongoose / npm run start:ts
334
333
```
335
334
336
335
After the first run you can edit `example/.env` to swap between the local docker fixture, the TLS profile, or any `mongodb+srv://` cluster without changing the code.
@@ -340,7 +339,7 @@ After the first run you can edit `example/.env` to swap between the local docker
340
339
Until the GitHub release workflow lands, do the manual flow:
341
340
342
341
1. Bump version, update `CHANGELOG.md` and README. Commit and push.
343
-
2. Run `yarn test && yarn build` (build uses `tsdown` to emit dual ESM/CJS bundles to `dist/`).
342
+
2. Run `npm test && npm run build` (build uses `tsdown` to emit dual ESM/CJS bundles to `dist/`).
Copy file name to clipboardExpand all lines: docs/PLANS.md
+3-2Lines changed: 3 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,9 +8,10 @@
8
8
9
9
- Tooling & CI
10
10
- Rework integration helpers: replace the broken `check-cli`/`diff-integration-tests`, document a safe reset workflow, and migrate `test:integration` to mongodb-memory-server.
11
-
- CI matrix should cover MongoDB driver ranges via temp `yarn add --no-lockfile --dev mongodb@x`, exercise MongoDB 7.x containers with health checks, and always run `docker compose down` in a finally step.
12
-
- Expand coverage for crypto, autoRemove, touchAfter, and transformId using mongodb-memory-server; continue the started live-Mongo upgrade compat test (5.1.0 ➜ current) exposed as `yarn test:compat`.
11
+
- CI matrix should cover MongoDB driver ranges via temp `npm install mongodb@x --no-save --no-package-lock`, exercise MongoDB 7.x containers with health checks, and always run `docker compose down` in a finally step.
12
+
- Expand coverage for crypto, autoRemove, touchAfter, and transformId using mongodb-memory-server; continue the started live-Mongo upgrade compat test (5.1.0 ➜ current) exposed as `npm run test:compat`.
13
13
- Automate releases with standard-version + GitHub Actions to build, test, publish, upload coverage, and tag.
14
+
-[done 2025-11-24] Migrate tooling from yarn to npm.
14
15
15
16
- Docs & Community
16
17
- Refresh README badges/compatibility matrix to match supported Node 20/22/24, MongoDB server 4.4–8.0, driver >=5<8, and express support; link to CI results.
0 commit comments