@highbeek/create-rnstarterkit 1.0.2-beta.7 → 1.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ibukun Agboola
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,268 @@
+# RNStarterKit
+
+**A CLI that scaffolds production-ready React Native apps with clean architecture and sensible defaults.**
+
+Not a replacement for Expo or React Native CLI — it sits on top of them and structures your project correctly from day one.
+
+```bash
+npx @highbeek/create-rnstarterkit myApp
+```
+
+---
+
+## Why This Exists
+
+Every serious React Native project ends up making the same decisions:
+
+- Where do API calls live?
+- How is auth state managed and persisted?
+- What's the folder structure when the app scales?
+- How are environment variables typed?
+
+This tool answers those questions upfront. You get a complete, typed, linted project with your chosen stack — ready to build on, not fight against.
+
+---
+
+## Quick Start
+
+```bash
+npx @highbeek/create-rnstarterkit myApp
+
+# Skip prompts with a preset
+npx @highbeek/create-rnstarterkit myApp --preset fintech
+npx @highbeek/create-rnstarterkit myApp --preset social
+npx @highbeek/create-rnstarterkit myApp --preset indie
+npx @highbeek/create-rnstarterkit myApp --preset minimal
+```
+
+### After scaffolding — React Native CLI projects
+
+Native dependencies need linking via CocoaPods before you can run on iOS:
+
+```bash
+cd myApp
+npm install
+cd ios && pod install && cd ..
+
+# Then run
+npx react-native run-ios
+npx react-native run-android
+```
+
+### After scaffolding — Expo projects
+
+```bash
+cd myApp
+npx expo start
+```
+
+---
+
+## Presets
+
+Presets bundle the most common stack combinations so you can skip all prompts:
+
+| Preset | Platform | State | Auth | Data | Storage | Extras |
+|---|---|---|---|---|---|---|
+| `minimal` | Expo | None | No | None | None | Bare structure |
+| `indie` | Expo | Context API | Yes | React Query | AsyncStorage | Husky |
+| `social` | Expo | Zustand | Yes | SWR | AsyncStorage | Sentry, i18n, CI |
+| `fintech` | RN CLI | Redux Toolkit | Yes | React Query | MMKV | Sentry, i18n, Maestro, CI |
+
+---
+
+## Interactive Setup
+
+When run without a preset, the CLI walks you through your stack:
+
+```
+? Project name:
+? Platform:                Expo / React Native CLI
+? TypeScript:              Yes / No
+? Absolute imports (@/*):  Yes / No
+? State management:        None / Context API / Redux Toolkit / Zustand
+? Data fetching:           None / React Query / SWR
+? Validation:              Formik / React Hook Form / Yup
+? Storage:                 AsyncStorage / MMKV / None
+? Auth scaffold:           Yes / No
+? API client:              Yes / No  →  Fetch / Axios
+? Sentry:                  Yes / No
+? i18n (i18next):          Yes / No
+? Maestro E2E flows:       Yes / No
+? NativeWind (Tailwind):   Yes / No
+? CI (GitHub Actions):     Yes / No
+? Husky pre-commit hooks:  Yes / No
+```
+
+---
+
+## Generator Commands
+
+After scaffolding, use the `generate` subcommand to add code that matches your project's setup:
+
+```bash
+npx @highbeek/create-rnstarterkit generate screen Dashboard
+npx @highbeek/create-rnstarterkit generate component Avatar
+npx @highbeek/create-rnstarterkit generate hook useDebounce
+npx @highbeek/create-rnstarterkit generate slice cart
+```
+
+Generators are context-aware — they read your project's config from `package.json` and produce files with the correct imports for your state manager, platform, and auth setup.
+
+| Command | Output |
+|---|---|
+| `generate screen Name` | `src/screens/NameScreen.tsx` with correct state hook |
+| `generate component Name` | `src/components/Name.tsx` with typed props + StyleSheet |
+| `generate hook useName` | `src/hooks/useName.ts` with loading/error boilerplate |
+| `generate slice name` | `src/store/nameSlice.ts` + auto-patches `store.ts` |
+
+> `generate slice` only works in Redux Toolkit projects. It automatically adds the reducer to your store.
+
+---
+
+## What Gets Generated
+
+```
+<project>/
+├── src/
+│   ├── api/              # API client + endpoints
+│   ├── components/       # Shared UI components + ErrorBoundary
+│   ├── config/           # Typed env config
+│   ├── context/          # Context API providers (if selected)
+│   ├── hooks/            # Shared custom hooks
+│   ├── i18n/             # i18next config + locales (if selected)
+│   ├── navigation/       # Navigation setup (RN CLI)
+│   ├── providers/        # App-level providers
+│   ├── screens/          # App screens
+│   ├── services/         # Query clients, external services
+│   ├── store/            # Redux / Zustand store (if selected)
+│   ├── theme/            # Color tokens, spacing, typography
+│   ├── types/            # Shared TypeScript types
+│   └── utils/            # Shared utilities + Sentry (if selected)
+├── .env.example          # Environment variable template
+├── .husky/               # Pre-commit hooks (if selected)
+├── .maestro/             # E2E flows (if selected)
+├── .vscode/              # Editor config + extension recommendations
+└── .github/workflows/    # CI pipeline (if selected)
+```
+
+---
+
+## Optional Modules
+
+### Auth Scaffold
+
+Three implementations — all include Login/Register screens, protected routes, token persistence, and a ScreenLayout wrapper:
+
+| Option | State | Best For |
+|---|---|---|
+| Context API | Built-in React | Most apps |
+| Redux Toolkit | `@reduxjs/toolkit` | Complex global state |
+| Zustand | `zustand` | Minimal, no boilerplate |
+
+### API Client
+
+| Option | Description |
+|---|---|
+| Fetch | Zero deps — typed wrapper with request/response interceptors |
+| Axios | Full Axios instance with error normalisation + typed helpers |
+
+### Data Fetching
+
+| Option | Setup |
+|---|---|
+| React Query | QueryClient pre-configured with retry + stale time defaults |
+| SWR | SWRConfig provider + typed `useSWRFetch` hook |
+
+### Storage
+
+| Option | Description |
+|---|---|
+| AsyncStorage | Default — async token persistence |
+| MMKV | Synchronous, 10x faster, drop-in replacement |
+
+### NativeWind (Tailwind CSS)
+
+Adds `nativewind` + `tailwindcss` and wires everything up for your platform:
+
+| Step | Expo | React Native CLI |
+|---|---|---|
+| `tailwind.config.js` | content globs for `app/` + `src/` | content globs for `App.tsx` + `src/` |
+| `global.css` | created, imported in `app/_layout.tsx` | created, imported in `index.js` |
+| `metro.config.js` | wrapped with `withNativeWind` (expo/metro-config) | wrapped with `withNativeWind` (@react-native/metro-config) |
+| `babel.config.js` | `jsxImportSource: 'nativewind'` in babel-preset-expo | `nativewind/babel` plugin added |
+| `tsconfig.json` | `"nativewind/types"` added to types | same |
+
+After generation, use `className` props directly on React Native components — no extra setup needed.
+
+### Sentry
+
+Adds `@sentry/react-native`, initialises in the app entry point, and exports `captureException` + `addBreadcrumb` helpers. The DSN is read from your environment variables — set `EXPO_PUBLIC_SENTRY_DSN` (Expo) or `SENTRY_DSN` (RN CLI) in your `.env` file.
+
+### i18n
+
+Adds `i18next` + `react-i18next` with:
+- Language auto-detection via `react-native-localize`
+- English + Spanish locale files as a starting point
+- Typed `useAppTranslation` hook
+
+### Maestro E2E
+
+Generates `.maestro/flows/` with welcome, login, and logout flows. Automatically adds a Maestro job to the CI workflow when both are selected.
+
+### CI
+
+GitHub Actions workflow with lint and test jobs on push/PR to `main` and `develop`.
+
+---
+
+## Tooling (Always Included)
+
+| Tool | Config |
+|---|---|
+| TypeScript | `strict: true`, platform-native tsconfig |
+| ESLint | `@react-native` ruleset, `--max-warnings 0` |
+| Prettier | `format` script wired to `package.json` |
+| Jest | RTL setup, `transformIgnorePatterns` for RN modules |
+| VSCode | `extensions.json` + `settings.json` (format on save) |
+| `.env.example` | Environment variable template + `.gitignore` entry |
+| Theme | `colors.ts`, `spacing.ts`, `typography.ts` tokens |
+| ErrorBoundary | Class component with reset, ready to wrap your app |
+| Navigation types | `AuthStackParamList`, `MainTabParamList` (RN CLI + auth) |
+
+---
+
+## Architecture
+
+**Typed from the start.** TypeScript strict mode on by default. API responses, environment variables, and navigation params are all typed.
+
+**Thin screens, fat hooks.** Screens handle UI. Business logic, API calls, and state live in hooks and services. Screens don't call APIs directly.
+
+**Non-destructive generation.** `writeIfMissing` is used throughout — the generator never overwrites files you've already customised.
+
+---
+
+## Contributing
+
+```bash
+git clone https://github.com/highbeek/rnstarterkit
+cd rnstarterkit
+npm install
+npm run build
+```
+
+See [CONTRIBUTING.md](./CONTRIBUTING.md) for the full development workflow, testing, and PR guidelines.
+
+---
+
+## Status
+
+Current version: `1.0.0`
+
+Core scaffolding, presets, and generators are stable. Feedback and contributions welcome.
+
+---
+
+## License
+
+MIT

