npm - march-hare - Versions diffs - 0.13.0 → 0.13.1 - Mend

march-hare 0.13.0 → 0.13.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (129) hide show

package/dist/cli/templates/init/new/eslint.config.js.ejs.t ADDED Viewed

@@ -0,0 +1,88 @@
+---
+to: eslint.config.js
+---
+import js from "@eslint/js";
+import globals from "globals";
+import tseslint from "typescript-eslint";
+import pluginReact from "eslint-plugin-react";
+import pluginImport from "eslint-plugin-import";
+import pluginBoundaries from "eslint-plugin-boundaries";
+import { defineConfig } from "eslint/config";
+export default defineConfig([
+  {
+    files: ["**/*.{js,mjs,cjs,ts,mts,cts,jsx,tsx}"],
+    plugins: { js },
+    extends: ["js/recommended"],
+  },
+  {
+    files: ["**/*.{js,mjs,cjs,ts,mts,cts,jsx,tsx}"],
+    languageOptions: { globals: globals.browser },
+  },
+  tseslint.configs.recommended,
+  pluginReact.configs.flat.recommended,
+  {
+    plugins: { import: pluginImport },
+    settings: {
+      react: { version: "detect" },
+    },
+    rules: {
+      "react/react-in-jsx-scope": "off",
+      "@typescript-eslint/consistent-type-definitions": ["error", "type"],
+      "@typescript-eslint/no-non-null-assertion": "error",
+      "@typescript-eslint/no-namespace": "off",
+      "@typescript-eslint/no-unused-vars": [
+        "error",
+        { argsIgnorePattern: "^_", varsIgnorePattern: "^_" },
+      ],
+      "import/no-default-export": "error",
+    },
+  },
+  {
+    files: ["src/**/*.{ts,tsx,d.ts}"],
+    plugins: { boundaries: pluginBoundaries },
+    settings: {
+      "import/resolver": {
+        typescript: { project: "./tsconfig.json" },
+        node: true,
+      },
+      "boundaries/include": ["src/**/*"],
+      "boundaries/elements": [
+        { type: "app", pattern: "src/app", mode: "folder" },
+        {
+          type: "features",
+          pattern: "src/features/*",
+          mode: "folder",
+          capture: ["slice"],
+        },
+        { type: "shared", pattern: "src/shared", mode: "folder" },
+      ],
+    },
+    rules: {
+      "import/no-default-export": "off",
+      "boundaries/dependencies": [
+        "error",
+        {
+          default: "disallow",
+          message:
+            "${file.type} cannot import ${dependency.type} — layering is top-down (app → features → shared).",
+          rules: [
+            { from: { type: "app" }, allow: { to: { type: ["app", "features", "shared"] } } },
+            { from: { type: "features" }, allow: { to: { type: "shared" } } },
+            { from: { type: "shared" }, allow: { to: { type: "shared" } } },
+          ],
+        },
+      ],
+    },
+  },
+  {
+    files: ["**/*.test.{ts,tsx}", "**/*.integration.{ts,tsx}", "tests/**/*.{ts,tsx}"],
+    rules: {
+      "@typescript-eslint/no-floating-promises": "off",
+    },
+  },
+  {
+    files: ["vite.config.ts", "vitest.config.ts", "playwright.config.ts", "eslint.config.js"],
+    rules: { "import/no-default-export": "off" },
+  },
+]);

package/dist/cli/templates/init/new/gitignore.ejs.t ADDED Viewed

@@ -0,0 +1,9 @@
+---
+to: .gitignore
+---
+node_modules/
+dist/
+test-results/
+playwright-report/
+.DS_Store
+*.log

package/dist/cli/templates/init/new/index.html.ejs.t ADDED Viewed

