@highbeek/create-rnstarterkit 1.0.0

package/dist/bin/create-rnstarterkit.js

@@ -0,0 +1,91 @@
+#!/usr/bin/env node
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const inquirer_1 = __importDefault(require("inquirer"));
+const appGenerator_1 = require("../src/generators/appGenerator");
+async function main() {
+    console.log("🚀 Welcome to RNStarterKit!");
+    const answers = await inquirer_1.default.prompt([
+        {
+            type: "input",
+            name: "projectName",
+            message: "Project name:",
+            validate: (input) => /^[A-Za-z0-9]+$/.test(input)
+                ? true
+                : "Project name must be alphanumeric",
+        },
+        {
+            type: "list",
+            name: "platform",
+            message: "Choose platform",
+            choices: ["Expo", "React Native CLI"],
+        },
+        {
+            type: "confirm",
+            name: "typescript",
+            message: "Use TypeScript?",
+            default: true,
+        },
+        {
+            type: "confirm",
+            name: "absoluteImports",
+            message: "Use absolute import alias (@/*)?",
+            default: true,
+        },
+        {
+            type: "list",
+            name: "state",
+            message: "State management?",
+            choices: ["None", "Redux Toolkit", "Zustand"],
+            default: "None",
+        },
+        {
+            type: "list",
+            name: "dataFetching",
+            message: "Data fetching library?",
+            choices: ["None", "React Query", "SWR", "Axios"],
+            default: "None",
+        },
+        {
+            type: "checkbox",
+            name: "validation",
+            message: "Validation libraries?",
+            choices: ["Formik", "React Hook Form", "Yup"],
+            default: [],
+        },
+        {
+            type: "list",
+            name: "storage",
+            message: "Storage method?",
+            choices: ["AsyncStorage", "MMKV", "None"],
+            default: "AsyncStorage",
+        },
+        {
+            type: "confirm",
+            name: "auth",
+            message: "Include auth scaffold?",
+            default: false,
+        },
+        {
+            type: "confirm",
+            name: "apiClient",
+            message: "Include API client scaffold?",
+            default: true,
+        },
+        {
+            type: "confirm",
+            name: "ci",
+            message: "Include CI setup?",
+            default: false,
+        },
+    ]);
+    await (0, appGenerator_1.generateApp)(answers);
+}
+main().catch((error) => {
+    console.error("❌ Failed to create project.");
+    console.error(error);
+    process.exit(1);
+});

package/dist/src/cli.js

@@ -0,0 +1 @@
+"use strict";

package/dist/src/generators/appGenerator.js

