create-rn-folder-structure 1.0.2 → 1.0.3

package/generators/features.js

@@ -0,0 +1,51 @@
+const fs = require("fs");
+const path = require("path");
+
+function write(root, filePath, content) {
+  const fullPath = path.join(root, filePath);
+  fs.mkdirSync(path.dirname(fullPath), { recursive: true });
+  fs.writeFileSync(fullPath, content);
+}
+
+module.exports = function generateFeatures(projectRoot) {
+  console.log("📦 Creating feature folders...");
+
+  // Example features
+  const features = ["auth", "profile", "dashboard", "settings"];
+
+  features.forEach((feature) => {
+    write(
+      projectRoot,
+      `src/features/${feature}/screens/${capitalize(feature)}Screen.tsx`,
+      `
+import { View, Text } from "react-native";
+
+export default function ${capitalize(feature)}Screen() {
+  return (
+    <View>
+      <Text>${capitalize(feature)} Screen</Text>
+    </View>
+  );
+}
+`
+    );
+
+    write(
+      projectRoot,
+      `src/features/${feature}/store/index.ts`,
+      `export default {};`
+    );
+
+    write(
+      projectRoot,
+      `src/features/${feature}/api/index.ts`,
+      `// API calls for ${feature}`
+    );
+  });
+
+  console.log("✅ Features created successfully!");
+};
+
+function capitalize(str) {
+  return str.charAt(0).toUpperCase() + str.slice(1);
+}

package/generators/helpers.js