package/dist/bin/create-rnstarterkit.js

@@ -4,15 +4,95 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+const commander_1 = require("commander");
 const inquirer_1 = __importDefault(require("inquirer"));
 const appGenerator_1 = require("../src/generators/appGenerator");
-async function main() {
-    console.log("🚀 Welcome to RNStarterKit!");
+const codeGenerator_1 = require("../src/generators/codeGenerator");
+// ---------------------------------------------------------------------------
+// Presets — opinionated bundles that skip the 12-question prompt
+// ---------------------------------------------------------------------------
+const PRESETS = {
+    minimal: {
+        typescript: true,
+        absoluteImports: false,
+        state: "None",
+        auth: false,
+        dataFetching: "None",
+        validation: [],
+        storage: "None",
+        apiClient: false,
+        ci: false,
+        husky: false,
+        sentry: false,
+        i18n: false,
+        maestro: false,
+        nativewind: false,
+    },
+    fintech: {
+        platform: "React Native CLI",
+        typescript: true,
+        absoluteImports: true,
+        state: "Redux Toolkit",
+        auth: true,
+        dataFetching: "React Query",
+        validation: [],
+        storage: "MMKV",
+        apiClient: true,
+        apiClientType: "Fetch",
+        ci: true,
+        husky: true,
+        sentry: true,
+        i18n: true,
+        maestro: true,
+        nativewind: false,
+    },
+    social: {
+        platform: "Expo",
+        typescript: true,
+        absoluteImports: true,
+        state: "Zustand",
+        auth: true,
+        dataFetching: "SWR",
+        validation: [],
+        storage: "AsyncStorage",
+        apiClient: true,
+        apiClientType: "Fetch",
+        ci: true,
+        husky: true,
+        sentry: true,
+        i18n: true,
+        maestro: false,
+        nativewind: false,
+    },
+    indie: {
+        platform: "Expo",
+        typescript: true,
+        absoluteImports: true,
+        state: "Context API",
+        auth: true,
+        dataFetching: "React Query",
+        validation: [],
+        storage: "AsyncStorage",
+        apiClient: true,
+        apiClientType: "Fetch",
+        ci: false,
+        husky: true,
+        sentry: false,
+        i18n: false,
+        maestro: false,
+        nativewind: false,
+    },
+};
+// ---------------------------------------------------------------------------
+// Interactive prompt
+// ---------------------------------------------------------------------------
+async function runInteractivePrompt(prefilledName, presetDefaults) {
     const answers = await inquirer_1.default.prompt([
         {
             type: "input",
             name: "projectName",
             message: "Project name:",
+            when: () => !prefilledName,
             validate: (input) => /^[A-Za-z0-9]+$/.test(input)
                 ? true
                 : "Project name must be alphanumeric",
@@ -22,18 +102,21 @@ async function main() {
             name: "platform",
             message: "Choose platform",
             choices: ["Expo", "React Native CLI"],
+            when: () => !presetDefaults?.platform,
         },
         {
             type: "confirm",
             name: "typescript",
             message: "Use TypeScript?",
             default: true,
+            when: () => presetDefaults?.typescript === undefined,
         },
         {
             type: "confirm",
             name: "absoluteImports",
             message: "Use absolute import alias (@/*)?",
             default: true,
+            when: () => presetDefaults?.absoluteImports === undefined,
         },
         {
             type: "rawlist",
@@ -41,6 +124,7 @@ async function main() {
             message: "State management?",
             choices: ["None", "Context API", "Redux Toolkit", "Zustand"],
             default: "Context API",
+            when: () => !presetDefaults?.state,
         },
         {
             type: "rawlist",
@@ -48,6 +132,7 @@ async function main() {
             message: "Data fetching library?",
             choices: ["None", "React Query", "SWR"],
             default: "None",
+            when: () => !presetDefaults?.dataFetching,
         },
         {
             type: "checkbox",
@@ -55,6 +140,7 @@ async function main() {
             message: "Validation libraries?",
             choices: ["Formik", "React Hook Form", "Yup"],
             default: [],
+            when: () => !presetDefaults?.validation?.length,
             validate: (selected) => {
                 if (selected.includes("Formik") && !selected.includes("Yup")) {
                     return "Formik requires Yup in this starter. Select Yup as well.";
@@ -68,18 +154,21 @@ async function main() {
             message: "Storage method?",
             choices: ["AsyncStorage", "MMKV", "None"],
             default: "AsyncStorage",
+            when: () => !presetDefaults?.storage,
         },
         {
             type: "confirm",
             name: "auth",
             message: "Include auth scaffold?",
             default: false,
+            when: () => presetDefaults?.auth === undefined,
         },
         {
             type: "confirm",
             name: "apiClient",
             message: "Include API client scaffold?",
             default: true,
+            when: () => presetDefaults?.apiClient === undefined,
         },
         {
             type: "rawlist",
@@ -87,19 +176,128 @@ async function main() {
             message: "API client transport?",
             choices: ["Fetch", "Axios"],
             default: "Fetch",
-            when: (answers) => answers.apiClient,
+            when: (a) => presetDefaults?.apiClientType === undefined && a.apiClient,
+        },
+        {
+            type: "confirm",
+            name: "sentry",
+            message: "Include Sentry crash reporting?",
+            default: false,
+            when: () => presetDefaults?.sentry === undefined,
+        },
+        {
+            type: "confirm",
+            name: "i18n",
+            message: "Include i18n (i18next + react-i18next)?",
+            default: false,
+            when: () => presetDefaults?.i18n === undefined,
+        },
+        {
+            type: "confirm",
+            name: "maestro",
+            message: "Include Maestro E2E test flows?",
+            default: false,
+            when: () => presetDefaults?.maestro === undefined,
+        },
+        {
+            type: "confirm",
+            name: "nativewind",
+            message: "Use NativeWind (Tailwind CSS for React Native)?",
+            default: false,
+            when: () => presetDefaults?.nativewind === undefined,
         },
         {
             type: "confirm",
             name: "ci",
-            message: "Include CI setup?",
+            message: "Include CI setup (GitHub Actions)?",
             default: false,
+            when: () => presetDefaults?.ci === undefined,
+        },
+        {
+            type: "confirm",
+            name: "husky",
+            message: "Set up Husky pre-commit hooks (lint-staged)?",
+            default: true,
+            when: () => presetDefaults?.husky === undefined,
         },
     ]);
-    await (0, appGenerator_1.generateApp)(answers);
+    return {
+        projectName: prefilledName ?? answers.projectName,
+        platform: answers.platform ?? presetDefaults?.platform ?? "Expo",
+        typescript: answers.typescript ?? presetDefaults?.typescript ?? true,
+        absoluteImports: answers.absoluteImports ?? presetDefaults?.absoluteImports ?? true,
+        state: answers.state ?? presetDefaults?.state ?? "None",
+        auth: answers.auth ?? presetDefaults?.auth ?? false,
+        dataFetching: answers.dataFetching ?? presetDefaults?.dataFetching ?? "None",
+        validation: answers.validation ?? presetDefaults?.validation ?? [],
+        storage: answers.storage ?? presetDefaults?.storage ?? "AsyncStorage",
+        apiClient: answers.apiClient ?? presetDefaults?.apiClient ?? false,
+        apiClientType: answers.apiClientType ?? presetDefaults?.apiClientType,
+        sentry: answers.sentry ?? presetDefaults?.sentry ?? false,
+        i18n: answers.i18n ?? presetDefaults?.i18n ?? false,
+        maestro: answers.maestro ?? presetDefaults?.maestro ?? false,
+        nativewind: answers.nativewind ?? presetDefaults?.nativewind ?? false,
+        ci: answers.ci ?? presetDefaults?.ci ?? false,
+        husky: answers.husky ?? presetDefaults?.husky ?? true,
+    };
 }
-main().catch((error) => {
-    console.error("❌ Failed to create project.");
+// ---------------------------------------------------------------------------
+// CLI wiring
+// ---------------------------------------------------------------------------
+const program = new commander_1.Command();
+program
+    .name("create-rnstarterkit")
+    .description("Scaffold a production-ready React Native app")
+    .version("1.0.0")
+    .argument("[projectName]", "Name of the project (alphanumeric)")
+    .option("--preset <name>", "Skip prompts with a preset: minimal | fintech | social | indie")
+    .action(async (projectName, cmdOptions) => {
+    console.log("🚀 Welcome to RNStarterKit!");
+    const presetKey = cmdOptions.preset;
+    if (presetKey && !(presetKey in PRESETS)) {
+        console.error(`❌ Unknown preset "${presetKey}". Available: ${Object.keys(PRESETS).join(", ")}`);
+        process.exit(1);
+    }
+    const presetDefaults = presetKey ? PRESETS[presetKey] : undefined;
+    // Preset + name supplied → fully non-interactive
+    if (presetDefaults && projectName) {
+        const options = {
+            projectName,
+            platform: presetDefaults.platform ?? "Expo",
+            typescript: presetDefaults.typescript ?? true,
+            absoluteImports: presetDefaults.absoluteImports ?? true,
+            state: presetDefaults.state ?? "None",
+            auth: presetDefaults.auth ?? false,
+            dataFetching: presetDefaults.dataFetching ?? "None",
+            validation: presetDefaults.validation ?? [],
+            storage: presetDefaults.storage ?? "AsyncStorage",
+            apiClient: presetDefaults.apiClient ?? false,
+            apiClientType: presetDefaults.apiClientType,
+            sentry: presetDefaults.sentry ?? false,
+            i18n: presetDefaults.i18n ?? false,
+            maestro: presetDefaults.maestro ?? false,
+            nativewind: presetDefaults.nativewind ?? false,
+            ci: presetDefaults.ci ?? false,
+            husky: presetDefaults.husky ?? true,
+        };
+        console.log(`⚡ Using preset: ${presetKey}`);
+        await (0, appGenerator_1.generateApp)(options);
+    }
+    else {
+        const options = await runInteractivePrompt(projectName, presetDefaults);
+        await (0, appGenerator_1.generateApp)(options);
+    }
+});
+// generate subcommand
+program
+    .command("generate <type> <name>")
+    .description("Generate code inside an existing rnstarterkit project\n" +
+    "  Types: screen | component | hook | slice")
+    .action(async (type, name) => {
+    await (0, codeGenerator_1.generateCode)(type, name);
+});
+program.parseAsync(process.argv).catch((error) => {
+    console.error("❌ Failed.");
     console.error(error);
     process.exit(1);
 });