create-nexora-next 0.3.7 → 0.4.8

package/README.md

@@ -1,46 +1,228 @@
-# create-nexora-next
-
-> The official Next.js scaffolding CLI by Rayan — batteries included.
-
-## Usage
-
-```bash
-npx create-nexora-next
-pnpm dlx create-nexora-next
-bunx create-nexora-next
-```
-
-## What it sets up
-
-### Always included
-- Next.js (TypeScript, Tailwind CSS v4, ESLint, App Router, `~/` alias)
-- shadcn/ui initialized with defaults
-- Custom `globals.css` (squircle utilities, container, skeleton animation)
-- `.prettierrc` with `prettier-plugin-tailwindcss`
-- `.env.local` pre-populated
-- Poppins font via `next/font/google`
-- `cn()`, `toSlug()`, `trycatch()`, and other utils
-- Typed constants (`TZ_COOKIE`, `SITE_URL`)
-- SEO metadata scaffold
-- `SileoToaster` component
-- Providers pattern (`src/components/providers/`)
-- nuqs adapter (URL state management)
-- Core deps: `zustand`, `zod`, `react-hook-form`, `date-fns`, `nuqs`, `cookies-next`, `nextjs-toploader`
-- Dev deps: `prettier`, `prettier-plugin-tailwindcss`, `babel-plugin-react-compiler`
-
-### Optional features (prompted)
-
-| Feature | What gets installed / created |
-|---|---|
-| Husky | `husky`, `lint-staged`, pre-commit hook |
-| Localization | `next-intl`, `src/i18n/`, `locales/en.json`, `[locale]/page.tsx` |
-| TanStack Query | `@tanstack/react-query`, persist client, query-client provider |
-| Auth | proxy chain, auth validators, `src/apis/` |
-| Theming | `next-themes`, theme provider |
-| Animations | `motion`, `gsap` |
-| Axios | `axios`, `axios.client.ts`, `axios.server.ts` |
-
-## Requirements
-
-- Node.js 18+
-- npm, pnpm, bun, or yarn
+<div align="center">
+
+```
+  ███╗   ██╗███████╗██╗  ██╗ ██████╗ ██████╗  █████╗
+  ████╗  ██║██╔════╝╚██╗██╔╝██╔═══██╗██╔══██╗██╔══██╗
+  ██╔██╗ ██║█████╗   ╚███╔╝ ██║   ██║██████╔╝███████║
+  ██║╚██╗██║██╔══╝   ██╔██╗ ██║   ██║██╔══██╗██╔══██║
+  ██║ ╚████║███████╗██╔╝ ██╗╚██████╔╝██║  ██║██║  ██║
+  ╚═╝  ╚═══╝╚══════╝╚═╝  ╚═╝ ╚═════╝ ╚═╝  ╚═╝╚═╝  ╚═╝
+```
+
+**The opinionated Next.js scaffold CLI by Rayan.**  
+One command. Full setup. Ship faster.
+
+[![npm version](https://img.shields.io/npm/v/create-nexora-next?color=cyan&style=flat-square)](https://www.npmjs.com/package/create-nexora-next)
+[![npm downloads](https://img.shields.io/npm/dm/create-nexora-next?color=blue&style=flat-square)](https://www.npmjs.com/package/create-nexora-next)
+[![license](https://img.shields.io/npm/l/create-nexora-next?style=flat-square)](./LICENSE)
+[![node](https://img.shields.io/node/v/create-nexora-next?style=flat-square)](https://nodejs.org)
+
+</div>
+
+---
+
+## Usage
+
+```bash
+# npm
+npx create-nexora-next@latest
+
+# pnpm
+pnpm dlx create-nexora-next@latest
+
+# bun
+bunx create-nexora-next@latest
+
+# yarn
+yarn dlx create-nexora-next@latest
+```
+
+The CLI will guide you through a short prompt sequence — pick your package manager, choose your features, and watch your project build itself.
+
+---
+
+## What's always included
+
+Every project scaffolded with `create-nexora-next` comes with this baseline — no questions asked:
+
+| What | Details |
+|---|---|
+| **Next.js 16** | TypeScript · Tailwind CSS v4 · ESLint · App Router · `src/` dir · `~/` path alias |
+| **shadcn/ui** | Initialised with defaults · `components.json` patched to `~/lib/utils/index.ts` |
+| **Custom globals.css** | Squircle utilities · responsive container · skeleton animation · reduced motion |
+| **Prettier** | `prettier-plugin-tailwindcss` for automatic class sorting |
+| **Poppins font** | Via `next/font/google` with full weight range |
+| **Utility functions** | `cn()` · `toSlug()` · `createInitials()` · `normalizeEmail()` · `sanitizeName()` · `trycatch()` |
+| **Constants** | `SITE_URL` · `TZ_COOKIE` · locale constants (if i18n opted in) |
+| **SEO scaffold** | `src/lib/seo/index.ts` — locale-aware if i18n enabled |
+| **Sitemap** | `src/app/sitemap.ts` pre-wired to `SITE_URL` |
+| **ESLint config** | Clean flat config with Next.js core web vitals + TypeScript rules |
+| **Providers pattern** | Dynamic `src/components/providers/index.ts` — only includes what you opted into |
+| **SileoToaster** | Toast notifications via `sileo` |
+| **nuqs** | Type-safe URL search params adapter |
+| **nextjs-toploader** | Page transition progress bar |
+| **Folder structure** | `hooks/` · `components/{atoms,molecules,organisms,primitives,adapters,providers,ui}/` |
+| **Core deps** | `zustand` · `zod` · `react-hook-form` · `date-fns` · `@date-fns/tz` · `clsx` · `tailwind-merge` |
+| **Dev deps** | `prettier` · `prettier-plugin-tailwindcss` · `babel-plugin-react-compiler` |
+| **Scripts** | `type-check` added to `package.json` → `tsc --pretty --noEmit` |
+
+---
+
+## Optional features
+
+Prompted during setup — only what you need gets installed:
+
+### 🌍 Localization (`next-intl`)
+- `src/i18n/{routing,request,navigation}.ts`
+- `locales/en.json` with base translation keys
+- `src/app/[locale]/page.tsx` + `src/app/[locale]/layout.tsx`
+- Root `layout.tsx` replaced with passthrough shell
+- Default `src/app/page.tsx` removed
+- `next-intl.ts` config with typed `AppConfig`
+- `src/lib/utils/locale-date-formats.ts`
+- `LocaleProvider` + `TzProvider` (auto-detects and persists device timezone)
+- `next.config.ts` updated with `createNextIntlPlugin`
+
+### ⚡ TanStack Query
+- `@tanstack/react-query` installed first (peer dep order guaranteed)
+- `@tanstack/react-query-persist-client` + `@tanstack/query-async-storage-persister`
+- Pre-configured `QueryClientProvider` with:
+  - 5-minute stale time
+  - Local storage persistence (24h)
+  - Mutation cache auto-invalidation via `meta.invalidateQueries`
+- `@tanstack/eslint-plugin-query` as devDependency
+
+### 🎨 Theming (`next-themes`)
+- `ThemeProvider` with system default, class attribute, smooth transitions
+
+### 🔐 Auth
+- Proxy chain middleware (`src/proxy.ts`)
+- `withProxyChain` + `authProxy` stub
+- `src/lib/validators/{index,auth}.ts` — `LoginSchema`, `RegisterSchema`
+- `src/apis/{client,server}/index.ts`
+- `cookies-next` installed
+
+### 🎭 Animations
+- `motion` (formerly Framer Motion)
+- `gsap`
+
+### 🔄 Axios
+- `axios` installed
+- `src/lib/axios/axios.client.ts` — pre-configured client instance
+- `src/lib/axios/axios.server.ts` — pre-configured server instance
+
+### 🐶 Husky pre-commit hooks
+Runs three checks on every commit:
+```
+📝 Lint       → bun lint
+🔍 Type check → bun type-check
+🏗️  Build      → bun run build
+```
+Fails fast with a clear error message. Shows timestamp on success.
+
+### ⚛️ React Compiler
+- `babel-plugin-react-compiler` (always installed as devDep)
+- `reactCompiler: true` added to `next.config.ts` if opted in
+
+---
+
+## Project structure
+
+```
+my-app/
+├── locales/
+│   └── en.json                         # (i18n)
+├── src/
+│   ├── app/
+│   │   ├── [locale]/
+│   │   │   ├── layout.tsx              # (i18n) full root layout
+│   │   │   └── page.tsx                # (i18n) localized home
+│   │   ├── layout.tsx                  # passthrough shell (i18n) or full layout
+│   │   ├── globals.css
+│   │   └── sitemap.ts
+│   ├── i18n/                           # (i18n)
+│   │   ├── routing.ts
+│   │   ├── request.ts
+│   │   └── navigation.ts
+│   ├── components/
+│   │   ├── adapters/
+│   │   │   └── nuqs.adapter.tsx
+│   │   ├── atoms/
+│   │   ├── molecules/
+│   │   ├── organisms/
+│   │   ├── primitives/
+│   │   ├── providers/
+│   │   │   ├── index.ts                # dynamic — opted-in providers only
+│   │   │   ├── theme.provider.tsx      # (theming)
+│   │   │   ├── locale.provider.tsx     # (i18n)
+│   │   │   ├── tz.provider.tsx         # (i18n)
+│   │   │   └── query-client.provider.tsx # (query)
+│   │   └── ui/
+│   │       └── sileo.tsx
+│   ├── constants/
+│   │   └── index.ts
+│   ├── hooks/
+│   ├── lib/
+│   │   ├── axios/                      # (axios)
+│   │   │   ├── axios.client.ts
+│   │   │   └── axios.server.ts
+│   │   ├── fonts.ts
+│   │   ├── proxy/                      # (auth or i18n)
+│   │   │   ├── index.ts
+│   │   │   └── auth.ts                 # (auth)
+│   │   ├── seo/
+│   │   │   └── index.ts
+│   │   ├── utils/
+│   │   │   ├── index.ts
+│   │   │   └── locale-date-formats.ts  # (i18n)
+│   │   └── validators/                 # (auth)
+│   │       ├── index.ts
+│   │       └── auth.ts
+│   ├── apis/                           # (auth)
+│   │   ├── client/
+│   │   └── server/
+│   └── proxy.ts                        # (i18n or auth)
+├── .env.local
+├── .prettierrc
+├── .husky/pre-commit                   # (husky)
+├── components.json
+├── eslint.config.mjs
+├── next-intl.ts                        # (i18n)
+└── next.config.ts
+```
+
+---
+
+## Error recovery
+
+If any step fails during setup, the CLI **pauses and shows you the exact error**. Fix the issue then press **Enter** to retry that step — no need to restart from scratch.
+
+---
+
+## Requirements
+
+- **Node.js** 18+
+- **Package manager** — npm · pnpm · bun · yarn
+
+---
+
+## Part of the Nexora family
+
+| Package | Stack |
+|---|---|
+| `create-nexora-next` | Next.js |
+| `create-nexora-go` | *(coming soon)* |
+
+---
+
+## Author
+
+**Chiatiah Rayan** · [rayanstudio.dev](https://rayanstudio.dev) · [@bbrainttech](https://github.com/bbrainttech)
+
+---
+
+<div align="center">
+
+Made with 🔥 by Rayan · MIT License
+
+</div>

package/package.json

@@ -1,46 +1,46 @@
-{
-  "name": "create-nexora-next",
-  "version": "0.3.7",
-  "description": "The official Next.js scaffolding CLI by Rayan — batteries included.",
-  "type": "module",
-  "bin": {
-    "create-nexora-next": "src/index.js"
-  },
-  "files": [
-    "src"
-  ],
-  "scripts": {
-    "start": "node src/index.js",
-    "dev": "node src/index.js"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/grimstack/create-nexora-next.git"
-  },
-  "contributors": [
-    {
-      "name": "Chiatiah Rayan",
-      "email": "hello@rayanstudio.dev",
-      "url": "https://github.com/bbrainttech"
-    }
-  ],
-  "dependencies": {
-    "@clack/prompts": "^0.9.0",
-    "picocolors": "^1.1.1"
-  },
-  "engines": {
-    "node": ">=18.0.0"
-  },
-  "keywords": [
-    "nextjs",
-    "scaffold",
-    "cli",
-    "create-app",
-    "rayan",
-    "next-intl",
-    "shadcn",
-    "tanstack"
-  ],
-  "author": "Rayan",
-  "license": "MIT"
-}
+{
+  "name": "create-nexora-next",
+  "version": "0.4.8",
+  "description": "The official Next.js scaffolding CLI by Rayan — batteries included.",
+  "type": "module",
+  "bin": {
+    "create-nexora-next": "src/index.js"
+  },
+  "files": [
+    "src"
+  ],
+  "scripts": {
+    "start": "node src/index.js",
+    "dev": "node src/index.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/grimstack/create-nexora-next.git"
+  },
+  "contributors": [
+    {
+      "name": "Chiatiah Rayan",
+      "email": "hello@rayanstudio.dev",
+      "url": "https://github.com/bbrainttech"
+    }
+  ],
+  "dependencies": {
+    "@clack/prompts": "^0.9.0",
+    "picocolors": "^1.1.1"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "keywords": [
+    "nextjs",
+    "scaffold",
+    "cli",
+    "create-app",
+    "rayan",
+    "next-intl",
+    "shadcn",
+    "tanstack"
+  ],
+  "author": "Rayan",
+  "license": "MIT"
+}