@@ -0,0 +1,195 @@
+const fs = require("fs");
+const path = require("path");
+
+function write(root, filePath, content) {
+  const out = path.join(root, filePath);
+  fs.mkdirSync(path.dirname(out), { recursive: true });
+  fs.writeFileSync(out, content);
+}
+
+module.exports = function generateHelpers(projectRoot) {
+  console.log("🛠 Creating Helper Modules...");
+
+  const base = "src/shared/helpers";
+
+  // --------------------------------------------------------------
+  // DATE HELPERS
+  // --------------------------------------------------------------
+  write(
+    projectRoot,
+    `${base}/date.ts`,
+    `
+export const formatDate = (date: Date, format = "DD/MM/YYYY") => {
+  const d = date.getDate().toString().padStart(2, "0");
+  const m = (date.getMonth() + 1).toString().padStart(2, "0");
+  const y = date.getFullYear();
+
+  return format
+    .replace("DD", d)
+    .replace("MM", m)
+    .replace("YYYY", y.toString());
+};
+
+export const timeAgo = (date: string | number | Date) => {
+  const diff = Date.now() - new Date(date).getTime();
+  const sec = Math.floor(diff / 1000);
+  if (sec < 60) return \`\${sec}s ago\`;
+  const min = Math.floor(sec / 60);
+  if (min < 60) return \`\${min}m ago\`;
+  const hr = Math.floor(min / 60);
+  if (hr < 24) return \`\${hr}h ago\`;
+  const days = Math.floor(hr / 24);
+  return \`\${days}d ago\`;
+};
+
+export const getToday = () => new Date();
+
+export const isSameDay = (d1: Date, d2: Date) =>
+  d1.getFullYear() === d2.getFullYear() &&
+  d1.getMonth() === d2.getMonth() &&
+  d1.getDate() === d2.getDate();
+`
+  );
+
+  // --------------------------------------------------------------
+  // NUMBER HELPERS
+  // --------------------------------------------------------------
+  write(
+    projectRoot,
+    `${base}/number.ts`,
+    `
+export const formatNumber = (num: number) =>
+  new Intl.NumberFormat().format(num);
+
+export const toCurrency = (num: number, currency = "USD") =>
+  new Intl.NumberFormat("en-US", {
+    style: "currency",
+    currency,
+  }).format(num);
+
+export const randomNumber = (min: number, max: number) =>
+  Math.floor(Math.random() * (max - min + 1)) + min;
+`
+  );
+
+  // --------------------------------------------------------------
+  // VALIDATION HELPERS
+  // --------------------------------------------------------------
+  write(
+    projectRoot,
+    `${base}/validation.ts`,
+    `
+export const isEmail = (str: string) =>
+  /^[\\w-.]+@([\\w-]+\\.)+[\\w-]{2,4}$/.test(str);
+
+export const isPhone = (str: string) =>
+  /^[0-9]{10}$/.test(str);
+
+export const isEmpty = (value: any) =>
+  value === null || value === undefined || value === "";
+
+export const isStrongPassword = (str: string) =>
+  /^(?=.*[A-Z])(?=.*[a-z])(?=.*\\d).{8,}$/.test(str);
+`
+  );
+
+  // --------------------------------------------------------------
+  // FUNCTION HELPERS (DEBOUNCE, THROTTLE)
+  // --------------------------------------------------------------
+  write(
+    projectRoot,
+    `${base}/functions.ts`,
+    `
+export const debounce = (fn: Function, delay = 300) => {
+  let timer: any;
+  return (...args: any[]) => {
+    clearTimeout(timer);
+    timer = setTimeout(() => fn(...args), delay);
+  };
+};
+
+export const throttle = (fn: Function, limit = 300) => {
+  let lastCall = 0;
+  return (...args: any[]) => {
+    const now = Date.now();
+    if (now - lastCall >= limit) {
+      lastCall = now;
+      fn(...args);
+    }
+  };
+};
+`
+  );
+
+  // --------------------------------------------------------------
+  // ASYNC HELPERS
+  // --------------------------------------------------------------
+  write(
+    projectRoot,
+    `${base}/async.ts`,
+    `
+export const wait = (ms: number) =>
+  new Promise((res) => setTimeout(res, ms));
+
+export const retry = async (fn: Function, attempts = 3) => {
+  for (let i = 0; i < attempts; i++) {
+    try {
+      return await fn();
+    } catch (err) {
+      if (i === attempts - 1) throw err;
+    }
+  }
+};
+
+export const timeoutPromise = (promise: Promise<any>, ms: number) =>
+  Promise.race([
+    promise,
+    new Promise((_, reject) =>
+      setTimeout(() => reject(new Error("Timeout exceeded")), ms)
+    ),
+  ]);
+`
+  );
+
+  // --------------------------------------------------------------
+  // LOGGER HELPERS
+  // --------------------------------------------------------------
+  write(
+    projectRoot,
+    `${base}/logger.ts`,
+    `
+export const debugLog = (...args: any[]) => {
+  if (__DEV__) console.log("🐛 DEBUG:", ...args);
+};
+
+export const warnLog = (...args: any[]) => {
+  if (__DEV__) console.warn("⚠️ WARNING:", ...args);
+};
+
+export const errorLog = (...args: any[]) => {
+  console.error("❌ ERROR:", ...args);
+};
+`
+  );
+
+  // --------------------------------------------------------------
+  // DEVICE HELPERS
+  // --------------------------------------------------------------
+  write(
+    projectRoot,
+    `${base}/device.ts`,
+    `
+import { Platform, Dimensions } from "react-native";
+
+const { width, height } = Dimensions.get("window");
+
+export const isAndroid = Platform.OS === "android";
+export const isIOS = Platform.OS === "ios";
+export const screenWidth = width;
+export const screenHeight = height;
+export const isSmallDevice = width < 360;
+`
+  );
+
+  console.log("✅ Helper Modules Created (renamed from utils)!");
+};

package/generators/hooks.js

