Cleaned up code (#32)

Author: spietras

.github/workflows/example.yaml

@@ -74,6 +74,8 @@ jobs:
           'reponame=react-example'
           --data
           'description=React app example ⚛️'
+          --data
+          'paths=false'
       # Create archive to retain file permissions
       - name: Create archive
         run: >

copier.yaml

@@ -32,6 +32,16 @@ port:
   help: The port on which the app will listen
   default: 5173
 
+paths:
+  type: bool
+  help: Whether you can use paths in the URL
+  default: true
+
+keyprefix:
+  type: str
+  help: The prefix for various keys used in the app (e.g. for storage)
+  default: "{{ appname | lower | replace('_', '-') }}"
+
 pages:
   type: str
   help: What you want to host on GitHub Pages

src/.envrc.jinja

@@ -1,7 +1,7 @@
 #!/usr/bin/env bash
 
 # reload when these files change
-watch_file flake.lock ./*.nix package.json package-lock.json Taskfile.dist.yaml {taskfile,Taskfile}.{yaml,yml}
+watch_file flake.lock ./*.nix
 
 # activate the default development shell in the current shell
 # --accept-flake-config will accept the nix configuration from the flake without prompting

src/.eslintrc.cjs

@@ -1,11 +1,11 @@
 module.exports = {
   env: {
-    // Set ES2022 environment
-    es2022: true,
-
     // Support browser globals
     browser: true,
 
+    // Set ES2022 environment
+    es2022: true,
+
     // Support node globals
     node: true,
   },
@@ -41,6 +41,12 @@ module.exports = {
   root: true,
 
   rules: {
+    // Allow anonymous default exports
+    "import/no-anonymous-default-export": "off",
+
+    // Allow empty block statements
+    "no-empty": "off",
+
     // Allow empty destructuring patterns
     "no-empty-pattern": "off",
 

src/Taskfile.dist.yaml.jinja

@@ -199,8 +199,8 @@ tasks:
     desc: Build outputs
     internal: true
     sources:
-      - src/**/*
       - public/**/*
+      - src/**/*
       - flake.lock
       - "*.nix"
       - index.html

src/src/Router.tsx renamed to src/src/Router.tsx.jinja

@@ -1,7 +1,7 @@
-import { RouterProvider, createHashRouter } from "react-router-dom";
+import { RouterProvider, {{ 'createBrowserRouter' if pages else 'createHashRouter' }} } from "react-router-dom";
 import { ErrorPage, IndexPage, NotFoundPage, Root } from "./pages";
 
-const router = createHashRouter(
+const router = {{ 'createBrowserRouter' if pages else 'createHashRouter' }}(
   [
     {
       path: "/",

src/src/config/constants.ts

@@ -0,0 +1,3 @@
+export const colorSchemeStorageKey = "{{ keyprefix }}-color-scheme";
+export const defaultColorScheme = "auto";
+export const stateStorageKey = "{{ keyprefix }}-state";

src/src/config/constants.ts.jinja

@@ -1 +1 @@
-export * from "./Theme";
+export * from "./ThemeProvider";

src/src/contexts/Theme/ThemeProvider.tsx renamed to src/src/contexts/ThemeProvider/ThemeProvider.tsx

@@ -1 +1 @@
-export * from "./Toasts";
+export * from "./useToasts";

src/src/contexts/Theme/ThemeProvider.types.ts renamed to src/src/contexts/ThemeProvider/ThemeProvider.types.ts

@@ -1,9 +1,9 @@
-import React from "react";
-import ReactDOM from "react-dom/client";
-import { App } from "./App.tsx";
+import { StrictMode } from "react";
+import { createRoot } from "react-dom/client";
+import { App } from "./App";
 
-ReactDOM.createRoot(document.getElementById("root") as HTMLElement).render(
-  <React.StrictMode>
+createRoot(document.getElementById("root") as HTMLElement).render(
+  <StrictMode>
     <App />
-  </React.StrictMode>,
+  </StrictMode>,
 );

src/src/contexts/Theme/index.ts renamed to src/src/contexts/ThemeProvider/index.ts

@@ -1,2 +1,2 @@
 export * from "./store";
-export * from "./store.types";
+export * from "./types";

src/src/contexts/index.ts

@@ -3,7 +3,7 @@ import { StateCreator, create } from "zustand";
 import { PersistOptions, persist } from "zustand/middleware";
 import { immer } from "zustand/middleware/immer";
 import { stateStorageKey } from "../config/constants";
-import { Store } from "./store.types";
+import { Store } from "./types";
 
 type Initializer = StateCreator<Store, [["zustand/immer", never]]>;
 

src/src/hooks/index.ts

@@ -7,11 +7,12 @@
     "esModuleInterop": true,
     "incremental": true,
     "isolatedModules": true,
-    "jsx": "react-jsx",
+    "jsx": "preserve",
     "lib": ["DOM", "DOM.Iterable", "ESNext"],
     "module": "esnext",
     "moduleResolution": "bundler",
     "noEmit": true,
+    "noUncheckedIndexedAccess": true,
     "noUnusedLocals": true,
     "preserveWatchOutput": true,
     "removeComments": true,

src/src/hooks/Toasts/index.ts renamed to src/src/hooks/useToasts/index.ts

@@ -1,17 +1,20 @@
 import react from "@vitejs/plugin-react";
 import { defineConfig } from "vite";
 
+const host = process.env.{{ envprefix }}__SERVER__HOST || "0.0.0.0";
+const port =
+  process.env.{{ envprefix }}__SERVER__PORT === undefined
+    ? {{ port }}
+    : parseInt(process.env.{{ envprefix }}__SERVER__PORT, 10);
+
 // https://vitejs.dev/config/
 export default defineConfig({
   build: {
     outDir: "build/",
   },
   plugins: [react()],
   server: {
-    host: process.env.{{ envprefix }}__SERVER__HOST || "0.0.0.0",
-    port:
-      process.env.{{ envprefix }}__SERVER__PORT === undefined
-        ? {{ port }}
-        : parseInt(process.env.{{ envprefix }}__SERVER__PORT, 10),
+    host: host,
+    port: port,
   },
 });

src/src/hooks/Toasts/useToasts.tsx renamed to src/src/hooks/useToasts/useToasts.tsx

@@ -19,6 +19,8 @@ def data() -> dict[str, str]:
         "repourl": "https://github.com/foo/app-foo",
         "envprefix": "FOO",
         "port": "5173",
+        "paths": "true",
+        "keyprefix": "foo",
         "pages": "docs",
         "pagesurl": "https://foo.github.io/app-foo",
         "releases": "false",

src/src/hooks/Toasts/useToasts.types.ts renamed to src/src/hooks/useToasts/useToasts.types.ts

@@ -19,6 +19,8 @@ def data() -> dict[str, str]:
         "repourl": "https://github.com/foo/app-foo",
         "envprefix": "FOO",
         "port": "5173",
+        "paths": "true",
+        "keyprefix": "foo",
         "pages": "app",
         "pagesurl": "https://foo.github.io/app-foo",
         "releases": "true",