@@ -0,0 +1,431 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateApp = generateApp;
+const path_1 = __importDefault(require("path"));
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const execa_1 = require("execa");
+async function generateApp(options) {
+    const { platform, projectName, auth, apiClient, absoluteImports, state, dataFetching, validation, storage, typescript, } = options;
+    const templateRoot = await resolveTemplateRoot();
+    const templateFolder = platform === "Expo" ? "expo-base" : "cli-base";
+    const templatePath = path_1.default.join(templateRoot, templateFolder);
+    const targetPath = path_1.default.join(process.cwd(), projectName);
+    console.log("📂 Creating project...");
+    await fs_extra_1.default.copy(templatePath, targetPath, {
+        filter: (src) => shouldCopyPath(src),
+    });
+    await replaceProjectName(targetPath, projectName);
+    await createStandardStructure(targetPath);
+    if (auth) {
+        const authFolder = state === "Redux Toolkit"
+            ? "auth-redux"
+            : state === "Zustand"
+                ? "auth-zustand"
+                : "auth-context";
+        await copyOptionalModule(authFolder, targetPath);
+        if (authFolder === "auth-context" ||
+            authFolder === "auth-zustand" ||
+            authFolder === "auth-redux") {
+            await setAuthTabsByPlatform(targetPath, platform);
+        }
+    }
+    if (apiClient) {
+        await copyOptionalModule("apiClient", targetPath);
+        await configureApiClientByPlatform(targetPath, platform);
+    }
+    if (state === "Redux Toolkit")
+        await copyOptionalModule("redux", targetPath);
+    if (state === "Zustand")
+        await copyOptionalModule("zustand", targetPath);
+    if (dataFetching === "React Query")
+        await copyOptionalModule("react-query", targetPath);
+    if (storage === "MMKV")
+        await copyOptionalModule("mmkv", targetPath);
+    await configureAbsoluteImports(targetPath, platform, absoluteImports);
+    await configureDataFetching(targetPath, dataFetching, apiClient);
+    await configureValidation(targetPath, validation);
+    if (typescript) {
+        const tsconfigTemplate = path_1.default.join(templateRoot, "optional/tsconfig.json");
+        if (await fs_extra_1.default.pathExists(tsconfigTemplate)) {
+            await fs_extra_1.default.copy(tsconfigTemplate, path_1.default.join(targetPath, "tsconfig.json"), {
+                overwrite: true,
+            });
+        }
+        const appJs = path_1.default.join(targetPath, "App.js");
+        const appTsx = path_1.default.join(targetPath, "App.tsx");
+        if (await fs_extra_1.default.pathExists(appJs)) {
+            await fs_extra_1.default.rename(appJs, appTsx);
+        }
+    }
+    await installDependencies(targetPath);
+    console.log("✅ Project created successfully!");
+}
+async function copyOptionalModule(moduleName, targetPath) {
+    const templateRoot = await resolveTemplateRoot();
+    const modulePath = path_1.default.join(templateRoot, "optional", moduleName);
+    if (await fs_extra_1.default.pathExists(modulePath)) {
+        await fs_extra_1.default.copy(modulePath, targetPath, { overwrite: true });
+        console.log(`➕ Added optional module: ${moduleName}`);
+    }
+}
+async function replaceProjectName(dir, projectName) {
+    const files = await fs_extra_1.default.readdir(dir);
+    for (const file of files) {
+        const filePath = path_1.default.join(dir, file);
+        const stat = await fs_extra_1.default.stat(filePath);
+        if (stat.isDirectory()) {
+            await replaceProjectName(filePath, projectName);
+        }
+        else {
+            if (!isTextFile(filePath))
+                continue;
+            const content = await fs_extra_1.default.readFile(filePath, "utf8");
+            const updated = content.replace(/{{projectName}}/g, projectName);
+            await fs_extra_1.default.writeFile(filePath, updated);
+        }
+    }
+}
+async function installDependencies(targetPath) {
+    console.log("📦 Installing dependencies...");
+    try {
+        await (0, execa_1.execa)("npm", ["install"], { cwd: targetPath, stdio: "inherit" });
+        console.log("✅ Dependencies installed!");
+    }
+    catch (err) {
+        console.log("⚠️ Failed to install dependencies. Run 'npm install' manually.");
+    }
+}
+async function setAuthTabsByPlatform(targetPath, platform) {
+    const navigationPath = path_1.default.join(targetPath, "navigation");
+    const targetTabs = path_1.default.join(navigationPath, "BottomTabs.tsx");
+    const tabSourceImport = platform === "Expo" ? "./expo/BottomTabs" : "./cli/BottomTabs";
+    if (!(await fs_extra_1.default.pathExists(navigationPath)))
+        return;
+    await fs_extra_1.default.writeFile(targetTabs, `export { default } from "${tabSourceImport}";\n`, "utf8");
+}
+async function configureApiClientByPlatform(targetPath, platform) {
+    const configPath = path_1.default.join(targetPath, "config");
+    const envSelectorPath = path_1.default.join(configPath, "env.ts");
+    const envImport = platform === "Expo" ? "./env.expo" : "./env.cli";
+    if (await fs_extra_1.default.pathExists(configPath)) {
+        await fs_extra_1.default.writeFile(envSelectorPath, `export { API_BASE_URL } from "${envImport}";\n`, "utf8");
+    }
+    await ensureApiEnvFiles(targetPath, platform);
+    if (platform === "React Native CLI") {
+        await ensureCliApiEnvSupport(targetPath);
+    }
+}
+async function ensureApiEnvFiles(targetPath, platform) {
+    const key = platform === "Expo" ? "EXPO_PUBLIC_API_URL" : "API_BASE_URL";
+    const envLine = `${key}=https://example.com/api\n`;
+    const envPath = path_1.default.join(targetPath, ".env");
+    const envExamplePath = path_1.default.join(targetPath, ".env.example");
+    if (!(await fs_extra_1.default.pathExists(envPath))) {
+        await fs_extra_1.default.writeFile(envPath, envLine, "utf8");
+    }
+    if (!(await fs_extra_1.default.pathExists(envExamplePath))) {
+        await fs_extra_1.default.writeFile(envExamplePath, envLine, "utf8");
+    }
+}
+async function ensureCliApiEnvSupport(targetPath) {
+    await ensureDependencies(targetPath, {
+        devDependencies: {
+            "react-native-dotenv": "^3.4.11",
+        },
+    });
+}
+async function createStandardStructure(targetPath) {
+    const directories = [
+        "assets",
+        "assets/icons",
+        "assets/images",
+        "assets/fonts",
+        "components",
+        "navigation",
+        "screens",
+        "hooks",
+        "utils",
+        "services",
+    ];
+    for (const directory of directories) {
+        const absoluteDir = path_1.default.join(targetPath, directory);
+        await fs_extra_1.default.ensureDir(absoluteDir);
+        const gitkeepPath = path_1.default.join(absoluteDir, ".gitkeep");
+        if (!(await fs_extra_1.default.pathExists(gitkeepPath))) {
+            await fs_extra_1.default.writeFile(gitkeepPath, "", "utf8");
+        }
+    }
+}
+async function configureAbsoluteImports(targetPath, platform, absoluteImports) {
+    await configureTsconfigAlias(targetPath, absoluteImports);
+    if (platform === "React Native CLI") {
+        if (absoluteImports) {
+            await ensureDependencies(targetPath, {
+                devDependencies: {
+                    "babel-plugin-module-resolver": "^5.0.2",
+                },
+            });
+        }
+        await writeCliBabelConfig(targetPath, {
+            useDotenv: await usesDotenv(targetPath),
+            useAbsoluteImports: absoluteImports,
+        });
+    }
+}
+async function configureDataFetching(targetPath, dataFetching, apiClient) {
+    if (dataFetching === "React Query") {
+        await ensureDependencies(targetPath, {
+            dependencies: {
+                "@tanstack/react-query": "^5.90.5",
+            },
+        });
+        await writeIfMissing(path_1.default.join(targetPath, "services/queryClient.ts"), `import { QueryClient } from "@tanstack/react-query";
+
+export const queryClient = new QueryClient();
+`);
+    }
+    if (dataFetching === "SWR") {
+        await ensureDependencies(targetPath, {
+            dependencies: {
+                swr: "^2.3.6",
+            },
+        });
+    }
+    if (dataFetching === "Axios") {
+        await ensureDependencies(targetPath, {
+            dependencies: {
+                axios: "^1.12.2",
+            },
+        });
+        await writeIfMissing(path_1.default.join(targetPath, "api/axiosClient.ts"), `import axios from "axios";
+import { API_BASE_URL } from "../config/env";
+
+export const axiosClient = axios.create({
+  baseURL: API_BASE_URL,
+  timeout: 15000,
+});
+`);
+        if (apiClient) {
+            await fs_extra_1.default.writeFile(path_1.default.join(targetPath, "api/client.ts"), `import axios from "axios";
+import { API_BASE_URL } from "../config/env";
+
+export class ApiError extends Error {
+  status: number;
+  data: unknown;
+
+  constructor(status: number, message: string, data: unknown) {
+    super(message);
+    this.name = "ApiError";
+    this.status = status;
+    this.data = data;
+  }
+}
+
+type RequestOptions = {
+  headers?: Record<string, string>;
+  query?: Record<string, string | number | boolean | undefined>;
+  token?: string | null;
+  signal?: AbortSignal;
+};
+
+const client = axios.create({
+  baseURL: API_BASE_URL,
+  timeout: 15000,
+});
+
+function resolveErrorMessage(data: unknown, status: number) {
+  if (
+    typeof data === "object" &&
+    data !== null &&
+    "message" in data &&
+    typeof (data as { message: unknown }).message === "string"
+  ) {
+    return (data as { message: string }).message;
+  }
+  return \`Request failed with status \${status}\`;
+}
+
+async function request<T>(
+  method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE",
+  path: string,
+  body?: unknown,
+  options: RequestOptions = {},
+): Promise<T> {
+  const { headers = {}, query, token, signal } = options;
+  try {
+    const response = await client.request<T>({
+      method,
+      url: path,
+      data: body,
+      params: query,
+      signal,
+      headers: {
+        ...(token ? { Authorization: \`Bearer \${token}\` } : {}),
+        ...headers,
+      },
+    });
+    return response.data;
+  } catch (error) {
+    if (axios.isAxiosError(error)) {
+      const status = error.response?.status ?? 500;
+      const data = error.response?.data ?? null;
+      throw new ApiError(status, resolveErrorMessage(data, status), data);
+    }
+    throw error;
+  }
+}
+
+export const apiClient = {
+  get: <T>(path: string, options?: RequestOptions) =>
+    request<T>("GET", path, undefined, options),
+  post: <T>(path: string, body?: unknown, options?: RequestOptions) =>
+    request<T>("POST", path, body, options),
+  put: <T>(path: string, body?: unknown, options?: RequestOptions) =>
+    request<T>("PUT", path, body, options),
+  patch: <T>(path: string, body?: unknown, options?: RequestOptions) =>
+    request<T>("PATCH", path, body, options),
+  delete: <T>(path: string, options?: RequestOptions) =>
+    request<T>("DELETE", path, undefined, options),
+};
+`, "utf8");
+        }
+    }
+}
+async function configureValidation(targetPath, validation) {
+    const dependencies = {};
+    if (validation.includes("Formik"))
+        dependencies.formik = "^2.4.6";
+    if (validation.includes("React Hook Form"))
+        dependencies["react-hook-form"] = "^7.62.0";
+    if (validation.includes("Yup"))
+        dependencies.yup = "^1.7.0";
+    if (Object.keys(dependencies).length > 0) {
+        await ensureDependencies(targetPath, { dependencies });
+    }
+}
+async function configureTsconfigAlias(targetPath, absoluteImports) {
+    const tsconfigPath = path_1.default.join(targetPath, "tsconfig.json");
+    if (!(await fs_extra_1.default.pathExists(tsconfigPath)))
+        return;
+    const tsconfig = await fs_extra_1.default.readJson(tsconfigPath);
+    tsconfig.compilerOptions = tsconfig.compilerOptions || {};
+    if (absoluteImports) {
+        tsconfig.compilerOptions.baseUrl = ".";
+        tsconfig.compilerOptions.paths = tsconfig.compilerOptions.paths || {};
+        tsconfig.compilerOptions.paths["@/*"] = ["./*"];
+    }
+    else if (tsconfig.compilerOptions.paths) {
+        delete tsconfig.compilerOptions.paths["@/*"];
+        if (Object.keys(tsconfig.compilerOptions.paths).length === 0) {
+            delete tsconfig.compilerOptions.paths;
+        }
+    }
+    await fs_extra_1.default.writeJson(tsconfigPath, tsconfig, { spaces: 2 });
+}
+async function writeCliBabelConfig(targetPath, options) {
+    const babelConfigPath = path_1.default.join(targetPath, "babel.config.js");
+    if (!(await fs_extra_1.default.pathExists(babelConfigPath)))
+        return;
+    const plugins = [];
+    if (options.useDotenv)
+        plugins.push("'module:react-native-dotenv'");
+    if (options.useAbsoluteImports) {
+        plugins.push("['module-resolver', { root: ['./'], alias: { '@': './' } }]");
+    }
+    const pluginsLine = plugins.length > 0 ? `,\n  plugins: [${plugins.join(", ")}]` : "";
+    const content = `module.exports = {\n  presets: ['module:@react-native/babel-preset']${pluginsLine},\n};\n`;
+    await fs_extra_1.default.writeFile(babelConfigPath, content, "utf8");
+}
+async function usesDotenv(targetPath) {
+    const envCliPath = path_1.default.join(targetPath, "config/env.cli.ts");
+    return fs_extra_1.default.pathExists(envCliPath);
+}
+async function ensureDependencies(targetPath, patch) {
+    const packageJsonPath = path_1.default.join(targetPath, "package.json");
+    if (await fs_extra_1.default.pathExists(packageJsonPath)) {
+        const packageJson = await fs_extra_1.default.readJson(packageJsonPath);
+        if (patch.dependencies) {
+            packageJson.dependencies = packageJson.dependencies || {};
+            for (const [pkg, version] of Object.entries(patch.dependencies)) {
+                if (!packageJson.dependencies[pkg]) {
+                    packageJson.dependencies[pkg] = version;
+                }
+            }
+        }
+        if (patch.devDependencies) {
+            packageJson.devDependencies = packageJson.devDependencies || {};
+            for (const [pkg, version] of Object.entries(patch.devDependencies)) {
+                if (!packageJson.devDependencies[pkg]) {
+                    packageJson.devDependencies[pkg] = version;
+                }
+            }
+        }
+        await fs_extra_1.default.writeJson(packageJsonPath, packageJson, { spaces: 2 });
+    }
+}
+async function writeIfMissing(filePath, content) {
+    await fs_extra_1.default.ensureDir(path_1.default.dirname(filePath));
+    if (!(await fs_extra_1.default.pathExists(filePath))) {
+        await fs_extra_1.default.writeFile(filePath, content, "utf8");
+    }
+}
+async function resolveTemplateRoot() {
+    const candidates = [
+        path_1.default.join(__dirname, "../templates"), // ts-node: src/generators -> src/templates
+        path_1.default.join(__dirname, "../../templates"), // built output layouts
+    ];
+    for (const candidate of candidates) {
+        if (await fs_extra_1.default.pathExists(candidate))
+            return candidate;
+    }
+    throw new Error("Template root not found.");
+}
+function shouldCopyPath(src) {
+    const normalized = src.replace(/\\/g, "/");
+    const blockedSegments = [
+        "/.git/",
+        "/node_modules/",
+        "/ios/Pods/",
+        "/android/.gradle/",
+        "/vendor/bundle/",
+    ];
+    if (normalized.endsWith("/.git"))
+        return false;
+    return !blockedSegments.some((segment) => normalized.includes(segment));
+}
+function isTextFile(filePath) {
+    const extension = path_1.default.extname(filePath).toLowerCase();
+    const textExtensions = new Set([
+        ".js",
+        ".jsx",
+        ".ts",
+        ".tsx",
+        ".json",
+        ".md",
+        ".xml",
+        ".gradle",
+        ".properties",
+        ".kt",
+        ".kts",
+        ".swift",
+        ".m",
+        ".mm",
+        ".h",
+        ".java",
+        ".rb",
+        ".plist",
+        ".pbxproj",
+        ".yml",
+        ".yaml",
+        ".txt",
+        ".config",
+        ".lock",
+        ".xcprivacy",
+        ".storyboard",
+    ]);
+    const base = path_1.default.basename(filePath).toLowerCase();
+    return textExtensions.has(extension) || base === "podfile" || base === "gemfile";
+}

package/dist/src/utils/fileUtils.js

@@ -0,0 +1 @@
+"use strict";

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@highbeek/create-rnstarterkit",
+  "version": "1.0.0",
+  "description": "CLI to scaffold production-ready React Native app structures.",
+  "main": "dist/src/generators/appGenerator.js",
+  "bin": {
+    "create-rnstarterkit": "dist/bin/create-rnstarterkit.js"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "prepublishOnly": "npm run build",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "type": "commonjs",
+  "dependencies": {
+    "chalk": "^5.6.2",
+    "commander": "^14.0.3",
+    "execa": "^9.6.1",
+    "fs-extra": "^11.3.3",
+    "inquirer": "^13.2.5"
+  },
+  "devDependencies": {
+    "@types/inquirer": "^9.0.9",
+    "@types/node": "^25.2.3",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.9.3"
+  }
+}