From 9ec397bad5407fd69b9b6762ef000eaa76c04bce Mon Sep 17 00:00:00 2001 From: Jonas Auer Date: Fri, 4 Mar 2022 19:30:48 +0100 Subject: [PATCH] docs(examples): Add Yarn PnP example --- examples/yarn-pnp/.eslintrc.js | 3 ++ examples/yarn-pnp/.gitignore | 19 +++++++++ examples/yarn-pnp/README.md | 54 +++++++++++++++++++++++++ examples/yarn-pnp/app/entry.client.tsx | 4 ++ examples/yarn-pnp/app/entry.server.tsx | 21 ++++++++++ examples/yarn-pnp/app/root.tsx | 32 +++++++++++++++ examples/yarn-pnp/app/routes/index.tsx | 18 +++++++++ examples/yarn-pnp/package.json | 32 +++++++++++++++ examples/yarn-pnp/public/favicon.ico | Bin 0 -> 16958 bytes examples/yarn-pnp/remix.config.js | 10 +++++ examples/yarn-pnp/remix.env.d.ts | 2 + examples/yarn-pnp/sandbox.config.json | 6 +++ examples/yarn-pnp/tsconfig.json | 19 +++++++++ 13 files changed, 220 insertions(+) create mode 100644 examples/yarn-pnp/.eslintrc.js create mode 100644 examples/yarn-pnp/.gitignore create mode 100644 examples/yarn-pnp/README.md create mode 100644 examples/yarn-pnp/app/entry.client.tsx create mode 100644 examples/yarn-pnp/app/entry.server.tsx create mode 100644 examples/yarn-pnp/app/root.tsx create mode 100644 examples/yarn-pnp/app/routes/index.tsx create mode 100644 examples/yarn-pnp/package.json create mode 100644 examples/yarn-pnp/public/favicon.ico create mode 100644 examples/yarn-pnp/remix.config.js create mode 100644 examples/yarn-pnp/remix.env.d.ts create mode 100644 examples/yarn-pnp/sandbox.config.json create mode 100644 examples/yarn-pnp/tsconfig.json diff --git a/examples/yarn-pnp/.eslintrc.js b/examples/yarn-pnp/.eslintrc.js new file mode 100644 index 00000000000..ced78085f86 --- /dev/null +++ b/examples/yarn-pnp/.eslintrc.js @@ -0,0 +1,3 @@ +module.exports = { + extends: ["@remix-run/eslint-config", "@remix-run/eslint-config/node"], +}; diff --git a/examples/yarn-pnp/.gitignore b/examples/yarn-pnp/.gitignore new file mode 100644 index 00000000000..61ea1d3ccea --- /dev/null +++ b/examples/yarn-pnp/.gitignore @@ -0,0 +1,19 @@ +node_modules + +/.cache +/build +/public/build +/package-lock.json + +.yarn/* +!.yarn/patches +!.yarn/plugins +!.yarn/releases +!.yarn/sdks +!.yarn/versions + +# Swap the comments on the following lines if you wish to use zero-installs +# See https://yarnpkg.com/features/zero-installs and +# https://yarnpkg.com/getting-started/qa#which-files-should-be-gitignored +.pnp.* +# !.yarn/cache diff --git a/examples/yarn-pnp/README.md b/examples/yarn-pnp/README.md new file mode 100644 index 00000000000..dec12bce575 --- /dev/null +++ b/examples/yarn-pnp/README.md @@ -0,0 +1,54 @@ +# Welcome to Remix! + +This is a very basic example of a Remix app, using the Remix App Server and Yarn PnP. + +- [Remix Docs](https://remix.run/docs) +- [Yarn Plug'n'Play](https://next.yarnpkg.com/features/pnp) + +## Development + +From your terminal + +```sh +yarn install +yarn dev +``` + +This starts your app in development mode, rebuilding assets on file changes. + +## Deployment + +First, build your app for production: + +```sh +yarn build +``` + +Then run the app in production mode: + +```sh +yarn start +``` + +## Notes for Using Yarn PnP + +- You'll need to use Yarn ≥ v3.2.0. Older versions don't work because of [an issue with Yarn](https://github.com/yarnpkg/berry/issues/3687). +- For editor support of PnP, refer to [Editor SDKs](https://yarnpkg.com/getting-started/editor-sdks). +- When using TypeScript, consider installing the [Yarn TypeScript plugin](https://github.com/yarnpkg/berry/tree/master/packages/plugin-typescript). +- For the `~/*` alias to work for imports relative to `app/*`, you have to add this to your `package.json`: + ```json + "dependencies": { + /* ... */ + "~": "link:app/" + } + ``` + You can then also remove the `~` alias from your `tsconfig.json`. +- For only installing non-dev dependencies in production, you can use [`yarn workspaces focus`](https://yarnpkg.com/cli/workspaces/focus) after removing the `.yarn/cache` directory: + ```sh + yarn install + yarn build + rm -r .yarn/cache + yarn workspaces focus --production + yarn start + ``` + Or check out [plugin-installs](https://gitlab.com/Larry1123/yarn-contrib/-/blob/master/packages/plugin-production-install/README.md) by [Larry1123](https://gitlab.com/Larry1123). diff --git a/examples/yarn-pnp/app/entry.client.tsx b/examples/yarn-pnp/app/entry.client.tsx new file mode 100644 index 00000000000..3eec1fd0a02 --- /dev/null +++ b/examples/yarn-pnp/app/entry.client.tsx @@ -0,0 +1,4 @@ +import { RemixBrowser } from "@remix-run/react"; +import { hydrate } from "react-dom"; + +hydrate(, document); diff --git a/examples/yarn-pnp/app/entry.server.tsx b/examples/yarn-pnp/app/entry.server.tsx new file mode 100644 index 00000000000..5afa18235cc --- /dev/null +++ b/examples/yarn-pnp/app/entry.server.tsx @@ -0,0 +1,21 @@ +import type { EntryContext } from "@remix-run/node"; +import { RemixServer } from "@remix-run/react"; +import { renderToString } from "react-dom/server"; + +export default function handleRequest( + request: Request, + responseStatusCode: number, + responseHeaders: Headers, + remixContext: EntryContext +) { + const markup = renderToString( + + ); + + responseHeaders.set("Content-Type", "text/html"); + + return new Response("" + markup, { + status: responseStatusCode, + headers: responseHeaders, + }); +} diff --git a/examples/yarn-pnp/app/root.tsx b/examples/yarn-pnp/app/root.tsx new file mode 100644 index 00000000000..927a0f745df --- /dev/null +++ b/examples/yarn-pnp/app/root.tsx @@ -0,0 +1,32 @@ +import type { MetaFunction } from "@remix-run/node"; +import { + Links, + LiveReload, + Meta, + Outlet, + Scripts, + ScrollRestoration, +} from "@remix-run/react"; + +export const meta: MetaFunction = () => ({ + charset: "utf-8", + title: "New Remix App", + viewport: "width=device-width,initial-scale=1", +}); + +export default function App() { + return ( + + + + + + + + + + + + + ); +} diff --git a/examples/yarn-pnp/app/routes/index.tsx b/examples/yarn-pnp/app/routes/index.tsx new file mode 100644 index 00000000000..da28b224ef3 --- /dev/null +++ b/examples/yarn-pnp/app/routes/index.tsx @@ -0,0 +1,18 @@ +export default function Index() { + return ( +
+

Welcome to Remix

+

+ This example is using{" "} + + Yarn PnP + + ! +

+
+ ); +} diff --git a/examples/yarn-pnp/package.json b/examples/yarn-pnp/package.json new file mode 100644 index 00000000000..e7fb41b63e5 --- /dev/null +++ b/examples/yarn-pnp/package.json @@ -0,0 +1,32 @@ +{ + "name": "remix-example-yarn-pnp", + "private": true, + "description": "", + "license": "", + "sideEffects": false, + "scripts": { + "build": "remix build", + "dev": "remix dev", + "start": "remix-serve build" + }, + "dependencies": { + "@remix-run/node": "1.5.1", + "@remix-run/react": "1.5.1", + "@remix-run/serve": "1.5.1", + "react": "^17.0.2", + "react-dom": "^17.0.2", + "~": "link:./app" + }, + "devDependencies": { + "@remix-run/dev": "1.5.1", + "@types/react": "^17.0.24", + "@types/react-dom": "^17.0.9", + "esbuild": ">=0.10.0", + "express": "^4.17.1", + "typescript": "^4.1.2" + }, + "engines": { + "node": ">=14" + }, + "packageManager": "yarn@3.2.1" +} diff --git a/examples/yarn-pnp/public/favicon.ico b/examples/yarn-pnp/public/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..8830cf6821b354114848e6354889b8ecf6d2bc61 GIT binary patch literal 16958 zcmeI3+jCXb9mnJN2h^uNlXH@jlam{_a8F3W{T}Wih>9YJpaf7TUbu)A5fv|h7OMfR zR;q$lr&D!wv|c)`wcw1?>4QT1(&|jdsrI2h`Rn)dTW5t$8pz=s3_5L?#oBxAowe8R z_WfPfN?F+@`q$D@rvC?(W!uWieppskmQ~YG*>*L?{img@tWpnYXZslxeh#TSUS3{q z1Ju6JcfQSbQuORq69@YK(X-3c9vC2c2a2z~zw=F=50@pm0PUiCAm!bAT?2jpM`(^b zC|2&Ngngt^<>oCv#?P(AZ`5_84x#QBPulix)TpkIAUp=(KgGo4CVS~Sxt zVoR4>r5g9%bDh7hi0|v$={zr>CHd`?-l4^Ld(Z9PNz9piFY+llUw_x4ou7Vf-q%$g z)&)J4>6Ft~RZ(uV>dJD|`nxI1^x{X@Z5S<=vf;V3w_(*O-7}W<=e$=}CB9_R;)m9)d7`d_xx+nl^Bg|%ew=?uoKO8w zeQU7h;~8s!@9-k>7Cx}1SDQ7m(&miH zs8!l*wOJ!GHbdh)pD--&W3+w`9YJ=;m^FtMY=`mTq8pyV!-@L6smwp3(q?G>=_4v^ zn(ikLue7!y70#2uhqUVpb7fp!=xu2{aM^1P^pts#+feZv8d~)2sf`sjXLQCEj;pdI z%~f`JOO;*KnziMv^i_6+?mL?^wrE_&=IT9o1i!}Sd4Sx4O@w~1bi1)8(sXvYR-1?7~Zr<=SJ1Cw!i~yfi=4h6o3O~(-Sb2Ilwq%g$+V` z>(C&N1!FV5rWF&iwt8~b)=jIn4b!XbrWrZgIHTISrdHcpjjx=TwJXI7_%Ks4oFLl9 zNT;!%!P4~xH85njXdfqgnIxIFOOKW`W$fxU%{{5wZkVF^G=JB$oUNU5dQSL&ZnR1s z*ckJ$R`eCUJsWL>j6*+|2S1TL_J|Fl&kt=~XZF=+=iT0Xq1*KU-NuH%NAQff$LJp3 zU_*a;@7I0K{mqwux87~vwsp<}@P>KNDb}3U+6$rcZ114|QTMUSk+rhPA(b{$>pQTc zIQri{+U>GMzsCy0Mo4BfWXJlkk;RhfpWpAB{=Rtr*d1MNC+H3Oi5+3D$gUI&AjV-1 z=0ZOox+bGyHe=yk-yu%=+{~&46C$ut^ZN+ysx$NH}*F43)3bKkMsxGyIl#>7Yb8W zO{}&LUO8Ow{7>!bvSq?X{15&Y|4}0w2=o_^0ZzYgB+4HhZ4>s*mW&?RQ6&AY|CPcx z$*LjftNS|H)ePYnIKNg{ck*|y7EJ&Co0ho0K`!{ENPkASeKy-JWE}dF_%}j)Z5a&q zXAI2gPu6`s-@baW=*+keiE$ALIs5G6_X_6kgKK8n3jH2-H9`6bo)Qn1 zZ2x)xPt1=`9V|bE4*;j9$X20+xQCc$rEK|9OwH-O+Q*k`ZNw}K##SkY z3u}aCV%V|j@!gL5(*5fuWo>JFjeU9Qqk`$bdwH8(qZovE2tA7WUpoCE=VKm^eZ|vZ z(k<+j*mGJVah>8CkAsMD6#I$RtF;#57Wi`c_^k5?+KCmX$;Ky2*6|Q^bJ8+s%2MB}OH-g$Ev^ zO3uqfGjuN%CZiu<`aCuKCh{kK!dDZ+CcwgIeU2dsDfz+V>V3BDb~)~ zO!2l!_)m;ZepR~sL+-~sHS7;5ZB|~uUM&&5vDda2b z)CW8S6GI*oF><|ZeY5D^+Mcsri)!tmrM33qvwI4r9o@(GlW!u2R>>sB|E#%W`c*@5 z|0iA|`{6aA7D4Q?vc1{vT-#yytn07`H!QIO^1+X7?zG3%y0gPdIPUJ#s*DNAwd}m1_IMN1^T&be~+E z_z%1W^9~dl|Me9U6+3oNyuMDkF*z_;dOG(Baa*yq;TRiw{EO~O_S6>e*L(+Cdu(TM z@o%xTCV%hi&p)x3_inIF!b|W4|AF5p?y1j)cr9RG@v%QVaN8&LaorC-kJz_ExfVHB za!mtuee#Vb?dh&bwrfGHYAiX&&|v$}U*UBM;#F!N=x>x|G5s0zOa9{(`=k4v^6iK3 z8d&=O@xhDs{;v7JQ%eO;!Bt`&*MH&d zp^K#dkq;jnJz%%bsqwlaKA5?fy zS5JDbO#BgSAdi8NM zDo2SifX6^Z;vn>cBh-?~r_n9qYvP|3ihrnqq6deS-#>l#dV4mX|G%L8|EL;$U+w69 z;rTK3FW$ewUfH|R-Z;3;jvpfiDm?Fvyu9PeR>wi|E8>&j2Z@2h`U}|$>2d`BPV3pz#ViIzH8v6pP^L-p!GbLv<;(p>}_6u&E6XO5- zJ8JEvJ1)0>{iSd|kOQn#?0rTYL=KSmgMHCf$Qbm;7|8d(goD&T-~oCDuZf57iP#_Y zmxaoOSjQsm*^u+m$L9AMqwi=6bpdiAY6k3akjGN{xOZ`_J<~Puyzpi7yhhKrLmXV; z@ftONPy;Uw1F#{_fyGbk04yLE01v=i_5`RqQP+SUH0nb=O?l!J)qCSTdsbmjFJrTm zx4^ef@qt{B+TV_OHOhtR?XT}1Etm(f21;#qyyW6FpnM+S7*M1iME?9fe8d-`Q#InN z?^y{C_|8bxgUE@!o+Z72C)BrS&5D`gb-X8kq*1G7Uld-z19V}HY~mK#!o9MC-*#^+ znEsdc-|jj0+%cgBMy(cEkq4IQ1D*b;17Lyp>Utnsz%LRTfjQKL*vo(yJxwtw^)l|! z7jhIDdtLB}mpkOIG&4@F+9cYkS5r%%jz}I0R#F4oBMf-|Jmmk* zk^OEzF%}%5{a~kGYbFjV1n>HKC+a`;&-n*v_kD2DPP~n5(QE3C;30L<32GB*qV2z$ zWR1Kh=^1-q)P37WS6YWKlUSDe=eD^u_CV+P)q!3^{=$#b^auGS7m8zFfFS<>(e~)TG z&uwWhSoetoe!1^%)O}=6{SUcw-UQmw+i8lokRASPsbT=H|4D|( zk^P7>TUEFho!3qXSWn$m2{lHXw zD>eN6-;wwq9(?@f^F4L2Ny5_6!d~iiA^s~(|B*lbZir-$&%)l>%Q(36yOIAu|326K ztmBWz|MLA{Kj(H_{w2gd*nZ6a@ma(w==~EHIscEk|C=NGJa%Ruh4_+~f|%rt{I5v* zIX@F?|KJID56-ivb+PLo(9hn_CdK{irOcL15>JNQFY112^$+}JPyI{uQ~$&E*=ri; z`d^fH?4f=8vKHT4!p9O*fX(brB75Y9?e>T9=X#Fc@V#%@5^)~#zu5I(=>LQA-EGTS zecy*#6gG+8lapch#Hh%vl(+}J;Q!hC1OKoo;#h3#V%5Js)tQ)|>pTT@1ojd+F9Gey zg`B)zm`|Mo%tH31s4=<+`Pu|B3orXwNyIcNN>;fBkIj^X8P}RXhF= zXQK1u5RLN7k#_Q(KznJrALtMM13!vhfr025ar?@-%{l|uWt@NEd<$~n>RQL{ z+o;->n)+~0tt(u|o_9h!T`%M8%)w2awpV9b*xz9Pl-daUJm3y-HT%xg`^mFd6LBeL z!0~s;zEr)Bn9x)I(wx`;JVwvRcc^io2XX(Nn3vr3dgbrr@YJ?K3w18P*52^ieBCQP z=Up1V$N2~5ppJHRTeY8QfM(7Yv&RG7oWJAyv?c3g(29)P)u;_o&w|&)HGDIinXT~p z3;S|e$=&Tek9Wn!`cdY+d-w@o`37}x{(hl>ykB|%9yB$CGdIcl7Z?d&lJ%}QHck77 zJPR%C+s2w1_Dl_pxu6$Zi!`HmoD-%7OD@7%lKLL^Ixd9VlRSW*o&$^iQ2z+}hTgH) z#91TO#+jH<`w4L}XWOt(`gqM*uTUcky`O(mEyU|4dJoy6*UZJ7%*}ajuos%~>&P2j zk23f5<@GeV?(?`l=ih+D8t`d72xrUjv0wsg;%s1@*2p?TQ;n2$pV7h?_T%sL>iL@w zZ{lmc<|B7!e&o!zs6RW+u8+aDyUdG>ZS(v&rT$QVymB7sEC@VsK1dg^3F@K90-wYB zX!we79qx`(6LA>F$~{{xE8-3Wzyfe`+Lsce(?uj{k@lb97YTJt#>l*Z&LyKX@zjmu?UJC9w~;|NsB{%7G}y*uNDBxirfC EKbET!0{{R3 literal 0 HcmV?d00001 diff --git a/examples/yarn-pnp/remix.config.js b/examples/yarn-pnp/remix.config.js new file mode 100644 index 00000000000..260b82c7cb1 --- /dev/null +++ b/examples/yarn-pnp/remix.config.js @@ -0,0 +1,10 @@ +/** + * @type {import('@remix-run/dev').AppConfig} + */ +module.exports = { + ignoredRouteFiles: ["**/.*"], + // appDirectory: "app", + // assetsBuildDirectory: "public/build", + // serverBuildPath: "build/index.js", + // publicPath: "/build/", +}; diff --git a/examples/yarn-pnp/remix.env.d.ts b/examples/yarn-pnp/remix.env.d.ts new file mode 100644 index 00000000000..72e2affe311 --- /dev/null +++ b/examples/yarn-pnp/remix.env.d.ts @@ -0,0 +1,2 @@ +/// +/// diff --git a/examples/yarn-pnp/sandbox.config.json b/examples/yarn-pnp/sandbox.config.json new file mode 100644 index 00000000000..4363d87a30d --- /dev/null +++ b/examples/yarn-pnp/sandbox.config.json @@ -0,0 +1,6 @@ +{ + "hardReloadOnChange": true, + "container": { + "port": 3000 + } +} diff --git a/examples/yarn-pnp/tsconfig.json b/examples/yarn-pnp/tsconfig.json new file mode 100644 index 00000000000..53f97889224 --- /dev/null +++ b/examples/yarn-pnp/tsconfig.json @@ -0,0 +1,19 @@ +{ + "include": ["remix.env.d.ts", "**/*.ts", "**/*.tsx"], + "compilerOptions": { + "lib": ["DOM", "DOM.Iterable", "ES2019"], + "isolatedModules": true, + "esModuleInterop": true, + "jsx": "react-jsx", + "moduleResolution": "node", + "resolveJsonModule": true, + "target": "ES2019", + "strict": true, + "allowJs": true, + "forceConsistentCasingInFileNames": true, + "baseUrl": ".", + + // Remix takes care of building everything in `remix build`. + "noEmit": true + } +}