@@ -0,0 +1,18 @@
+---
+to: index.html
+---
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title><%= title(name) %></title>
+    <style>
+      *, *::before, *::after { box-sizing: border-box; }
+      html, body { margin: 0; padding: 0; width: 100%; height: 100%; background: #f5f5f5; }
+    </style>
+  </head>
+  <body>
+    <script type="module" src="/src/index.tsx"></script>
+  </body>
+</html>

package/dist/cli/templates/init/new/package.json.ejs.t ADDED Viewed

@@ -0,0 +1,54 @@
+---
+to: package.json
+---
+{
+  "name": "<%= name %>",
+  "version": "0.1.0",
+  "description": "<%= description %>",
+  "type": "module",
+  "private": true,
+  "scripts": {
+    "dev": "vite",
+    "build": "vite build",
+    "preview": "vite preview",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:e2e": "playwright test",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint src/",
+    "fmt": "prettier --write .",
+    "checks": "npm run fmt && npm run lint && npm run typecheck && npm run test"
+  },
+  "dependencies": {
+    "@emotion/css": "^11.13.5",
+    "@mobily/ts-belt": "^3.0.0",
+    "antd": "^6.3.0",
+    "immer": "^10.0.0",
+    "ky": "^2.0.2",
+    "march-hare": "^0.13.0",
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.39.3",
+    "@playwright/test": "^1.58.2",
+    "@testing-library/dom": "^10.4.1",
+    "@testing-library/jest-dom": "^6.9.1",
+    "@testing-library/react": "^16.3.2",
+    "@types/react": "^19.2.14",
+    "@types/react-dom": "^19.2.3",
+    "@vitejs/plugin-react": "^5.1.4",
+    "eslint": "^9.39.3",
+    "eslint-import-resolver-typescript": "^4.4.5",
+    "eslint-plugin-boundaries": "^6.0.2",
+    "eslint-plugin-import": "^2.32.0",
+    "eslint-plugin-react": "^7.37.5",
+    "globals": "^17.3.0",
+    "happy-dom": "^20.6.1",
+    "prettier": "^3.8.1",
+    "typescript": "^6.0.3",
+    "typescript-eslint": "^8.55.0",
+    "vite": "^7.3.1",
+    "vitest": "^4.0.18"
+  }
+}

package/dist/cli/templates/init/new/playwright.config.ts.ejs.t ADDED Viewed

@@ -0,0 +1,17 @@
+---
+to: playwright.config.ts
+---
+import { defineConfig } from "@playwright/test";
+export default defineConfig({
+  testDir: "./tests",
+  testMatch: "*.e2e.ts",
+  use: {
+    baseURL: "http://localhost:5173",
+  },
+  webServer: {
+    command: "vite dev",
+    port: 5173,
+    reuseExistingServer: !process.env.CI,
+  },
+});

package/dist/cli/templates/init/new/prettierrc.ejs.t ADDED Viewed

@@ -0,0 +1,8 @@
+---
+to: .prettierrc
+---
+{
+  "tabWidth": 2,
+  "printWidth": 80,
+  "singleQuote": false
+}

package/dist/cli/templates/init/new/src.app.index.tsx.ejs.t ADDED Viewed

@@ -0,0 +1,14 @@
+---
+to: src/app/index.tsx
+---
+import * as React from "react";
+import { app } from "./utils.ts";
+import { HomePage } from "./pages/home/index.tsx";
+export function Root(): React.ReactElement {
+  return (
+    <app.Boundary>
+      <HomePage />
+    </app.Boundary>
+  );
+}

package/dist/cli/templates/init/new/src.app.pages.home.actions.ts.ejs.t ADDED Viewed

@@ -0,0 +1,16 @@
+---
+to: src/app/pages/home/actions.ts
+---
+import { app } from "../../utils.ts";
+import { Actions, type Model } from "./types.ts";
+export function useActions() {
+  const context = app.useContext<Model, typeof Actions>();
+  const actions = context.useActions({ greeting: null });
+  actions.useAction(Actions.Broadcast.Greeted, (context, message) => {
+    context.actions.produce(({ model }) => void (model.greeting = message));
+  });
+  return actions;
+}

package/dist/cli/templates/init/new/src.app.pages.home.index.tsx.ejs.t ADDED Viewed

@@ -0,0 +1,30 @@
+---
+to: src/app/pages/home/index.tsx
+---
+import * as React from "react";
+import { GreetButton } from "@features/greet/index.tsx";
+import { useActions } from "./actions.ts";
+import * as styles from "./styles.ts";
+export function HomePage(): React.ReactElement {
+  const [model] = useActions();
+  return (
+    <main className={styles.layout}>
+      <header className={styles.header}>
+        <h1 className={styles.title}><%= title(name) %></h1>
+        <p className={styles.tagline}>
+          Click the button below to dispatch your first March Hare action.
+        </p>
+      </header>
+      <GreetButton />
+      {model.greeting ? (
+        <p className={styles.greeting}>{model.greeting}</p>
+      ) : (
+        <p className={styles.empty}>No greeting yet — press the button.</p>
+      )}
+    </main>
+  );
+}

package/dist/cli/templates/init/new/src.app.pages.home.integration.tsx.ejs.t ADDED Viewed

@@ -0,0 +1,28 @@
+---
+to: src/app/pages/home/index.integration.tsx
+---
+import { describe, expect, it } from "vitest";
+import { render, screen, act, fireEvent, waitFor } from "@testing-library/react";
+import { Root } from "@app/index.tsx";
+describe("HomePage", () => {
+  it("renders the heading", () => {
+    render(<Root />);
+    expect(screen.getByRole("heading", { name: "<%= title(name) %>" })).toBeInTheDocument();
+  });
+  it("shows the empty state until the button is clicked", () => {
+    render(<Root />);
+    expect(screen.getByText(/No greeting yet/)).toBeInTheDocument();
+  });
+  it("broadcasts a greeting on click", async () => {
+    render(<Root />);
+    await act(async () => {
+      fireEvent.click(screen.getByRole("button", { name: /Say hello/ }));
+    });
+    await waitFor(() => {
+      expect(screen.queryByText(/No greeting yet/)).not.toBeInTheDocument();
+    });
+  });
+});

package/dist/cli/templates/init/new/src.app.pages.home.styles.ts.ejs.t ADDED Viewed

@@ -0,0 +1,45 @@
+---
+to: src/app/pages/home/styles.ts
+---
+import { css } from "@emotion/css";
+import { colour, font, spacing } from "@shared/theme/index.ts";
+export const layout = css`
+  min-height: 100vh;
+  padding: ${spacing.xxl} ${spacing.l};
+  display: flex;
+  flex-direction: column;
+  align-items: center;
+  gap: ${spacing.xl};
+  font-family: ${font.family};
+`;
+export const header = css`
+  display: flex;
+  flex-direction: column;
+  align-items: center;
+  gap: ${spacing.xs};
+`;
+export const title = css`
+  margin: 0;
+  font-size: ${font.size.xxl};
+  font-weight: ${font.weight.bold};
+  color: ${colour.text.primary};
+`;
+export const tagline = css`
+  margin: 0;
+  color: ${colour.text.secondary};
+  font-size: ${font.size.m};
+`;
+export const greeting = css`
+  font-size: ${font.size.l};
+  color: ${colour.text.primary};
+`;
+export const empty = css`
+  color: ${colour.text.muted};
+  font-style: italic;
+`;

package/dist/cli/templates/init/new/src.app.pages.home.types.ts.ejs.t ADDED Viewed

@@ -0,0 +1,12 @@
+---
+to: src/app/pages/home/types.ts
+---
+import { Broadcast } from "@shared/types/index.ts";
+export type Model = {
+  greeting: string | null;
+};
+export class Actions {
+  static Broadcast = Broadcast;
+}

package/dist/cli/templates/init/new/src.app.utils.ts.ejs.t ADDED Viewed

@@ -0,0 +1,9 @@
+---
+to: src/app/utils.ts
+---
+import { App } from "march-hare";
+import { Env } from "@shared/types/index.ts";
+export const app = App<Env.<%= env %>>({
+  env: { apiBase: "<%= apiBase %>" },
+});

package/dist/cli/templates/init/new/src.features.greet.actions.ts.ejs.t ADDED Viewed

@@ -0,0 +1,20 @@
+---
+to: src/features/greet/actions.ts
+---
+import { Actions, type Model } from "./types.ts";
+import { scope } from "./utils.ts";
+export function useActions() {
+  const context = scope.useContext<Model, typeof Actions>();
+  const actions = context.useActions({ count: 0 });
+  actions.useAction(Actions.Click, async (context) => {
+    context.actions.produce(({ model }) => void (model.count += 1));
+    await context.actions.dispatch(
+      Actions.Broadcast.Greeted,
+      `Hello from <%= title(name) %> #${context.model.count + 1}`,
+    );
+  });
+  return actions;
+}

package/dist/cli/templates/init/new/src.features.greet.index.test.tsx.ejs.t ADDED Viewed

@@ -0,0 +1,21 @@
+---
+to: src/features/greet/index.test.tsx
+---
+import { describe, expect, it } from "vitest";
+import { render, screen } from "@testing-library/react";
+import { App } from "march-hare";
+import { GreetButton } from "./index.tsx";
+import { type Envs } from "@shared/types/index.ts";
+const app = App<Envs>({ env: { apiBase: "https://api.example.test" } });
+describe("GreetButton", () => {
+  it("renders the Say hello button", () => {
+    render(
+      <app.Boundary>
+        <GreetButton />
+      </app.Boundary>,
+    );
+    expect(screen.getByRole("button", { name: "Say hello" })).toBeInTheDocument();
+  });
+});

package/dist/cli/templates/init/new/src.features.greet.index.tsx.ejs.t ADDED Viewed

@@ -0,0 +1,24 @@
+---
+to: src/features/greet/index.tsx
+---
+import * as React from "react";
+import { Button } from "@shared/components/button/index.tsx";
+import { useActions } from "./actions.ts";
+import { scope } from "./utils.ts";
+import { Actions } from "./types.ts";
+export function GreetButton(): React.ReactElement {
+  const [, actions] = useActions();
+  return (
+    <scope.Boundary>
+      <Button
+        type="primary"
+        size="large"
+        onClick={() => actions.dispatch(Actions.Click)}
+      >
+        Say hello
+      </Button>
+    </scope.Boundary>
+  );
+}

package/dist/cli/templates/init/new/src.features.greet.types.ts.ejs.t ADDED Viewed

@@ -0,0 +1,18 @@
+---
+to: src/features/greet/types.ts
+---
+import { Action, Distribution } from "march-hare";
+import { Broadcast } from "@shared/types/index.ts";
+export type Model = {
+  count: number;
+};
+export class Actions {
+  static Click = Action("Greet.Click");
+  static Broadcast = Broadcast;
+}
+export class Multicast {
+  static Pulse = Action<number>("Greet.Pulse", Distribution.Multicast);
+}

package/dist/cli/templates/init/new/src.features.greet.utils.ts.ejs.t ADDED Viewed

@@ -0,0 +1,8 @@
+---
+to: src/features/greet/utils.ts
+---
+import { shared } from "march-hare";
+import { type Envs } from "@shared/types/index.ts";
+import type { Multicast } from "./types.ts";
+export const scope = shared.Scope<Envs, typeof Multicast>();

package/dist/cli/templates/init/new/src.index.tsx.ejs.t ADDED Viewed

@@ -0,0 +1,8 @@
+---
+to: src/index.tsx
+---
+import * as ReactDOM from "react-dom/client";
+import { Root } from "./app/index.tsx";
+const root = ReactDOM.createRoot(document.body);
+root.render(<Root />);

package/dist/cli/templates/init/new/src.shared.components.button.index.test.tsx.ejs.t ADDED Viewed

@@ -0,0 +1,13 @@
+---
+to: src/shared/components/button/index.test.tsx
+---
+import { describe, expect, it } from "vitest";
+import { render, screen } from "@testing-library/react";
+import { Button } from "./index.tsx";
+describe("Button", () => {
+  it("renders its children", () => {
+    render(<Button>Click me</Button>);
+    expect(screen.getByRole("button", { name: "Click me" })).toBeInTheDocument();
+  });
+});

package/dist/cli/templates/init/new/src.shared.components.button.index.tsx.ejs.t ADDED Viewed

@@ -0,0 +1,10 @@
+---
+to: src/shared/components/button/index.tsx
+---
+import * as React from "react";
+import { Button as AntButton } from "antd";
+import type { Props } from "./types.ts";
+export function Button(props: Props): React.ReactElement {
+  return <AntButton {...props} />;
+}

package/dist/cli/templates/init/new/src.shared.components.button.types.ts.ejs.t ADDED Viewed

@@ -0,0 +1,6 @@
+---
+to: src/shared/components/button/types.ts
+---
+import type { ButtonProps } from "antd";
+export type Props = ButtonProps;

package/dist/cli/templates/init/new/src.shared.resources.index.ts.ejs.t ADDED Viewed

@@ -0,0 +1,4 @@
+---
+to: src/shared/resources/index.ts
+---
+export {};

package/dist/cli/templates/init/new/src.shared.theme.index.ts.ejs.t ADDED Viewed

@@ -0,0 +1,51 @@
+---
+to: src/shared/theme/index.ts
+---
+export const colour = <const>{
+  text: {
+    primary: "#1f1f1f",
+    secondary: "#6b6b6b",
+    muted: "#9b9b9b",
+  },
+  surface: {
+    card: "#ffffff",
+    placeholder: "#f0f0f0",
+  },
+};
+export const spacing = <const>{
+  xs: "8px",
+  s: "12px",
+  m: "20px",
+  l: "24px",
+  xl: "32px",
+  xxl: "48px",
+};
+export const radius = <const>{
+  card: "16px",
+  pill: "50%",
+};
+export const shadow = <const>{
+  card: "0 1px 2px rgba(0, 0, 0, 0.04), 0 4px 16px rgba(0, 0, 0, 0.06)",
+};
+export const font = <const>{
+  family: '-apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, sans-serif',
+  size: {
+    s: "14px",
+    m: "15px",
+    l: "16px",
+    xl: "22px",
+    xxl: "36px",
+  },
+  weight: {
+    regular: 400,
+    semibold: 600,
+    bold: 700,
+  },
+  letterSpacing: {
+    tight: "-0.02em",
+  },
+};

package/dist/cli/templates/init/new/src.shared.types.index.ts.ejs.t ADDED Viewed

@@ -0,0 +1,23 @@
+---
+to: src/shared/types/index.ts
+---
+import { Action, Distribution } from "march-hare";
+export namespace Env {
+  export type <%= env %> = {
+    apiBase: string;
+  };
+}
+export type Envs = Env.<%= env %>;
+export namespace Payload {
+  export type Greeting = {
+    message: string;
+    at: number;
+  };
+}
+export namespace Broadcast {
+  export const Greeted = Action<string>("Greeted", Distribution.Broadcast);
+}

package/dist/cli/templates/init/new/src.test-setup.ts.ejs.t ADDED Viewed

@@ -0,0 +1,10 @@
+---
+to: src/test-setup.ts
+---
+import { cleanup } from "@testing-library/react";
+import { afterEach } from "vitest";
+import "@testing-library/jest-dom/vitest";
+afterEach(() => {
+  cleanup();
+});

package/dist/cli/templates/init/new/src.vite-env.d.ts.ejs.t ADDED Viewed

@@ -0,0 +1,4 @@
+---
+to: src/vite-env.d.ts
+---
+/// <reference types="vite/client" />

package/dist/cli/templates/init/new/tests.home.e2e.ts.ejs.t ADDED Viewed

@@ -0,0 +1,14 @@
+---
+to: tests/home.e2e.ts
+---
+import { test, expect } from "@playwright/test";
+test("clicking Say hello renders a greeting", async ({ page }) => {
+  await page.goto("/");
+  await expect(page.getByText(/No greeting yet/)).toBeVisible();
+  await page.getByRole("button", { name: /Say hello/ }).click();
+  await expect(page.getByText(/Hello from/)).toBeVisible();
+});

package/dist/cli/templates/init/new/tsconfig.json.ejs.t ADDED Viewed

@@ -0,0 +1,29 @@
+---
+to: tsconfig.json
+---
+{
+  "compilerOptions": {
+    "target": "es2020",
+    "module": "esnext",
+    "lib": ["es2024", "esnext.temporal", "dom", "dom.iterable"],
+    "moduleResolution": "bundler",
+    "jsx": "react-jsx",
+    "strict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noFallthroughCasesInSwitch": true,
+    "noEmit": true,
+    "skipLibCheck": true,
+    "allowImportingTsExtensions": true,
+    "isolatedModules": true,
+    "moduleDetection": "force",
+    "useDefineForClassFields": true,
+    "paths": {
+      "@app/*": ["./src/app/*"],
+      "@features/*": ["./src/features/*"],
+      "@shared/*": ["./src/shared/*"]
+    }
+  },
+  "include": ["src", "tests"],
+  "exclude": ["**/*.test.ts", "**/*.test.tsx", "**/*.integration.ts", "**/*.integration.tsx"]
+}

package/dist/cli/templates/init/new/vite.config.ts.ejs.t ADDED Viewed

@@ -0,0 +1,17 @@
+---
+to: vite.config.ts
+---
+import { resolve } from "node:path";
+import { defineConfig } from "vite";
+import react from "@vitejs/plugin-react";
+export default defineConfig({
+  resolve: {
+    alias: {
+      "@app": resolve(__dirname, "src/app"),
+      "@features": resolve(__dirname, "src/features"),
+      "@shared": resolve(__dirname, "src/shared"),
+    },
+  },
+  plugins: [react()],
+});