@@ -0,0 +1,239 @@
+const fs = require("fs");
+const path = require("path");
+
+function write(root, filePath, content) {
+  const fullPath = path.join(root, filePath);
+  fs.mkdirSync(path.dirname(fullPath), { recursive: true });
+  fs.writeFileSync(fullPath, content);
+}
+
+module.exports = function generateHooks(projectRoot) {
+  console.log("🪝 Creating custom hooks...");
+
+  const base = "src/shared/hooks";
+
+  // ---------------------------------------------------------
+  // useApi Hook
+  // ---------------------------------------------------------
+  write(
+    projectRoot,
+    `${base}/useApi.ts`,
+    `
+import { useState } from "react";
+import axiosInstance from "../../services/api/axiosInstance";
+
+export default function useApi() {
+  const [loading, setLoading] = useState(false);
+  const [error, setError] = useState<string | null>(null);
+
+  const request = async (method: string, url: string, data?: any, config?: any) => {
+    try {
+      setLoading(true);
+      setError(null);
+
+      const response = await axiosInstance({
+        method,
+        url,
+        data,
+        ...config,
+      });
+
+      return response.data;
+    } catch (err: any) {
+      setError(err?.response?.data?.message || "Something went wrong");
+      return null;
+    } finally {
+      setLoading(false);
+    }
+  };
+
+  return { request, loading, error };
+}
+`
+  );
+
+  // ---------------------------------------------------------
+  // useAuth Hook
+  // ---------------------------------------------------------
+  write(
+    projectRoot,
+    `${base}/useAuth.ts`,
+    `
+import { useState, useEffect } from "react";
+import AsyncStorage from "@react-native-async-storage/async-storage";
+
+export default function useAuth() {
+  const [token, setToken] = useState<string | null>(null);
+
+  useEffect(() => {
+    loadToken();
+  }, []);
+
+  const loadToken = async () => {
+    const saved = await AsyncStorage.getItem("token");
+    if (saved) setToken(saved);
+  };
+
+  const login = async (newToken: string) => {
+    await AsyncStorage.setItem("token", newToken);
+    setToken(newToken);
+  };
+
+  const logout = async () => {
+    await AsyncStorage.removeItem("token");
+    setToken(null);
+  };
+
+  return { token, login, logout, isLoggedIn: !!token };
+}
+`
+  );
+
+  // ---------------------------------------------------------
+  // useLoader Hook
+  // ---------------------------------------------------------
+  write(
+    projectRoot,
+    `${base}/useLoader.ts`,
+    `
+import { useState } from "react";
+
+export default function useLoader() {
+  const [loading, setLoading] = useState(false);
+
+  const show = () => setLoading(true);
+  const hide = () => setLoading(false);
+
+  return { loading, show, hide };
+}
+`
+  );
+
+  // ---------------------------------------------------------
+  // useDebounce Hook
+  // ---------------------------------------------------------
+  write(
+    projectRoot,
+    `${base}/useDebounce.ts`,
+    `
+import { useEffect, useState } from "react";
+
+export default function useDebounce(value: any, delay: number = 500) {
+  const [debouncedValue, setDebouncedValue] = useState(value);
+
+  useEffect(() => {
+    const timer = setTimeout(() => setDebouncedValue(value), delay);
+    return () => clearTimeout(timer);
+  }, [value]);
+
+  return debouncedValue;
+}
+`
+  );
+
+  // ---------------------------------------------------------
+  // useOnlineStatus Hook
+  // ---------------------------------------------------------
+  write(
+    projectRoot,
+    `${base}/useOnlineStatus.ts`,
+    `
+import { useEffect, useState } from "react";
+import NetInfo from "@react-native-community/netinfo";
+
+export default function useOnlineStatus() {
+  const [online, setOnline] = useState(true);
+
+  useEffect(() => {
+    const unsubscribe = NetInfo.addEventListener(state => {
+      setOnline(state.isConnected ?? true);
+    });
+
+    return () => unsubscribe();
+  }, []);
+
+  return online;
+}
+`
+  );
+
+  // ---------------------------------------------------------
+  // useModal Hook
+  // ---------------------------------------------------------
+  write(
+    projectRoot,
+    `${base}/useModal.ts`,
+    `
+import { useState } from "react";
+
+export default function useModal() {
+  const [visible, setVisible] = useState(false);
+
+  const open = () => setVisible(true);
+  const close = () => setVisible(false);
+
+  return { visible, open, close };
+}
+`
+  );
+
+  // ---------------------------------------------------------
+  // usePagination Hook
+  // ---------------------------------------------------------
+  write(
+    projectRoot,
+    `${base}/usePagination.ts`,
+    `
+import { useState } from "react";
+
+export default function usePagination(initialPage: number = 1) {
+  const [page, setPage] = useState(initialPage);
+
+  const next = () => setPage(p => p + 1);
+  const prev = () => setPage(p => (p > 1 ? p - 1 : 1));
+  const reset = () => setPage(1);
+
+  return { page, next, prev, reset };
+}
+`
+  );
+
+  // ---------------------------------------------------------
+  // useStorage Hook
+  // ---------------------------------------------------------
+  write(
+    projectRoot,
+    `${base}/useStorage.ts`,
+    `
+import { useEffect, useState } from "react";
+import AsyncStorage from "@react-native-async-storage/async-storage";
+
+export default function useStorage(key: string, initialValue: any = null) {
+  const [value, setValue] = useState(initialValue);
+
+  useEffect(() => {
+    load();
+  }, []);
+
+  const load = async () => {
+    const saved = await AsyncStorage.getItem(key);
+    if (saved) setValue(JSON.parse(saved));
+  };
+
+  const save = async (val: any) => {
+    setValue(val);
+    await AsyncStorage.setItem(key, JSON.stringify(val));
+  };
+
+  const remove = async () => {
+    setValue(null);
+    await AsyncStorage.removeItem(key);
+  };
+
+  return { value, save, remove };
+}
+`
+  );
+
+  console.log("✅ Hooks created successfully!");
+};

