Skip to content

Commit 0722c27

Browse files
committed
update docs from yarn to pnpm
1 parent da3ab5c commit 0722c27

File tree

6 files changed

+24
-25
lines changed

6 files changed

+24
-25
lines changed

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
**/node_modules/
22
**/.DS_Store
33
**/dist
4-
**/yarn-error.log
54
lerna-debug.log
65

76
.openhands

DEVELOPMENT.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
# Development Guide
22

3-
This project is a Yarn/Lerna workspace for PostgreSQL parser and deparser functionality. Follow these steps to get started with development.
3+
This project is a pnpm/Lerna workspace for PostgreSQL parser and deparser functionality. Follow these steps to get started with development.
44

55
## Prerequisites
66

7-
- Node.js (v14 or higher recommended)
8-
- Yarn package manager
7+
- Node.js (v18 or higher recommended)
8+
- pnpm package manager
99

1010
## Initial Setup
1111

1212
1. Install dependencies:
1313
```bash
14-
yarn
14+
pnpm install
1515
```
1616

1717
2. Build all packages:
1818
```bash
19-
yarn build
19+
pnpm build
2020
```
2121

2222
## Running Tests
@@ -29,10 +29,10 @@ To run tests for a specific package, navigate to that package's directory and us
2929

3030
```bash
3131
cd packages/deparser
32-
yarn test:watch
32+
pnpm test:watch
3333
```
3434

35-
you can also run `yarn test` if you don't need to watch.
35+
you can also run `pnpm test` if you don't need to watch.
3636

3737
This will start Jest in watch mode, which will automatically re-run tests when files change.
3838

@@ -62,11 +62,11 @@ packages/
6262

6363
## Common Commands
6464

65-
- `yarn build`: Build all packages
66-
- `yarn test`: Run all tests
67-
- `yarn test:watch`: Run tests in watch mode
68-
- `yarn lint`: Run linter
69-
- `yarn clean`: Clean build artifacts
65+
- `pnpm build`: Build all packages
66+
- `pnpm test`: Run all tests
67+
- `pnpm test:watch`: Run tests in watch mode
68+
- `pnpm lint`: Run linter
69+
- `pnpm clean`: Clean build artifacts
7070

7171
## Notes
7272

PUBLISH.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ This guide covers the multi-version publishing workflow for the pgsql-parser mon
77
Before publishing any packages, you must build the entire monorepo:
88

99
```bash
10-
yarn && yarn build
10+
pnpm install && pnpm build
1111
```
1212

1313
This installs all dependencies and builds all packages in the correct order using Lerna.
@@ -48,7 +48,7 @@ All version mappings are centrally managed in `config/versions.json`:
4848
In the root:
4949

5050
```
51-
yarn bump-versions
51+
pnpm bump-versions
5252
```
5353

5454
## Package Publishing Workflows

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -183,10 +183,10 @@ This project uses Yarn workspaces and Lerna for monorepo management. See [DEVELO
183183
### Setup
184184
```bash
185185
# Install dependencies
186-
yarn install
186+
pnpm install
187187

188188
# Build all packages
189-
yarn build
189+
pnpm build
190190
```
191191

192192
### Building Individual Packages

packages/transform/DEBUGGING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
you can put any sql here packages/transform/scripts/input.sql
44

55
then in packages/transform
6-
yarn test:ast
6+
pnpm test:ast
77

88
it will generate
99
packages/transform/scripts/output-v13.json
@@ -225,7 +225,7 @@ Always consult the enum files when debugging transformation issues involving num
225225
**⚠️ CRITICAL RULE: Never look at CI logs or use CI-related commands during development.**
226226

227227
When debugging transformation issues:
228-
- Run tests locally using `yarn test __tests__/kitchen-sink/13-14` or similar
228+
- Run tests locally using `pnpm test __tests__/kitchen-sink/13-14` or similar
229229
- Examine local test output and failure messages
230230
- Reproduce issues locally and verify fixes locally
231231
- Only push changes after verifying they work locally
@@ -238,7 +238,7 @@ This ensures faster feedback loops and prevents dependency on external CI system
238238
**⚠️ CRITICAL RULE: Never look at CI logs or use CI-related commands during development.**
239239

240240
When debugging transformation issues:
241-
- Run tests locally using `yarn test __tests__/kitchen-sink/13-14` or similar
241+
- Run tests locally using `pnpm test __tests__/kitchen-sink/13-14` or similar
242242
- Examine local test output and failure messages
243243
- Reproduce issues locally and verify fixes locally
244244
- Only push changes after verifying they work locally

packages/transform/FIXING.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,15 +25,15 @@ Welcome! This guide will walk you through the process of solving skipped transfo
2525
4. **Install dependencies and build the project**:
2626

2727
```bash
28-
yarn
29-
yarn build
28+
pnpm
29+
pnpm build
3030
```
3131

3232
5. **Navigate to the transform package and run tests**:
3333

3434
```bash
3535
cd packages/transform
36-
yarn test
36+
pnpm test
3737
```
3838

3939
---
@@ -59,7 +59,7 @@ Each entry looks like this:
5959
You can run an individual test like this:
6060

6161
```bash
62-
yarn test __tests__/kitchen-sink/16-17/pretty-misc.test.ts
62+
pnpm test __tests__/kitchen-sink/16-17/pretty-misc.test.ts
6363
```
6464

6565
---
@@ -71,7 +71,7 @@ yarn test __tests__/kitchen-sink/16-17/pretty-misc.test.ts
7171
3. Re-run the test to confirm it now passes:
7272

7373
```bash
74-
yarn test __tests__/kitchen-sink/16-17/pretty-misc.test.ts
74+
pnpm test __tests__/kitchen-sink/16-17/pretty-misc.test.ts
7575
```
7676

7777
Then, commit your fix and open a pull request.

0 commit comments

Comments
 (0)