docs(examples): add Vite + SWC example (#1684)

lingui · May 31, 2023 · f5ada23 · f5ada23 · vercel · May 31, 2023
1 parent c54245f
commit f5ada23
Show file tree

Hide file tree

Showing 21 changed files with 3,589 additions and 0 deletions.
diff --git a/examples/vite-project-react-swc/.gitignore b/examples/vite-project-react-swc/.gitignore
@@ -0,0 +1,33 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+
+
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions
diff --git a/examples/vite-project-react-swc/README.md b/examples/vite-project-react-swc/README.md
@@ -0,0 +1,45 @@
+## Example project using Vite + SWC Compiler with LinguiJS Plugin
+
+## SWC Compatibility
+SWC Plugin support is still experimental. Semver backwards compatibility between different `@swc/core` versions is not guaranteed.
+
+Therefore, you need to select an appropriate version of the Lingui plugin to match compatible `@swc/core` version.
+
+For more information on compatibility, please refer to the [Compatibility section](https://github.com/lingui/swc-plugin#compatibility).
+
+**❗️Note**
+
+The version of `@swc/core` is specified within the `@vitejs/plugin-react-swc` package.
+
+To ensure that the resolved version of `@swc/core` is one of the supported versions, this example utilizes the `resolutions` field in the `package.json` file, which is supported by Yarn:
+
+```json
+"resolutions": {
+  "@swc/core": "1.3.56"
+},
+```
+
+## Getting Started
+
+First, run the development server:
+
+```bash
+npm run dev
+# or
+yarn dev
+# or
+pnpm dev
+```
+
+Open [http://localhost:5173](http://localhost:5173) with your browser to see the result.
+
+## LinguiJS Related Commands
+
+Extract messages from sourcecode:
+```bash
+npm run lingui:extract
+# or
+yarn lingui:extract
+# or
+pnpm lingui:extract
+```
diff --git a/examples/vite-project-react-swc/index.html b/examples/vite-project-react-swc/index.html
@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" type="image/svg+xml" href="/vite.svg" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Vite + React + TS</title>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/main.tsx"></script>
+  </body>
+</html>
diff --git a/examples/vite-project-react-swc/lingui.config.ts b/examples/vite-project-react-swc/lingui.config.ts
@@ -0,0 +1,13 @@
+import type { LinguiConfig } from "@lingui/conf"
+
+const config: LinguiConfig = {
+  locales: ["en", "pl"],
+  catalogs: [
+    {
+      path: "src/locales/{locale}",
+      include: ["src"],
+    },
+  ],
+}
+
+export default config
diff --git a/examples/vite-project-react-swc/package.json b/examples/vite-project-react-swc/package.json
@@ -0,0 +1,31 @@
+{
+  "name": "vite-project-react-swc",
+  "private": true,
+  "version": "0.0.0",
+  "type": "module",
+  "scripts": {
+    "dev": "vite",
+    "build": "tsc && vite build",
+    "lingui:extract": "lingui extract",
+    "preview": "vite preview"
+  },
+  "resolutions": {
+    "@swc/core": "1.3.56"
+  },
+  "dependencies": {
+    "@lingui/macro": "^4.2.0",
+    "@lingui/react": "^4.2.0",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0"
+  },
+  "devDependencies": {
+    "@lingui/cli": "^4.2.0",
+    "@lingui/swc-plugin": "4.0.0",
+    "@lingui/vite-plugin": "^4.2.0",
+    "@types/react": "^18.0.28",
+    "@types/react-dom": "^18.0.11",
+    "@vitejs/plugin-react-swc": "^3.0.0",
+    "typescript": "^4.9.3",
+    "vite": "4.2.0"
+  }
+}
diff --git a/examples/vite-project-react-swc/public/vite.svg b/examples/vite-project-react-swc/public/vite.svg
diff --git a/examples/vite-project-react-swc/src/App.css b/examples/vite-project-react-swc/src/App.css
@@ -0,0 +1,42 @@
+#root {
+  max-width: 1280px;
+  margin: 0 auto;
+  padding: 2rem;
+  text-align: center;
+}
+
+.logo {
+  height: 6em;
+  padding: 1.5em;
+  will-change: filter;
+  transition: filter 300ms;
+}
+.logo:hover {
+  filter: drop-shadow(0 0 2em #646cffaa);
+}
+.logo.react:hover {
+  filter: drop-shadow(0 0 2em #61dafbaa);
+}
+
+@keyframes logo-spin {
+  from {
+    transform: rotate(0deg);
+  }
+  to {
+    transform: rotate(360deg);
+  }
+}
+
+@media (prefers-reduced-motion: no-preference) {
+  a:nth-of-type(2) .logo {
+    animation: logo-spin infinite 20s linear;
+  }
+}
+
+.card {
+  padding: 2em;
+}
+
+.read-the-docs {
+  color: #888;
+}
diff --git a/examples/vite-project-react-swc/src/App.tsx b/examples/vite-project-react-swc/src/App.tsx
@@ -0,0 +1,58 @@
+import { useEffect, useState } from "react"
+import reactLogo from "./assets/react.svg"
+import linguiLogo from "./assets/lingui-logo.svg"
+import viteLogo from "/vite.svg"
+import "./App.css"
+import { Plural, Trans } from "@lingui/macro"
+import { I18nProvider } from "@lingui/react"
+import { i18n } from "@lingui/core"
+import { loadCatalog } from "./i18n"
+
+function App() {
+  const [count, setCount] = useState(0)
+
+  useEffect(() => {}, [])
+
+  return (
+    <I18nProvider i18n={i18n}>
+      <div className="App">
+        <div>
+          <a href="https://vitejs.dev" target="_blank">
+            <img src={viteLogo} className="logo" alt="Vite logo" />
+          </a>
+          <a href="https://reactjs.org" target="_blank">
+            <img src={reactLogo} className="logo react" alt="React logo" />
+          </a>
+          <a href="https://lingui.dev" target="_blank">
+            <img src={linguiLogo} className="logo react" alt="Lingui logo" />
+          </a>
+        </div>
+        <h1>Vite + React + Lingui</h1>
+        <div className="card">
+          <button onClick={() => setCount((count) => count + 1)}>
+            <Plural value={count} one="# month" other="# months" />
+          </button>
+          <p>
+            <Trans>
+              Edit <code>src/App.tsx</code> and save to test HMR
+            </Trans>
+          </p>
+          <p>
+            <button
+              style={{ marginRight: "20px" }}
+              onClick={() => loadCatalog("pl")}
+            >
+              Polish
+            </button>
+            <button onClick={() => loadCatalog("en")}>English</button>
+          </p>
+        </div>
+        <p className="read-the-docs">
+          <Trans>Click on the Vite and React logos to learn more</Trans>
+        </p>
+      </div>
+    </I18nProvider>
+  )
+}
+
+export default App
diff --git a/examples/vite-project-react-swc/src/assets/lingui-logo.svg b/examples/vite-project-react-swc/src/assets/lingui-logo.svg
diff --git a/examples/vite-project-react-swc/src/assets/react.svg b/examples/vite-project-react-swc/src/assets/react.svg
diff --git a/examples/vite-project-react-swc/src/i18n.ts b/examples/vite-project-react-swc/src/i18n.ts
@@ -0,0 +1,11 @@
+import { i18n } from "@lingui/core"
+
+/**
+ * Load messages for requested locale and activate it.
+ * This function isn't part of the LinguiJS library because there are
+ * many ways how to load messages — from REST API, from file, from cache, etc.
+ */
+export async function loadCatalog(locale: string) {
+  const { messages } = await import(`./locales/${locale}.po`)
+  i18n.loadAndActivate({ locale, messages })
+}
diff --git a/examples/vite-project-react-swc/src/index.css b/examples/vite-project-react-swc/src/index.css
@@ -0,0 +1,69 @@
+:root {
+  font-family: Inter, system-ui, Avenir, Helvetica, Arial, sans-serif;
+  line-height: 1.5;
+  font-weight: 400;
+
+  color-scheme: light dark;
+  color: rgba(255, 255, 255, 0.87);
+  background-color: #242424;
+
+  font-synthesis: none;
+  text-rendering: optimizeLegibility;
+  -webkit-font-smoothing: antialiased;
+  -moz-osx-font-smoothing: grayscale;
+  -webkit-text-size-adjust: 100%;
+}
+
+a {
+  font-weight: 500;
+  color: #646cff;
+  text-decoration: inherit;
+}
+a:hover {
+  color: #535bf2;
+}
+
+body {
+  margin: 0;
+  display: flex;
+  place-items: center;
+  min-width: 320px;
+  min-height: 100vh;
+}
+
+h1 {
+  font-size: 3.2em;
+  line-height: 1.1;
+}
+
+button {
+  border-radius: 8px;
+  border: 1px solid transparent;
+  padding: 0.6em 1.2em;
+  font-size: 1em;
+  font-weight: 500;
+  font-family: inherit;
+  background-color: #1a1a1a;
+  cursor: pointer;
+  transition: border-color 0.25s;
+}
+button:hover {
+  border-color: #646cff;
+}
+button:focus,
+button:focus-visible {
+  outline: 4px auto -webkit-focus-ring-color;
+}
+
+@media (prefers-color-scheme: light) {
+  :root {
+    color: #213547;
+    background-color: #ffffff;
+  }
+  a:hover {
+    color: #747bff;
+  }
+  button {
+    background-color: #f9f9f9;
+  }
+}
diff --git a/examples/vite-project-react-swc/src/locales/en.po b/examples/vite-project-react-swc/src/locales/en.po
@@ -0,0 +1,34 @@
+msgid ""
+msgstr ""
+"POT-Creation-Date: 2023-03-23 12:19+0100\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=utf-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"X-Generator: @lingui/cli\n"
+"Language: en\n"
+"Project-Id-Version: \n"
+"Report-Msgid-Bugs-To: \n"
+"PO-Revision-Date: \n"
+"Last-Translator: \n"
+"Language-Team: \n"
+"Plural-Forms: \n"
+
+#: src/App.tsx:27
+#~ msgid "{count, plural, one {# message} other {# messages}}"
+#~ msgstr ""
+
+#: src/App.tsx:35
+msgid "{count, plural, one {# month} other {# months}}"
+msgstr ""
+
+#: src/App.tsx:27
+#~ msgid "{count, plural, other {count is #}}"
+#~ msgstr ""
+
+#: src/App.tsx:53
+msgid "Click on the Vite and React logos to learn more"
+msgstr ""
+
+#: src/App.tsx:38
+msgid "Edit <0>src/App.tsx</0> and save to test HMR"
+msgstr ""