gw-my-vite-app 0.0.5

package/.env

@@ -0,0 +1 @@
+VITE_API_KEY=123456789

package/.github/workflows/build.yml

@@ -0,0 +1,24 @@
+name: Build
+
+on:
+  push:
+    branches:
+      - "**"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build
+        run: npm run build

package/.github/workflows/publish.yml

@@ -0,0 +1,30 @@
+name: Build and Publish to npm
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "18"
+          registry-url: "https://registry.npmjs.org/"
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build
+        run: npm run build
+
+      - name: Publish to npm
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/README.md

@@ -0,0 +1,81 @@
+# React + TypeScript + Vite
+
+This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+
+Currently, two official plugins are available:
+
+- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Babel](https://babeljs.io/) (or [oxc](https://oxc.rs) when used in [rolldown-vite](https://vite.dev/guide/rolldown)) for Fast Refresh
+- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
+
+## React Compiler
+
+The React Compiler is not enabled on this template because of its impact on dev & build performances. To add it, see [this documentation](https://react.dev/learn/react-compiler/installation).
+
+## Expanding the ESLint configuration
+
+If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules:
+
+```js
+export default defineConfig([
+  globalIgnores(["dist"]),
+  {
+    files: ["**/*.{ts,tsx}"],
+    extends: [
+      // Other configs...
+
+      // Remove tseslint.configs.recommended and replace with this
+      tseslint.configs.recommendedTypeChecked,
+      // Alternatively, use this for stricter rules
+      tseslint.configs.strictTypeChecked,
+      // Optionally, add this for stylistic rules
+      tseslint.configs.stylisticTypeChecked,
+
+      // Other configs...
+    ],
+    languageOptions: {
+      parserOptions: {
+        project: ["./tsconfig.node.json", "./tsconfig.app.json"],
+        tsconfigRootDir: import.meta.dirname,
+      },
+      // other options...
+    },
+  },
+]);
+```
+
+You can also install [eslint-plugin-react-x](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x) and [eslint-plugin-react-dom](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom) for React-specific lint rules:
+
+```js
+// eslint.config.js
+import reactX from "eslint-plugin-react-x";
+import reactDom from "eslint-plugin-react-dom";
+
+export default defineConfig([
+  globalIgnores(["dist"]),
+  {
+    files: ["**/*.{ts,tsx}"],
+    extends: [
+      // Other configs...
+      // Enable lint rules for React
+      reactX.configs["recommended-typescript"],
+      // Enable lint rules for React DOM
+      reactDom.configs.recommended,
+    ],
+    languageOptions: {
+      parserOptions: {
+        project: ["./tsconfig.node.json", "./tsconfig.app.json"],
+        tsconfigRootDir: import.meta.dirname,
+      },
+      // other options...
+    },
+  },
+]);
+```
+
+## Notes/Objectives
+
+1. Make a super simple web app with Typescript
+2. Set up typescript rules
+3. Purposely make a lot of typescript errors in the Footer.tsx file to make sure the typescript rules work
+4. Set up github actions to run when there is a push to a branch
+5. Github actions will then run `npm run build`, which is short for `tsc -b && vite build`. `tsc -b` runs the typescript compiler in build mode and reports any errors

package/eslint.config.js

@@ -0,0 +1,41 @@
+import js from "@eslint/js";
+import globals from "globals";
+import reactHooks from "eslint-plugin-react-hooks";
+import reactRefresh from "eslint-plugin-react-refresh";
+import tseslint from "typescript-eslint";
+import { defineConfig, globalIgnores } from "eslint/config";
+
+export default defineConfig([
+  globalIgnores(["dist"]),
+  {
+    files: ["**/*.{ts,tsx}"],
+    plugins: {
+      "@typescript-eslint": tseslint.plugin,
+    },
+    extends: [
+      js.configs.recommended,
+      tseslint.configs.recommended,
+      reactHooks.configs.flat.recommended,
+      reactRefresh.configs.vite,
+    ],
+    languageOptions: {
+      ecmaVersion: 2020,
+      globals: globals.browser,
+    },
+    rules: {
+      "@typescript-eslint/explicit-function-return-type": [
+        "error",
+        {
+          allowExpressions: false,
+          allowTypedFunctionExpressions: false,
+          allowHigherOrderFunctions: false,
+          allowDirectConstAssertionInArrowFunctions: false,
+          allowConciseArrowFunctionExpressionsStartingWithVoid: false,
+        },
+      ],
+      "@typescript-eslint/no-unused-vars": "error",
+      "@typescript-eslint/no-explicit-any": "error",
+      "@typescript-eslint/no-non-null-assertion": "error",
+    },
+  },
+]);

package/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>my-vite-app</title>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/main.tsx"></script>
+  </body>
+</html>

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "gw-my-vite-app",
+  "private": false,
+  "version": "0.0.5",
+  "type": "module",
+  "scripts": {
+    "dev": "vite",
+    "build": "tsc -b && vite build",
+    "lint": "eslint .",
+    "preview": "vite preview"
+  },
+  "dependencies": {
+    "react": "^19.2.0",
+    "react-dom": "^19.2.0",
+    "sass": "^1.97.3"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.39.1",
+    "@types/node": "^24.10.1",
+    "@types/react": "^19.2.5",
+    "@types/react-dom": "^19.2.3",
+    "@typescript-eslint/eslint-plugin": "^8.54.0",
+    "@typescript-eslint/parser": "^8.54.0",
+    "@vitejs/plugin-react": "^5.1.1",
+    "eslint": "^9.39.2",
+    "eslint-plugin-react": "^7.37.5",
+    "eslint-plugin-react-hooks": "^7.0.1",
+    "eslint-plugin-react-refresh": "^0.4.24",
+    "globals": "^16.5.0",
+    "typescript": "~5.9.3",
+    "typescript-eslint": "^8.46.4",
+    "vite": "^7.2.4"
+  }
+}

package/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;
+}

