Skip to content

chore: replace yarn scripts with pnpm scripts #1100

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 0 additions & 6 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,6 @@
# dependencies
/node_modules
/.pnp
.yarn/*
!.yarn/patches
!.yarn/releases
!.yarn/plugins
!.yarn/sdks
!.yarn/versions
.pnp.*

# testing
Expand Down
35 changes: 31 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,25 +12,52 @@ Here is a quick guide to doing code contributions to the library.

3. Install packages by running:

> yarn
```shellscript
pnpm install
```

4. Startup a local version of the docs

> yarn start
```shellscript
pnpm run dev
```

5. Ensure your code is formatted properly

> yarn format
```shellscript
pnpm run format
```

6. Push your branch: `git push -u origin your-meaningful-branch-name`

7. Submit a pull request to the upstream react-hook-form repository.

8. Choose a descriptive title and describe your changes briefly.

## Testing production build

To test the documentation production site on your local machine,
first execute the build script:

```shellscript
pnpm run build
```

Then start a local server which serves the file created by executing

```shellscript
pnpm run start
```

## Coding style

Please follow the coding style of the project. React Hook Form uses prettier. If possible, enable the prettier plugin in your editor to get real-time feedback. The formatting can be run manually with the following command: `yarn format`
Please follow the coding style of the project.
React Hook Form uses prettier.
If possible, enable the prettier plugin in your editor to get real-time feedback. The formatting can be run manually with the following command:

```shellscript
pnpm run format
```

## License

Expand Down
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@

## Install

yarn && yarn start
```shellscript
pnpm install && pnpm dev
```

## Backers

Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -60,14 +60,14 @@
"dev": "next dev",
"format": "prettier --write",
"lint": "next lint --fix",
"now-build": "npm run build",
"now-build": "pnpm run build",
"start": "next start",
"typecheck": "tsc --noEmit",
"prepare": "husky install"
},
"lint-staged": {
"*.{ts,tsx,mdx,css,json}": [
"npm run format"
"pnpm run format"
]
}
}