Skip to content

Commit 9e3203c

Browse files
machourmachour
authored
refactor(client-only-components): Switch to V2 + Vite (#495)
1 parent 1efacc6 commit 9e3203c

File tree

11 files changed

+151
-52
lines changed

11 files changed

+151
-52
lines changed

‎client-only-components/.eslintrc.cjs

+84
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
/**
2+
* This is intended to be a basic starting point for linting in your app.
3+
* It relies on recommended configs out of the box for simplicity, but you can
4+
* and should modify this configuration to best suit your team's needs.
5+
*/
6+
7+
/** @type {import('eslint').Linter.Config} */
8+
module.exports = {
9+
root: true,
10+
parserOptions: {
11+
ecmaVersion: "latest",
12+
sourceType: "module",
13+
ecmaFeatures: {
14+
jsx: true,
15+
},
16+
},
17+
env: {
18+
browser: true,
19+
commonjs: true,
20+
es6: true,
21+
},
22+
ignorePatterns: ["!**/.server", "!**/.client"],
23+
24+
// Base config
25+
extends: ["eslint:recommended"],
26+
27+
overrides: [
28+
// React
29+
{
30+
files: ["**/*.{js,jsx,ts,tsx}"],
31+
plugins: ["react", "jsx-a11y"],
32+
extends: [
33+
"plugin:react/recommended",
34+
"plugin:react/jsx-runtime",
35+
"plugin:react-hooks/recommended",
36+
"plugin:jsx-a11y/recommended",
37+
],
38+
settings: {
39+
react: {
40+
version: "detect",
41+
},
42+
formComponents: ["Form"],
43+
linkComponents: [
44+
{ name: "Link", linkAttribute: "to" },
45+
{ name: "NavLink", linkAttribute: "to" },
46+
],
47+
"import/resolver": {
48+
typescript: {},
49+
},
50+
},
51+
},
52+
53+
// Typescript
54+
{
55+
files: ["**/*.{ts,tsx}"],
56+
plugins: ["@typescript-eslint", "import"],
57+
parser: "@typescript-eslint/parser",
58+
settings: {
59+
"import/internal-regex": "^~/",
60+
"import/resolver": {
61+
node: {
62+
extensions: [".ts", ".tsx"],
63+
},
64+
typescript: {
65+
alwaysTryTypes: true,
66+
},
67+
},
68+
},
69+
extends: [
70+
"plugin:@typescript-eslint/recommended",
71+
"plugin:import/recommended",
72+
"plugin:import/typescript",
73+
],
74+
},
75+
76+
// Node
77+
{
78+
files: [".eslintrc.cjs"],
79+
env: {
80+
node: true,
81+
},
82+
},
83+
],
84+
};

‎client-only-components/.eslintrc.js

-4
This file was deleted.

‎client-only-components/.gitignore

-1
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,4 @@ node_modules
22

33
/.cache
44
/build
5-
/public/build
65
.env

‎client-only-components/README.md

-2
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@ Also shows how to know JS loaded and enable a button that needs JS to work.
1212

1313
Open this example on [CodeSandbox](https://codesandbox.com):
1414

15-
<!-- TODO: update this link to the path for your example: -->
16-
1715
[![Open in CodeSandbox](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/github/remix-run/examples/tree/main/client-only-components)
1816

1917
## Example

‎client-only-components/app/root.tsx

+8-11
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,29 @@
1-
import type { MetaFunction } from "@remix-run/node";
21
import {
32
Links,
4-
LiveReload,
53
Meta,
64
Outlet,
75
Scripts,
86
ScrollRestoration,
97
} from "@remix-run/react";
108

11-
export const meta: MetaFunction = () => ({
12-
charset: "utf-8",
13-
title: "New Remix App",
14-
viewport: "width=device-width,initial-scale=1",
15-
});
16-
17-
export default function App() {
9+
export function Layout({ children }: { children: React.ReactNode }) {
1810
return (
1911
<html lang="en">
2012
<head>
13+
<meta charSet="utf-8" />
14+
<meta name="viewport" content="width=device-width, initial-scale=1" />
2115
<Meta />
2216
<Links />
2317
</head>
2418
<body>
25-
<Outlet />
19+
{children}
2620
<ScrollRestoration />
2721
<Scripts />
28-
<LiveReload />
2922
</body>
3023
</html>
3124
);
3225
}
26+
27+
export default function App() {
28+
return <Outlet />;
29+
}

‎client-only-components/app/routes/_index.tsx

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
import { ClientOnly, useHydrated } from "remix-utils";
1+
import { ClientOnly } from "remix-utils/client-only";
2+
import { useHydrated } from "remix-utils/use-hydrated";
23

34
import { BrokenOnTheServer } from "~/components/broken-on-the-server.client";
45
import { ComplexComponent } from "~/components/complex-component";

‎client-only-components/package.json

+26-15
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,41 @@
11
{
2+
"name": "template",
23
"private": true,
34
"sideEffects": false,
5+
"type": "module",
46
"scripts": {
5-
"build": "remix build",
6-
"dev": "remix dev",
7-
"start": "remix-serve build",
7+
"build": "remix vite:build",
8+
"dev": "remix vite:dev",
9+
"lint": "eslint --ignore-path .gitignore --cache --cache-location ./node_modules/.cache/eslint .",
10+
"start": "remix-serve ./build/server/index.js",
811
"typecheck": "tsc"
912
},
1013
"dependencies": {
11-
"@remix-run/node": "^1.19.3",
12-
"@remix-run/react": "^1.19.3",
13-
"@remix-run/serve": "^1.19.3",
14-
"isbot": "^3.6.5",
14+
"@remix-run/node": "^2.9.2",
15+
"@remix-run/react": "^2.9.2",
16+
"@remix-run/serve": "^2.9.2",
17+
"isbot": "^4.1.0",
1518
"react": "^18.2.0",
1619
"react-dom": "^18.2.0",
17-
"remix-utils": "^6.0.0"
20+
"remix-utils": "^7.6.0"
1821
},
1922
"devDependencies": {
20-
"@remix-run/dev": "^1.19.3",
21-
"@remix-run/eslint-config": "^1.19.3",
22-
"@types/react": "^18.0.25",
23-
"@types/react-dom": "^18.0.8",
24-
"eslint": "^8.27.0",
25-
"typescript": "^4.8.4"
23+
"@remix-run/dev": "^2.9.2",
24+
"@types/react": "^18.2.20",
25+
"@types/react-dom": "^18.2.7",
26+
"@typescript-eslint/eslint-plugin": "^6.7.4",
27+
"@typescript-eslint/parser": "^6.7.4",
28+
"eslint": "^8.38.0",
29+
"eslint-import-resolver-typescript": "^3.6.1",
30+
"eslint-plugin-import": "^2.28.1",
31+
"eslint-plugin-jsx-a11y": "^6.7.1",
32+
"eslint-plugin-react": "^7.33.2",
33+
"eslint-plugin-react-hooks": "^4.6.0",
34+
"typescript": "^5.1.6",
35+
"vite": "^5.1.0",
36+
"vite-tsconfig-paths": "^4.2.1"
2637
},
2738
"engines": {
28-
"node": ">=14.0.0"
39+
"node": ">=20.0.0"
2940
}
3041
}

‎client-only-components/remix.config.js

-11
This file was deleted.

‎client-only-components/remix.env.d.ts

-2
This file was deleted.

‎client-only-components/tsconfig.json

+15-5
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,32 @@
11
{
2-
"include": ["remix.env.d.ts", "**/*.ts", "**/*.tsx"],
2+
"include": [
3+
"**/*.ts",
4+
"**/*.tsx",
5+
"**/.server/**/*.ts",
6+
"**/.server/**/*.tsx",
7+
"**/.client/**/*.ts",
8+
"**/.client/**/*.tsx"
9+
],
310
"compilerOptions": {
4-
"lib": ["DOM", "DOM.Iterable", "ES2019"],
11+
"lib": ["DOM", "DOM.Iterable", "ES2022"],
12+
"types": ["@remix-run/node", "vite/client"],
513
"isolatedModules": true,
614
"esModuleInterop": true,
715
"jsx": "react-jsx",
8-
"moduleResolution": "node",
16+
"module": "ESNext",
17+
"moduleResolution": "Bundler",
918
"resolveJsonModule": true,
10-
"target": "ES2019",
19+
"target": "ES2022",
1120
"strict": true,
1221
"allowJs": true,
22+
"skipLibCheck": true,
1323
"forceConsistentCasingInFileNames": true,
1424
"baseUrl": ".",
1525
"paths": {
1626
"~/*": ["./app/*"]
1727
},
1828

19-
// Remix takes care of building everything in `remix build`.
29+
// Vite takes care of building everything, not tsc.
2030
"noEmit": true
2131
}
2232
}

‎client-only-components/vite.config.ts

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
import { vitePlugin as remix } from "@remix-run/dev";
2+
import { defineConfig } from "vite";
3+
import tsconfigPaths from "vite-tsconfig-paths";
4+
5+
export default defineConfig({
6+
plugins: [
7+
remix({
8+
future: {
9+
v3_fetcherPersist: true,
10+
v3_relativeSplatPath: true,
11+
v3_throwAbortReason: true,
12+
},
13+
}),
14+
tsconfigPaths(),
15+
],
16+
});

0 commit comments

Comments
 (0)