package/src/App.tsx

@@ -0,0 +1,22 @@
+import React from "react";
+import { useState } from "react";
+import "./App.css";
+import Header from "./components/Header";
+import "./styles/main.scss";
+
+function App(): React.ReactNode {
+  const [count, setCount] = useState(0);
+
+  return (
+    <>
+      <Header />
+      <div className="card">
+        <button onClick={(): void => setCount((count): number => count + 1)}>
+          count is {count}
+        </button>
+      </div>
+    </>
+  );
+}
+
+export default App;

package/src/components/Footer.tsx

@@ -0,0 +1,149 @@
+// import React from "react";
+
+// // 1. TS: unused variable
+// const unusedVar = 42;
+
+// // 2. TS: implicit `any` (no type annotation)
+// function badFunction(param) {
+//   return param + 1;
+// }
+
+// // 3. TS: no explicit return type
+// // function missingReturnType(value: string) {
+// function missingReturnType(value: string): number {
+//   return value.length;
+// }
+
+// // 4. TS: no explicit `void` for functions that don’t return
+// function logMessage(message): void {
+//   console.log(message);
+// }
+
+// // 5. TS: unused parameter
+// function handleEvent(e: React.MouseEvent) {
+//   // e is not used
+//   console.log(e);
+// }
+
+// // 6. TS: non‑nullable assertion (`!`) on possibly undefined
+// interface User {
+//   name: string;
+// }
+// const user: User | null = null;
+// const userName = user!.name;
+
+// // 7. TS: `any` usage
+// const data: any = fetch("/api");
+
+// // 8. TS: missing `@typescript-eslint/explicit-member-accessibility`
+// class BadClass {
+//   field = "oops"; // implicit public
+// }
+
+// // 9. TS: no explicit `unknown` / `never` handling
+// function riskyCast(value: unknown) {
+//   return value as string; // unsafe cast
+// }
+
+// // 10. TS: missing `@typescript-eslint/no‑implicit‑any` / implicit `any[]`
+// const numbers = []; // inferred as `any[]`
+// numbers.push("not a number");
+
+// // 11. React: missing `key` on list
+// function BadList({ items }: { items: string[] }) {
+//   return (
+//     <ul>
+//       {items.map((item) => (
+//         <li>{item}</li> // no `key`
+//       ))}
+//     </ul>
+//   );
+// }
+
+// // 12. React: unnecessary `div` wrapper (unnecessary wrapper)
+// function ExtraWrapper() {
+//   return (
+//     <div>
+//       <p>Hello</p>
+//     </div>
+//   );
+// }
+
+// // 13. React: missing `alt` on `img`
+// function MissingAlt() {
+//   return <img src="/logo.png" />; // no `alt`
+// }
+
+// // 14. React: inline style as string (invalid style prop)
+// function InlineStyleString() {
+//   return <div style="color: red">Bad style</div>;
+// }
+
+// // 15. React: no `onClick` handler on interactive element
+// function NoHandler() {
+//   return <button>Click me</button>; // no `onClick`
+// }
+
+// // 16. React: missing dependency in `useEffect`
+// import { useState, useEffect } from "react";
+// function MissingDeps() {
+//   const [count, setCount] = useState(0);
+//   const [name] = useState("Alice");
+
+//   useEffect(() => {
+//     setCount(count + 1);
+//     // missing `name` in deps
+//   }, []);
+
+//   return <div>{count}</div>;
+// }
+
+// // 17. React: direct mutation of props
+// function MutateProps({ items }: { items: string[] }) {
+//   items.push("new item"); // mutating props
+//   return <div>{items.join(", ")}</div>;
+// }
+
+// // 18. React: no explicit `React.FC` / props typing (if rule is on)
+// function UntypedProps(props) {
+//   return <div>{props.message}</div>;
+// }
+
+// // 19. React: `defaultProps` with TypeScript (deprecated pattern)
+// const ComponentWithDefaults = (props: { name?: string }) => {
+//   return <div>Hello {props.name}</div>;
+// };
+// ComponentWithDefaults.defaultProps = {
+//   name: "World",
+// };
+
+// // 20. React: invalid `key` type (using index as key)
+// function BadKey({ items }: { items: string[] }) {
+//   return (
+//     <ul>
+//       {items.map((item, index) => (
+//         <li key={index}>{item}</li> // index as key
+//       ))}
+//     </ul>
+//   );
+// }
+
+// console.log(
+//   unusedVar,
+//   missingReturnType,
+//   badFunction,
+//   logMessage,
+//   handleEvent,
+//   userName,
+//   data,
+//   riskyCast,
+//   BadList,
+//   ExtraWrapper,
+//   MissingAlt,
+//   InlineStyleString,
+//   NoHandler,
+//   MissingDeps,
+//   MutateProps,
+//   UntypedProps,
+//   BadKey
+// );

