-
-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add documentation for bun and deno using private registry (#4661)
* Add documentation for bun and deno using private registry * Update setup-bun.md * update docs
- Loading branch information
1 parent
b06b2e7
commit 441c226
Showing
9 changed files
with
294 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
--- | ||
id: setup-bun | ||
title: 'bun' | ||
--- | ||
|
||
# bun {#bun} | ||
|
||
- [Example repository](https://github.com/juanpicado/verdaccio-with-bun) | ||
|
||
## Using registry for a specific project {#specific} | ||
|
||
Create a `bunfig.toml` file at the root of the project and set | ||
|
||
```toml | ||
[install] | ||
registry = "http://localhost:4873" | ||
|
||
``` | ||
|
||
On run `bun install` command the installation will be done from the local registry. | ||
|
||
To enable authenticated access to the registry, you can set the token in the `bunfig.toml` file. | ||
|
||
```toml | ||
[install.scopes] | ||
|
||
# as an object with token | ||
"@scope" = { token = "$npm_token", url = "https://localhost:4873/" } | ||
``` | ||
|
||
Bun provides other ways to configure the registry, you can find more information in the official documentation. | ||
|
||
- [Override the default npm registry for bun install](https://bun.sh/guides/install/custom-registry) | ||
- [Configure a private registry for an organization scope with bun install](https://bun.sh/guides/install/registry-scope) | ||
|
||
## Troubleshooting {#troubleshooting} | ||
|
||
### Clear cache with `bun` | ||
|
||
To remove the cache, seems that you need to remove the `bun.lock` file, this file is created when you run `bun install` and it's located in the root of the project. | ||
|
||
> It may be a better way to do this, please share new solutions. | ||
```bash | ||
rm bun.lockb | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
--- | ||
id: setup-deno | ||
title: 'deno' | ||
--- | ||
|
||
- [Example repository](https://github.com/juanpicado/verdaccio-with-deno) | ||
|
||
# deno {#deno} | ||
|
||
The minimum supported [deno](https://deno.com/blog/v1.44) version is >1.44.0 | ||
|
||
## Using registry for a specific project {#specific} | ||
|
||
Create a `.npmrc` file and set | ||
|
||
```bash | ||
registry=http://localhost:4873 | ||
``` | ||
|
||
On run `deno` command the installation will be done from the local registry. | ||
|
||
## Troubleshooting {#troubleshooting} | ||
|
||
### Clear cache with `deno` | ||
|
||
```bash | ||
> deno info | ||
|
||
DENO_DIR location: /Users/user/Library/Caches/deno | ||
Remote modules cache: /Users/user/Library/Caches/deno/deps | ||
npm modules cache: /Users/user/Library/Caches/deno/npm | ||
Emitted modules cache: /Users/user/Library/Caches/deno/gen | ||
Language server registries cache: /Users/user/Library/Caches/deno/registries | ||
Origin storage: /Users/user/Library/Caches/deno/location_data | ||
``` | ||
|
||
And remove the local cache for th specific registry you have set (by default is `localhost_4873`) | ||
|
||
```bash | ||
// for MAC OS users (other OS may vary) | ||
rm -Rf /Users/user/Library/Caches/deno/npm/localhost_4873 | ||
``` | ||
|
||
> It's not clear if there is a better way to do this, please refer to the [following discussion](https://github.com/denoland/deno/discussions/9419) for more information. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
--- | ||
id: setup-bun | ||
title: 'bun' | ||
--- | ||
|
||
# bun {#bun} | ||
|
||
- [Example repository](https://github.com/juanpicado/verdaccio-with-bun) | ||
|
||
## Using registry for a specific project {#specific} | ||
|
||
Create a `bunfig.toml` file at the root of the project and set | ||
|
||
```toml | ||
[install] | ||
registry = "http://localhost:4873" | ||
|
||
``` | ||
|
||
On run `bun install` command the installation will be done from the local registry. | ||
|
||
To enable authenticated access to the registry, you can set the token in the `bunfig.toml` file. | ||
|
||
```toml | ||
[install.scopes] | ||
|
||
# as an object with token | ||
"@scope" = { token = "$npm_token", url = "https://localhost:4873/" } | ||
``` | ||
|
||
Bun provides other ways to configure the registry, you can find more information in the official documentation. | ||
|
||
- [Override the default npm registry for bun install](https://bun.sh/guides/install/custom-registry) | ||
- [Configure a private registry for an organization scope with bun install](https://bun.sh/guides/install/registry-scope) | ||
|
||
## Troubleshooting {#troubleshooting} | ||
|
||
### Clear cache with `bun` | ||
|
||
To remove the cache, seems that you need to remove the `bun.lock` file, this file is created when you run `bun install` and it's located in the root of the project. | ||
|
||
> It may be a better way to do this, please share new solutions. | ||
```bash | ||
rm bun.lockb | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
--- | ||
id: setup-deno | ||
title: 'deno' | ||
--- | ||
|
||
- [Example repository](https://github.com/juanpicado/verdaccio-with-deno) | ||
|
||
# deno {#deno} | ||
|
||
The minimum supported [deno](https://deno.com/blog/v1.44) version is >1.44.0 | ||
|
||
## Using registry for a specific project {#specific} | ||
|
||
Create a `.npmrc` file and set | ||
|
||
```bash | ||
registry=http://localhost:4873 | ||
``` | ||
|
||
On run `deno` command the installation will be done from the local registry. | ||
|
||
## Troubleshooting {#troubleshooting} | ||
|
||
### Clear cache with `deno` | ||
|
||
```bash | ||
> deno info | ||
|
||
DENO_DIR location: /Users/user/Library/Caches/deno | ||
Remote modules cache: /Users/user/Library/Caches/deno/deps | ||
npm modules cache: /Users/user/Library/Caches/deno/npm | ||
Emitted modules cache: /Users/user/Library/Caches/deno/gen | ||
Language server registries cache: /Users/user/Library/Caches/deno/registries | ||
Origin storage: /Users/user/Library/Caches/deno/location_data | ||
``` | ||
|
||
And remove the local cache for th specific registry you have set (by default is `localhost_4873`) | ||
|
||
```bash | ||
// for MAC OS users (other OS may vary) | ||
rm -Rf /Users/user/Library/Caches/deno/npm/localhost_4873 | ||
``` | ||
|
||
> It's not clear if there is a better way to do this, please refer to the [following discussion](https://github.com/denoland/deno/discussions/9419) for more information. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
--- | ||
id: setup-bun | ||
title: 'bun' | ||
--- | ||
|
||
# bun {#bun} | ||
|
||
- [Example repository](https://github.com/juanpicado/verdaccio-with-bun) | ||
|
||
## Using registry for a specific project {#specific} | ||
|
||
Create a `bunfig.toml` file at the root of the project and set | ||
|
||
```toml | ||
[install] | ||
registry = "http://localhost:4873" | ||
|
||
``` | ||
|
||
On run `bun install` command the installation will be done from the local registry. | ||
|
||
To enable authenticated access to the registry, you can set the token in the `bunfig.toml` file. | ||
|
||
```toml | ||
[install.scopes] | ||
|
||
# as an object with token | ||
"@scope" = { token = "$npm_token", url = "https://localhost:4873/" } | ||
``` | ||
|
||
Bun provides other ways to configure the registry, you can find more information in the official documentation. | ||
|
||
- [Override the default npm registry for bun install](https://bun.sh/guides/install/custom-registry) | ||
- [Configure a private registry for an organization scope with bun install](https://bun.sh/guides/install/registry-scope) | ||
|
||
## Troubleshooting {#troubleshooting} | ||
|
||
### Clear cache with `bun` | ||
|
||
To remove the cache, seems that you need to remove the `bun.lock` file, this file is created when you run `bun install` and it's located in the root of the project. | ||
|
||
> It may be a better way to do this, please share new solutions. | ||
```bash | ||
rm bun.lockb | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
--- | ||
id: setup-deno | ||
title: 'deno' | ||
--- | ||
|
||
- [Example repository](https://github.com/juanpicado/verdaccio-with-deno) | ||
|
||
# deno {#deno} | ||
|
||
The minimum supported [deno](https://deno.com/blog/v1.44) version is >1.44.0 | ||
|
||
## Using registry for a specific project {#specific} | ||
|
||
Create a `.npmrc` file and set | ||
|
||
```bash | ||
registry=http://localhost:4873 | ||
``` | ||
|
||
On run `deno` command the installation will be done from the local registry. | ||
|
||
## Troubleshooting {#troubleshooting} | ||
|
||
### Clear cache with `deno` | ||
|
||
```bash | ||
> deno info | ||
|
||
DENO_DIR location: /Users/user/Library/Caches/deno | ||
Remote modules cache: /Users/user/Library/Caches/deno/deps | ||
npm modules cache: /Users/user/Library/Caches/deno/npm | ||
Emitted modules cache: /Users/user/Library/Caches/deno/gen | ||
Language server registries cache: /Users/user/Library/Caches/deno/registries | ||
Origin storage: /Users/user/Library/Caches/deno/location_data | ||
``` | ||
|
||
And remove the local cache for th specific registry you have set (by default is `localhost_4873`) | ||
|
||
```bash | ||
// for MAC OS users (other OS may vary) | ||
rm -Rf /Users/user/Library/Caches/deno/npm/localhost_4873 | ||
``` | ||
|
||
> It's not clear if there is a better way to do this, please refer to the [following discussion](https://github.com/denoland/deno/discussions/9419) for more information. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters