@@ -8,7 +8,7 @@ This is a monorepo for the **Pydantic Logfire JavaScript SDK** - an observabilit
88
99## Repository Structure
1010
11- This is an ** npm workspace monorepo** managed with ** Turborepo ** :
11+ This is a ** pnpm workspace monorepo** :
1212
1313- ` packages/logfire-node ` - Node.js SDK with automatic OpenTelemetry instrumentation
1414- ` packages/logfire-api ` - Core API package (published as ` logfire ` ) that can be used standalone for manual tracing (no auto-instrumentation)
@@ -59,40 +59,40 @@ This is an **npm workspace monorepo** managed with **Turborepo**:
5959### Development Setup
6060
6161``` bash
62- npm install
62+ pnpm install
6363```
6464
6565### Building
6666
6767``` bash
6868# Build all packages
69- npm run build
69+ pnpm run build
7070
7171# Build in watch mode (for development)
72- npm run dev
72+ pnpm run dev
7373```
7474
7575### Testing
7676
7777``` bash
7878# Run all tests
79- npm run test
79+ pnpm run test
8080
8181# Run tests for a specific package
82- cd packages/logfire-node && npm test
82+ cd packages/logfire-node && pnpm test
8383```
8484
85- ### Linting and Type Checking
85+ ### Linting, Type Checking, and Formatting
8686
8787``` bash
88- # Run both typecheck and lint across all packages
89- npm run ci
90-
91- # Just linting
92- turbo lint
93-
94- # Just type checking
95- turbo typecheck
88+ # Run all checks (build, typecheck, lint, format-check, test)
89+ pnpm run check
90+
91+ # Individual commands
92+ pnpm run typecheck # Type checking
93+ pnpm run lint # Linting
94+ pnpm run format-check # Check formatting
95+ pnpm run format # Fix formatting
9696```
9797
9898### Working with Examples
@@ -104,10 +104,10 @@ Start an example to test changes:
104104cd examples/node # or express, nextjs, cf-worker, etc.
105105
106106# Install dependencies (if needed)
107- npm install
107+ pnpm install
108108
109109# Run the example (check the example's package.json for scripts)
110- npm start # or npm run dev
110+ pnpm start # or pnpm run dev
111111```
112112
113113### Changesets (Version Management)
@@ -116,10 +116,10 @@ This project uses Changesets for version management:
116116
117117``` bash
118118# Add a changeset when making changes
119- npm run changeset-add
119+ pnpm run changeset-add
120120
121121# Publish packages (maintainers only)
122- npm run release
122+ pnpm run release
123123```
124124
125125### Running a Single Test
@@ -129,16 +129,16 @@ npm run release
129129cd packages/logfire-api # or packages/logfire-node
130130
131131# Run vitest with a filter
132- npm test -- -t " test name pattern"
132+ pnpm test -- -t " test name pattern"
133133```
134134
135135## Development Workflow
136136
1371371 . Make changes in ` packages/ ` source code
138- 2 . Run ` npm run build` to rebuild packages (or ` npm run dev` for watch mode)
138+ 2 . Run ` pnpm run build` to rebuild packages (or ` pnpm run dev` for watch mode)
1391393 . Test changes using examples in ` examples/ ` directory
140- 4 . Run ` npm run ci ` to ensure linting and type checking pass
141- 5 . Add a changeset if the changes warrant a version bump: ` npm run changeset-add`
140+ 4 . Run ` pnpm run check ` to ensure all checks pass (build, typecheck, lint, format, test)
141+ 5 . Add a changeset if the changes warrant a version bump: ` pnpm run changeset-add`
142142
143143## Important Implementation Details
144144
@@ -182,4 +182,4 @@ The project requires **Node.js 22** (see `engines` in root package.json).
182182
183183## Package Manager
184184
185- Uses ** npm 10.9.2 ** (enforced via ` packageManager ` field).
185+ Uses ** pnpm 10.28.0 ** (enforced via ` packageManager ` field).
0 commit comments