package/generators/navigation.js

@@ -0,0 +1,138 @@
+const fs = require("fs");
+const path = require("path");
+
+function createFile(root, filePath, content = "") {
+  const fullPath = path.join(root, filePath);
+  fs.mkdirSync(path.dirname(fullPath), { recursive: true });
+  fs.writeFileSync(fullPath, content);
+}
+
+module.exports = function generateNavigation(projectRoot) {
+  console.log("📌 Creating Navigation Structure...");
+
+  const navBase = "src/app/navigation";
+
+  // ---------------------------------------------------------
+  // RootNavigator.tsx
+  // ---------------------------------------------------------
+  createFile(
+    projectRoot,
+    `${navBase}/RootNavigator.tsx`,
+    `
+import React, { useEffect, useState } from "react";
+import { NavigationContainer } from "@react-navigation/native";
+import AuthStack from "./stacks/AuthStack";
+import AppStack from "./stacks/AppStack";
+import { getToken } from "../../services/storage/token";
+
+export default function RootNavigator() {
+  const [loading, setLoading] = useState(true);
+  const [isLoggedIn, setLoggedIn] = useState(false);
+
+  useEffect(() => {
+    const init = async () => {
+      const token = await getToken();
+      setLoggedIn(!!token);
+      setLoading(false);
+    };
+    init();
+  }, []);
+
+  if (loading) return null;
+
+  return (
+    <NavigationContainer>
+      {isLoggedIn ? <AppStack /> : <AuthStack />}
+    </NavigationContainer>
+  );
+}
+`
+  );
+
+  // ---------------------------------------------------------
+  // Auth Stack
+  // ---------------------------------------------------------
+  createFile(
+    projectRoot,
+    `${navBase}/stacks/AuthStack.tsx`,
+    `
+import React from "react";
+import { createNativeStackNavigator } from "@react-navigation/native-stack";
+
+import LoginScreen from "../../features/auth/screens/LoginScreen";
+import RegisterScreen from "../../features/auth/screens/RegisterScreen";
+import ForgotPasswordScreen from "../../features/auth/screens/ForgotPasswordScreen";
+
+const Stack = createNativeStackNavigator();
+
+export default function AuthStack() {
+  return (
+    <Stack.Navigator screenOptions={{ headerShown: false }}>
+      <Stack.Screen name="Login" component={LoginScreen} />
+      <Stack.Screen name="Register" component={RegisterScreen} />
+      <Stack.Screen name="ForgotPassword" component={ForgotPasswordScreen} />
+    </Stack.Navigator>
+  );
+}
+`
+  );
+
+  // ---------------------------------------------------------
+  // App Stack (Dashboard + other features)
+  // ---------------------------------------------------------
+  createFile(
+    projectRoot,
+    `${navBase}/stacks/AppStack.tsx`,
+    `
+import React from "react";
+import { createNativeStackNavigator } from "@react-navigation/native-stack";
+
+import DashboardScreen from "../../features/dashboard/screens/DashboardScreen";
+import HomeScreen from "../../features/home/screens/HomeScreen";
+import ProfileScreen from "../../features/profile/screens/ProfileScreen";
+import SettingsScreen from "../../features/settings/screens/SettingsScreen";
+import NotificationsScreen from "../../features/notifications/screens/NotificationsScreen";
+
+const Stack = createNativeStackNavigator();
+
+export default function AppStack() {
+  return (
+    <Stack.Navigator screenOptions={{ headerShown: false }}>
+      <Stack.Screen name="Dashboard" component={DashboardScreen} />
+      <Stack.Screen name="Home" component={HomeScreen} />
+      <Stack.Screen name="Profile" component={ProfileScreen} />
+      <Stack.Screen name="Settings" component={SettingsScreen} />
+      <Stack.Screen name="Notifications" component={NotificationsScreen} />
+    </Stack.Navigator>
+  );
+}
+`
+  );
+
+  // ---------------------------------------------------------
+  // Example Dashboard Screen
+  // ---------------------------------------------------------
+  createFile(
+    projectRoot,
+    `src/features/dashboard/screens/DashboardScreen.tsx`,
+    `
+import React from "react";
+import { View, Text, StyleSheet } from "react-native";
+
+export default function DashboardScreen() {
+  return (
+    <View style={styles.container}>
+      <Text style={styles.title}>Dashboard</Text>
+    </View>
+  );
+}
+
+const styles = StyleSheet.create({
+  container: { flex: 1, justifyContent: "center", alignItems: "center" },
+  title: { fontSize: 26, fontWeight: "bold" }
+});
+`
+  );
+
+  console.log("✅ Navigation setup completed.");
+};

package/generators/readme.js

@@ -0,0 +1,51 @@
+const fs = require("fs");
+const path = require("path");
+
+module.exports = function generateReadme(projectRoot) {
+  console.log("📘 Creating README...");
+
+  const content = `
+# React Native Project Structure Generator
+
+This project was automatically generated using **create-rn-folder-structure**.
+
+## 📁 Folder Structure
+
+\`\`\`
+src/
+ ├── app/
+ │    ├── navigation/
+ │    └── store/
+ ├── features/
+ │    ├── auth/
+ │    ├── profile/
+ │    ├── dashboard/
+ │    └── settings/
+ ├── shared/
+ │    ├── components/
+ │    ├── constants/
+ │    ├── custom-hooks/
+ │    └── utils/
+ ├── services/
+ │    ├── api/
+ │    └── storage/
+\`\`\`
+
+## 🚀 Generated Modules
+
+- Feature screens + API + Store
+- Shared UI Components
+- Custom Hooks
+- Constants
+- Centralized API setup
+- Async storage helpers
+
+---
+
+Generated with ❤️ using **create-rn-folder-structure**
+`;
+
+  fs.writeFileSync(path.join(projectRoot, "README.md"), content);
+
+  console.log("✅ README created successfully!");
+};