From a3d0b45cc079f4ec1716f8140575ef7785721cec Mon Sep 17 00:00:00 2001 From: Jarred Sumner Date: Sat, 12 Feb 2022 03:21:52 -0800 Subject: [PATCH] readme --- README.md | 99 ++++++++++++++++++++++++++++++++++- packages/bun-error/bun.lockb | Bin 11916 -> 12297 bytes src/fallback.version | 2 +- src/runtime.version | 2 +- 4 files changed, 100 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ccb2644499..a33c8c411a 100644 --- a/README.md +++ b/README.md @@ -53,6 +53,7 @@ If using Linux, kernel version 5.6 or higher is strongly recommended, but the mi - [Troubleshooting](#troubleshooting) - [Reference](#reference) - [`bun install`](#bun-install) + - [`Configuring bun install`](#bun-install) - [`bun run`](#bun-run) - [`bun create`](#bun-run) - [`bun bun`](#bun-bun) @@ -642,7 +643,103 @@ To fix this issue: `bun install` is a fast package manager & npm client. -Environment variables +`bun install` can be configured via `bunfig.toml` and environment variables. + +#### Configuring `bun install` with `bunfig.toml` + +`bunfig.toml` is searched for in the following paths on `bun install`, `bun remove`, and `bun add`: + +1. `$XDG_CONFIG_HOME/.bunfig.toml` or `$HOME/.bunfig.toml` +2. `./bunfig.toml` + +If both are found, the results are merged together. + +Configuring with `bunfig.toml` is optional. bun tries to be zero configuration in general, but that's not always possible. + +```toml +# Here's how to use scoped packages with bun install +[install.scopes] +# The key is the scope name +# The value can be a URL string or an object +# It can be a string or an object +# The registry object's url is optional +# If omitted, the default registry is used +"@mybigcompany" = { token = "123456", url = "https://registry.mybigcompany.com" } + +# The "@" is optional +mybigcompany2 = { token = "123456" } + +# Environment variables can be referenced as a string that starts with $ and it will be replaced +mybigcompany3 = { token = "$npm_config_token" } + +# Setting username and password pass it along as a Basic Auth header by taking base64("username:password") +mybigcompany4 = { username = "myusername", password = "$npm_config_password" } + +# You can set a token for a registry URL: +mybigcompany5 = "https://:$NPM_CONFIG_TOKEN@registry.yarnpkg.com/" + +# You can set username and password for a registry URL: +mybigcompany6 = "https://username:password@registry.yarnpkg.com/" + + +[install] +# Default registry +# can be a URL string or an object +registry = "https://registry.yarnpkg.com/" +# as an object +registry = { url = "https://registry.yarnpkg.com/", token = "123456" } + +# Install for production? This is the equivalent to the "--production" CLI argument +production = false + +# Don't actually install +dryRun = true + +# Install optionalDependencies (default: true) +optional = true + +# Install local devDependencies (default: true) +dev = true + +# Install peerDependencies (default: false) +peer = false + +# When using `bun install -g`, install packages here +globalDir = "~/.bun/install/global" + +# When using `bun install -g`, link package bins here +globalBinDir = "~/.bun/bin" + +# cache-related configuration +[install.cache] +# The directory to use for the cache +dir = "~/.bun/install/cache" + +# Don't load from the global cache. +# Note: bun may still write to node_modules/.cache +disable = false + +# Always resolve the latest versions from the registry +disableManifest = false + + +# Lockfile-related configuration +[install.lockfile] + +# Print a yarn v1 lockfile +# Note: it does not load the lockfile, it just converts bun.lockb into a yarn.lock +print = "yarn" + +# Path to read bun.lockb from +path = "bun.lockb" + +# Path to save bun.lockb to +savePath = "bun.lockb" +``` + +#### Configuring with environment variables + +Environment variables have higher priority than `bunfig.toml`. | Name | Description | | -------------------------------- | ------------------------------------------------------------- | diff --git a/packages/bun-error/bun.lockb b/packages/bun-error/bun.lockb index 825941f445beb0d783a302c9eea2edf3475039f1..8ef3895a70ed47fde68ad3f41934aa5c98e2877f 100755 GIT binary patch literal 12297 zcmeG?3pkWp*E1T|Zn`L!5=j>s*NKX9Dy($h5#5%7(D zSX^T!H&n+bgsXx+Dx2pU=*MC+seU{@hc2Xsny8RTBvQCB`h#GM1d)^otVm#Q0zcK2 z6nsJeE0ai~Aq3_#>Apf#9*@4hsC@*&eGr~c&?gcY@rda`1VaI;k3;>k5mrH1+)QN& zl2Lsqs^fkUMExGZAfJP9KZF+}JP6_E2qW1drobnJ#b%IZ%aKTGs6H9tfe4Q!usXu3 zsIEZNKOpl5p!#EkK~5#Yz;}wk=?EhmMTrD`HNw!Ji!jLXBCr#}z-Ngt=+i@ZFv0^7 zhW;IBd_dQJNL#kKw5~Wp-Kw1x>*kmA=j{g?NfldNH`L~8d(Kjks|yzGurnLqn6ytx)TYZi#?EGCp{=tXJp-xq=ZY1T+c*K4px2N*B(2SZJ(^uE(?1)6QW%ScU zyY-f*Y%eKH8ybuI|CBL@* z;x1LaDGp(ZEroqQ2=wO;;O%3F3?MxV{jK46pWk9SDHD?poP0P(g{LCWo8mOG_f(6l zge$RgEO$K0ZSp3E$;Dq|xPOQXukYxUSa5f;n$o?A17}?0|I)7|X|;eg#x4Fmsis%? zOxDZ*zj+!V3Km;T*td4#a?_{fFS6@==f$(EFp~#`>T?@ct-Z zzMk-aY|IB`6sM$~`lT1*LF?s*0qcXEMIL>?|096;pznX;&;E!HboO)}(AtK5rpJ7E zj6Kzd_CAsV`oK3o0@yF$N3icdnLoVC_e3AI??>Yej}yj+_U9h^6ZqiksXoL4=L77y zKLmK3(D^4{x66L|rP~+MrJsJ0_C|O4|GQtnQrM&6gFOlMG}xbdqYnTu?2+j1D+a(o zhdl*u(|A9U#;}L0qYnTu@M}N?0bt$eoExNitPRsVh@a@i7Cn64~MB{iT5&F=Z zNgU@8>(XEuEIIipF)LjPOMN=(%c|D2=X7Z1ef`qk`SeHcHsi(1URL#Qs~gq0q-@iU z_$Gb#@tlW;Zf^CnQQO>E`bNII*en9zssptARvlkk8>K-n=q-#Vak(Wk&|&rd3q-Qs^A{d!Bn z?WfD%+3PJ!PAH8U_@H#@1npjC&ix*~SmvgiKzr*PJl#O$zC;X~uBXJFr3u6XYHsc+nbF>`Me?qq+OVYy*)z)t0pWA5!Azu-fm>E!L?lS!>f zdXt?>9z7bJo6oBnC!-JI1?CR!u+l&&l0*>Y&a-`*B!g_aM{19;iFwoca1PM|P}2O2wwSx`&IG_HXsB_oWPX6bxVG7!;&q zwNj)N?nNhhGWRCuq8fzUUWsLI}%^U~o2K=Wr6u441bGgKvZ z;u4Lae!uH`aI$Q+*q9^1&&o^b)z}IYi&1xGz#3`Ngz_HB0VkPJ-oIpWyO(rBQbjo}@f zSx6f?>wbn-;2p-oY|W(H6pv@`64K*?OCFV5o>yvbIWQ~Xn)2XDqvv~aE*PAwd#!n; z)I96U!K&MCFYv$!eQ@^Udj=)}-n5OFze6Rj8Lb%`o2q~FH#LiKxo+>(dz0_ev5I9+ ztTdX#d{u|9^QU+!>rT?8T^N^5S`b?OMDuclo!=gg?(V}zUZ2-sp;G>YCU{?e56ESu zw>VzA!~CYd&+lAyAmfNj#vkjy*YV%A5&B@>z!KRxNnRxpK#4BTuueNY!(rr-+YZI& z%Ivx zH;?O|GU;eW_GsF^WSw?}?PmwAWp}=-_wvfqhFr;-ob%-1x$N+U5<* z*q`=&=^K5Mx}PQy({(<;J`FJgpES5u5b^SgK9*MQBrJ&f7#7$%T<+lfs_B*Q)RMlc z%6qnYPA(YfROdhJS#wkKgEqSXrbQZ8w@g{fQjZ(!*5LTI*5=P^pRiCeg(N~{eD1+- zP14Yy87i()nnyR*Octz_&pAs|H=>_=bK&zKw)ZoSqWh=L)UUMk@Y@uyGBZthKEU&E z{iWM$pUho;bm}_iOT&k{r#&VO=jeN2p=6Sh2$iuue9y+@8@D9^LrI#bxG5v{tmUOX zhFjF_TRhYgJ5-(IO{V@ae%zX}K6A|GrRcq`h&rY+*lWVA)V5m|&T&eN`B#M<^KzFz zz3b=aj|GyIzOj!u&M}o#-N+S}DIUdt&dn{Zc=nKp%F#O!&QG z{~ra`cMc{O&e$dVx+gYSq_)laSJitLR%MOQPl^m3U+2+!8%sp?*`hMOx1it1zkxf! zl9fs^SYE6WA6EZsRQh3O;c$*Bvm)7qxpDHvinGG@HV3uCM=F3dn>DXjJL=f3S$K`@ z=4-I!YjOIbjvE5kErm4pTZf_qg~p}Kp#_!ius||N4)zqR5AHG2@P!;Hu2Q(Cy;d9y zkBWbv-S3W~;;;6;?eRD7mn22k+)wQc`j}~Ueb|6l{ZheVx%^2_i#a!1c9s+cW)^GY zGoH(3C+f7@VxeexN$bP!I!t~^hX3h6@f+#1A|_+^r1vj}z9>EL!oe`2zgDTSqTgbT zZ3a76>?7^^7?|3zB4AG7`fT@;mqn`HY|`V`bHnT8>K-> zj#z&U6Y>up?YQ;4b)K3@BO|A1TH|c1qOE1TWX_cxn-!02w)W&S@%h|Wrz0bl|5Ewf z;ke-h`xWKBZIvZy>Hb0%KF?tjleUl8zPeN@$VH3Gluaj{ZM`>da~`b|;h1&zOhIJj z=aZ-U*Ns|Zzo?xys61@Z7`Oc%cSM`>qFNl*XXM5oNZh{i+N=BYF*(7$dQ0Cv!V=N` zBCQYJ!P4-U944+(3U}u_&N@|jQ?6#h^Gcmij@5FbUdLwG7RiTdPIGDh>SEJi@RV6` zNB#--^MGUJ`V)CO+&+xz_*HHQI+bfxs=MPw?i+n0q?Muab+Y8Q2rrMpcb2%FSIr{f?0_8p-`_3!vZ5q}vYsHNbw`|tDJXEGNaBkTJHMNOXicFhR z4{Tc$)q>@s^&oAZ4sIv#E!}W&i4tDRr@i=ac=^FYEJ5gzmVUH(K1-&aFidYC`+WLn zw~lg2ZC31Y!8EG(l#+@9a{3tS22J;AWOBUM$rr%+aWfy7p!WW#(92! z_ge?IL*)xQs!|`-8DY6-{$Ro5^*0i?6SxV_-OAP( z&%vu{$(e*E4L@o^)bqL8Yb06ow8| zWVa3Ua~joW%ZcQRiTc&q2DX<)kr6s7US9f&=PYc>a}uc(QkcfIqF zebV~$W%OA-Cic(72A#H7VWHOVyw|#yC|t|nwfw$!?Z(d=^ev)~?7B2u=kpc^uDXz+ zy>8zSi;FGxvB^iV|TDEcimca2tmNXK%KeX!=Seef=mh9+`?xJpsT(hqaHU8BHj zo}6ya47T-Dud>nDV_5U*k_W|NdeW1!3E+C!_(w6z|!%eIzQ#zOCUbhP#I}z~B|N zP#c_u(l8cP;O#37<4{HR-93+3Q%?yD=bJqG;GPS=S;6lf@Ro)5CA|6I9R_bBc(1@4 z0`B#2*9KpL@4#0&=mTGX?O-d|2I67t;BW9R_!ImG{sRAiKfr#l7wiLjVEi!NPsG?t zKmY<*|KF1XJTQLX1KGF^_TcjObb+mKSHgY3ZWtrj4j5=K4xqyjU^t`D2eyHYV5<)L zz;^Hf_yT+az5ySBufS*EJMba+5`21{u;;BIsvrQn@EL>il;p@>CPt<-BU6(+Ll;vm z3eFS5c~6LLYGO12b&=4)7BprN&Z9zfb0gD9MkXW)9p|s%d@SI%G%_(VBj_+bBtwMr zwq)sGBitcy{ua=UOp$nke>|bTE6r8>5FN!=_xNPv zOOoA9THhj^&nHI~FJCiL!hbkV66gKN z(s4c|&JUEO%;fWVd`X~FeR-T9x=^y}7(5P} z#}hEAC{vo{7tZquVEPKFbb)}if-CU#XEH+AOg>spD4ca7BX!WmjYgDYgN6cQTwOfG}TM@&?Kkk8_-Aex1II+7t|@wn6#d|pUU z5T6%B6@~{f1p*G)TqadAPCA3Z;|i!jA$({NOXILsvbac+5b2hrbhEgjbUusD z6^c{8CE3u#;YmgE_&gSaO6PMdXt${JXSuGFge4xlG}=gXaY? px!<-3LbyDElzGS{3|^Q($`;(xtqHe?hfjo`__BiTEB`hB{sonzQGx&f delta 4187 zcmeH~c~n!!8o+at5ZSkgfe?})VFwLjz<_`XwouU~fT#!-lvNf%p$aZUIczP~#1V^t ziYq9nY@#A4F2@Jd+8_c_sh|Ri(h6-6K?-l~y;;gR@0|DFd+(1o=iK?0`M%$LGxy%y zNp5Ifh}g!70Na#3+7k$6Y)lX=a6#Cd!t7lfa`0By&E1BslQG!=k$$hv#~#^yB@k31 zhN|M%PoEo!?;inDqy+3DZg8DmK|#<|GMqw^X#YP?8bG%%dnu zA;JvwnuUQjK^u&6sAz_q{eS0wbVK@xbkM4mfFOXcy-f{4rgf&_lScyWsE*Z(xriBZ8WA^7me}JL;D+8Z>`S~x+UQcF?o-}2}x&m_T^1xslMNW zQvItgv3J>7THhROmfrtua8&qvkh4y!dw9+pgD175C9g`>*-!VcH`_Gs=dxXHcV}eJYhDbaB$gM#vj&>>TTpj9Py2Z(c9$H@APjt9HQsV%YTol~>(T z!-~cfX5Nu0-$y?D7>nleIQrP~gaNjlUzMNFv6dqTf)<)!6m*6mjJ;tlIztQA^9@k_ zg26T|`R<_agFXl&Q-$SavK8jmZT#4yQpT9WI2KdvZ=aEM@R;8%`&H|?f=2b16>kN1 z$*b-%3lA7byuPX5dTsrqdQEj>7MoD>S>wL6e9e=)74zrLV+rerlkrt80oC_igA&H) zhB>>tW(%dj(T*``+*=a7ziIe2f2U+ymtjGy&y%!6?i-7ocApP-qj@*IV{Sh1>2ckT zKfG?petqDoCLs0V!&IDVx5l^VQnl3Z+|63gE9@{v=2XR{pReU7TArpjCdMIF$JPGW z|D{WDP2HmQvGDTrwbuQEKlDz%(Paf@37z?GbQHD5&{)Fq>Uf+QC4QN@V$8YRb+r9( z^6gaXsHrVK32R5I=4YsUtXec;vwS;G^C5^75``H4N9gCQmli zRon*ow&by%zSegGTJ1y66jW;?mVXC=KNIA`iMCefBin7f!?ql4?*BAV%2-F~Sm)P$ zA|!J|T#oy94|;hTE^;a&0!2n9{x6WP zF%S9Hy`z!*+Diph!^!8%NkiG43h4{@Ml#Q6kGz(pqu#jA|jl7BEsYu9oZx)>wCOHZ!4YRQQEi4v!rUF zUiQ+cuMb<)E#_aYXwP=kSvOEfOEw!%TefoPwkq-1YWDQa<@=12(02=M2to$CA@?Sd zg4yKBi;NZh3%8$0JTta$$<@)a9X*qppVvM1YP{<4pfZcP`aQd~Jo*-Q(O`qQX0lJ1 zCCB{G$ERP-e466hId-H?h%pMvC4zT!lYk3IEY4NQs&DH|x0*O;ofmI%=?Cx6zp@VN zDf)AVho{*b5tICJ%c^CQ)48V6w2JU7H;Erb$MQsRx!U5P(!l5LUsIzR6gKggsJ>AOe4j^U^eBWPdtP)L3EhV2DBv$l0`DBhxFtzhZcfa~A|UxS`$@@!%kPtCmQ6h^ za@X)^NTo?nMgK)(4pE=Sz8V`;kRiB&!B|^&NA_xTE!#=rHH?2-9~ZeHGdg$49^Uok z&-##!etjXWF)7Sn7S1o-XLIi8q=iTGLtWA$jVlqkk*7@K2HM0$>qpOSbya}L@C0FE zVjM8zEW&(bug=0#;=bp*ZEA`q-hLo{_hpCWtlux9n$!}_}yCz z{odsnY~K`qT*JEir!E~af3WQ-RB;15U=?*pBgjTdfJTk@}*YivMB0kS7`m}FQ0pfB1;3;WH6!%L@wt3p35IN z-fSt{`a+Vqba+qiBPJq!r;@X#E1)SK2sO^6>q8b-HpzcM;@@4x#QzH=F|plHlqB05 z!VIpcfi@zQm-8onvPO^b@_>KmBi0C6Bm@XpRy6@^5wci~KoFrPc2q8rNn0qjpv{6( z6H1}Xzda&s3;Hpa6h!l!;Q`nHj+sLV@1BS%lO!m0p*;%E5~#lqNu3J`I$pLYzY;(zFEx*TIl2Z_a>GZn^O`t z1A%$478N?+juPg;ivk+WSq>-$O>2S|+Ga&S8(kJUJ-S)gl)%Vh9Z0tDR+aApkXq0w zqLHUC0*pWv2Eqn(Efp$PsS1>8qEZzr)k>u*RjU6wmTN_);7=aF0?=B$fmoR)h5;nJ zvPxyF6sqCaUqmnhRjgcCueCzuDpdhg3-Q=Qr5Bw-MyOPJrBIb~XM1Hua%~h-2%wrE z<0`#k8=9H}m*9*2&jppZMaCB(#VuL2BeN`BTP#m@6S%mQkQ@^qVGjhjC1WPymW(2v z6||`kR3O1koNW%Oa1+6n?F`!N=22lT9xN+>;7hDgw|{|DFH}SR36vsii~s-t diff --git a/src/fallback.version b/src/fallback.version index 6d559b7b7b..1705429c42 100644 --- a/src/fallback.version +++ b/src/fallback.version @@ -1 +1 @@ -9effd1b1e91cdf3 \ No newline at end of file +c212be1d3ec811cc \ No newline at end of file diff --git a/src/runtime.version b/src/runtime.version index 0dcfada049..2dbb44452c 100644 --- a/src/runtime.version +++ b/src/runtime.version @@ -1 +1 @@ -ee448e44f6cf1e3c \ No newline at end of file +ca1cb170bea8ecef \ No newline at end of file