package/src/components/Header.tsx

@@ -0,0 +1,12 @@
+import React from "react";
+
+const Header = (): React.ReactNode => {
+  return (
+    <header>
+      <div>Welcome to My App</div>
+      <div>VITE_API_KEY: {import.meta.env.VITE_API_KEY}</div>
+    </header>
+  );
+};
+
+export default Header;

package/src/index.css

@@ -0,0 +1,68 @@
+:root {
+  font-family: 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;
+}
+
+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;
+  }
+}

package/src/main.tsx

@@ -0,0 +1,15 @@
+import { StrictMode } from "react";
+import { createRoot } from "react-dom/client";
+import "./index.css";
+import App from "./App.tsx";
+
+const rootElement = document.getElementById("root");
+if (rootElement) {
+  createRoot(rootElement).render(
+    <StrictMode>
+      <App />
+    </StrictMode>
+  );
+} else {
+  console.error("Root element not found");
+}

package/src/styles/main.scss

@@ -0,0 +1,3 @@
+body {
+  background-color: steelblue;
+}

package/tsconfig.app.json

@@ -0,0 +1,28 @@
+{
+  "compilerOptions": {
+    "tsBuildInfoFile": "./node_modules/.tmp/tsconfig.app.tsbuildinfo",
+    "target": "ES2022",
+    "useDefineForClassFields": true,
+    "lib": ["ES2022", "DOM", "DOM.Iterable"],
+    "module": "ESNext",
+    "types": ["vite/client"],
+    "skipLibCheck": true,
+
+    /* Bundler mode */
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "verbatimModuleSyntax": true,
+    "moduleDetection": "force",
+    "noEmit": true,
+    "jsx": "react-jsx",
+
+    /* Linting */
+    "strict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "erasableSyntaxOnly": true,
+    "noFallthroughCasesInSwitch": true,
+    "noUncheckedSideEffectImports": true
+  },
+  "include": ["src"]
+}

package/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "compilerOptions": {
+    "jsx": "react-jsx",
+    "lib": ["DOM", "ES2020"]
+  },
+  "files": [],
+  "references": [
+    { "path": "./tsconfig.app.json" },
+    { "path": "./tsconfig.node.json" }
+  ]
+}

package/tsconfig.node.json

@@ -0,0 +1,26 @@
+{
+  "compilerOptions": {
+    "tsBuildInfoFile": "./node_modules/.tmp/tsconfig.node.tsbuildinfo",
+    "target": "ES2023",
+    "lib": ["ES2023"],
+    "module": "ESNext",
+    "types": ["node"],
+    "skipLibCheck": true,
+
+    /* Bundler mode */
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "verbatimModuleSyntax": true,
+    "moduleDetection": "force",
+    "noEmit": true,
+
+    /* Linting */
+    "strict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "erasableSyntaxOnly": true,
+    "noFallthroughCasesInSwitch": true,
+    "noUncheckedSideEffectImports": true
+  },
+  "include": ["vite.config.ts"]
+}

package/vite.config.ts

@@ -0,0 +1,7 @@
+import { defineConfig } from 'vite'
+import react from '@vitejs/plugin-react'
+
+// https://vite.dev/config/
+export default defineConfig({
+  plugins: [react()],
+})