Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nickserv/react-unpin
Unpin your framework's React version to install it locally
https://github.com/nickserv/react-unpin
cli dependencies diagnostics info next node react rsc server-rendering utility version
Last synced: 2 months ago
JSON representation
Unpin your framework's React version to install it locally
- Host: GitHub
- URL: https://github.com/nickserv/react-unpin
- Owner: nickserv
- Created: 2023-12-24T07:48:21.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-25T10:28:38.000Z (7 months ago)
- Last Synced: 2024-10-22T04:14:25.909Z (2 months ago)
- Topics: cli, dependencies, diagnostics, info, next, node, react, rsc, server-rendering, utility, version
- Language: TypeScript
- Homepage: https://npm.im/react-unpin
- Size: 108 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# `react-unpin`
> Unpin your framework's React version to install it locally
This helps to avoid breaking changes between
[React Canaries](https://react.dev/community/versioning-policy#canary-channel)
used by your framework and other tools, such as when using Server Components in
tests, docs, or monorepo packages.
> [!NOTE]
> This is unnecessary with newer versions of Next (since `14.3.0-canary.45` and
> `15.0.0-rc.0`), which have started using `peerDependencies` to keep the React
> version consistent.
## [API Docs](https://tsdocs.dev/docs/react-unpin)
## Usage
```
unpin [path]
```
```
react-unpin [path]
```
By default, `unpin` and `react-unpin` will print the React version pinned in the
current directory's package. You can optionally provide a single path to check a
different directory's package. The React version pinned by Server Component
frameworks typically starts with `18.3.0-canary-` or `19.0.0-canary-`.
### Zero Install
```
npx react-unpin@latest
```
```
yarn dlx react-unpin
```
```
pnpm dlx react-unpin
```
```
bun x react-unpin
```
### Local Install
Installing `react-unpin` locally isn't necessary unless you want to use it in a
library or script.
```
npm install react-unpin
```
```
yarn add react-unpin
```
```
pnpm add react-unpin
```
```
bun add react-unpin
```
## Caveats
- Only Next app router is supported currently since Next has the strongest
support for Server Components and its pages router doesn't pin React.
[#9](https://github.com/nickmccurdy/react-unpin/issues/9)
[#10](https://github.com/nickmccurdy/react-unpin/issues/10)
- A `node_modules` directory is required to resolve local Next installations,
therefore Yarn PnP is unsupported.
[#2](https://github.com/nickmccurdy/react-unpin/issues/2)
- Internet access is required to read Next's source code since its package
manifests exclude pinned React versions.
[#11](https://github.com/nickmccurdy/react-unpin/issues/11)