create-react-folder-structure 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright Amol Mahor (c) 2026
+
+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,76 @@
+# create-react-folder-structure 🚀
+
+[![npm version](https://img.shields.io/npm/v/create-react-folder-structure.svg)](https://www.npmjs.com/package/create-react-folder-structure)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+> **All-in-One Command**: Initializes a fresh **Vite + React + Tailwind + Shadcn UI** project and automatically scaffolds a clean, scalable folder structure with zero component clutter.
+
+---
+
+## ⚡ One Single Command
+
+To initialize a new project and scaffold all folders in one step:
+
+```bash
+npx create-react-folder-structure my-app
+```
+
+or run inside an empty directory:
+
+```bash
+npx create-react-folder-structure .
+```
+
+---
+
+## 🛠️ What This Single Command Does
+
+1. **Initializes Shadcn UI + Vite**:
+   Automatically runs `shadcn@latest init --preset b0 --template vite` (sets up Vite, TypeScript, Tailwind CSS, and Shadcn configuration).
+2. **Generates Pure Folder Structure**:
+   Instantly creates your clean architecture folders inside `src/`—**folders only**, with no dummy components or unwanted files!
+
+---
+
+## 📂 Generated Structure (Directories Only)
+
+```text
+src/
+├── components/
+│   ├── shared/           # Business-specific shared components
+│   └── ui/               # Where shadcn places button.tsx, dialog.tsx, etc.
+├── layouts/              # Layout containers (Sidebar, Header, MainLayout)
+├── pages/                # Clean, empty pages folder
+├── routes/               # Routing configs
+├── hooks/                # Custom React hooks
+├── services/             # API clients & backend communication
+├── contexts/             # Global React state providers
+├── constants/            # Static enums, endpoints, role IDs
+├── types/                # TypeScript interfaces and domain models
+├── utils/                # Utility functions and date/formatting helpers
+└── validation/           # Schema validation (Zod, Yup, etc.)
+```
+
+---
+
+## ⚙️ Options & CLI Flags
+
+| Command / Flag | Description |
+| :--- | :--- |
+| `npx create-react-folder-structure [name]` | Full setup: Init Shadcn Vite + scaffold folders *(Default)* |
+| `--folders-only` | Skip Shadcn init; only scaffold folders in an existing project |
+| `--minimal` | Minimal folders (`components`, `pages`, `hooks`, `services`, `utils`, `validation`) |
+| `-h`, `--help` | Show command help and documentation |
+| `-v`, `--version` | Show package version |
+
+---
+
+## 🔒 Non-Destructive Guarantee
+
+Safe to run in existing projects. Existing files and directories will **never** be overwritten.
+
+---
+
+## 📄 License
+
+MIT © Amol Mahor 2026

package/bin/cli.js

@@ -0,0 +1,178 @@
+#!/usr/bin/env node
+
+import fs from 'fs';
+import path from 'path';
+import { spawnSync } from 'child_process';
+
+// ANSI terminal colors
+const colors = {
+  reset: '\x1b[0m',
+  bright: '\x1b[1m',
+  dim: '\x1b[2m',
+  cyan: '\x1b[36m',
+  green: '\x1b[32m',
+  yellow: '\x1b[33m',
+  red: '\x1b[31m',
+};
+
+const rawArgs = process.argv.slice(2);
+
+// Handle --help or -h
+if (rawArgs.includes('--help') || rawArgs.includes('-h')) {
+  console.log(`
+${colors.bright}${colors.cyan}create-react-folder-structure${colors.reset} - All-in-One Vite + Shadcn + Folder Structure Scaffolder
+
+${colors.bright}DESCRIPTION:${colors.reset}
+  Runs in ONE single command:
+  1. Initializes a fresh Vite + React + Tailwind project with Shadcn UI (--preset b0)
+  2. Scaffolds a clean, production-grade folder structure (folders only, zero component clutter)
+
+${colors.bright}USAGE:${colors.reset}
+  npx create-react-folder-structure [project-name] [options]
+  npx react-folder-structure [project-name] [options]
+
+${colors.bright}EXAMPLES:${colors.reset}
+  # Create a new project from scratch (runs Shadcn init + Folder structure):
+  npx create-react-folder-structure my-app
+
+  # Run inside an empty folder:
+  npx create-react-folder-structure .
+
+  # Only scaffold folders in an existing project (skip Shadcn init):
+  npx create-react-folder-structure --folders-only
+
+${colors.bright}OPTIONS:${colors.reset}
+  --folders-only   Skip Shadcn initialization; only generate the folder structure
+  --minimal        Create minimal folders (components, pages, hooks, services, utils, validation)
+  --full           Create full enterprise folders (Default)
+  -h, --help       Display this help message
+  -v, --version    Show current package version
+`);
+  process.exit(0);
+}
+
+// Handle --version or -v
+if (rawArgs.includes('--version') || rawArgs.includes('-v')) {
+  const pkgPath = path.resolve(path.dirname(new URL(import.meta.url).pathname.replace(/^\/([A-Za-z]:)/, '$1')), '../package.json');
+  try {
+    const pkg = JSON.parse(fs.readFileSync(pkgPath, 'utf8'));
+    console.log(`v${pkg.version}`);
+  } catch {
+    console.log('v1.0.0');
+  }
+  process.exit(0);
+}
+
+const cwd = process.cwd();
+const isFoldersOnly = rawArgs.includes('--folders-only');
+const isMinimal = rawArgs.includes('--minimal');
+
+// Extract project name if provided
+const nonFlagArgs = rawArgs.filter((arg) => !arg.startsWith('-'));
+const projectName = nonFlagArgs[0];
+
+let targetProjectDir = cwd;
+if (projectName && projectName !== '.') {
+  targetProjectDir = path.resolve(cwd, projectName);
+  if (!fs.existsSync(targetProjectDir)) {
+    fs.mkdirSync(targetProjectDir, { recursive: true });
+  }
+}
+
+const hasPackageJson = fs.existsSync(path.join(targetProjectDir, 'package.json'));
+const shouldInitShadcn = !isFoldersOnly && (!hasPackageJson || rawArgs.includes('--init'));
+
+console.log(`
+${colors.bright}${colors.cyan}================================================================${colors.reset}
+  ${colors.bright}🚀 All-in-One Vite + Shadcn + React Folder Structure Creator${colors.reset}
+  Target: ${colors.green}${path.relative(cwd, targetProjectDir) || '.'}/${colors.reset}
+${colors.bright}${colors.cyan}================================================================${colors.reset}
+`);
+
+// -------------------------------------------------------------
+// STEP 1: Initialize Shadcn UI + Vite (--preset b0)
+// -------------------------------------------------------------
+if (shouldInitShadcn) {
+  console.log(`${colors.bright}📦 Step 1/2: Initializing project with Shadcn UI & Vite (--preset b0)...${colors.reset}\n`);
+
+  const shadcnArgs = ['-y', 'shadcn@latest', 'init', '--preset', 'b0', '--template', 'vite', '-y'];
+
+  const initResult = spawnSync('npx', shadcnArgs, {
+    cwd: targetProjectDir,
+    stdio: 'inherit',
+    shell: true,
+  });
+
+  if (initResult.status !== 0) {
+    console.error(`\n${colors.red}❌ Failed to initialize project with Shadcn UI.${colors.reset}`);
+    process.exit(initResult.status || 1);
+  }
+
+  console.log(`\n${colors.green}✔ Step 1 complete: Shadcn + Vite project initialized!${colors.reset}\n`);
+} else {
+  console.log(`${colors.dim}↷ Step 1 skipped: Existing project detected (or --folders-only passed).${colors.reset}\n`);
+}
+
+// -------------------------------------------------------------
+// STEP 2: Scaffold Pure Folder Structure (No Dummy Components)
+// -------------------------------------------------------------
+console.log(`${colors.bright}📁 Step 2/2: Scaffolding Folder Structure...${colors.reset}`);
+
+let targetBaseDir = targetProjectDir;
+const srcDir = path.join(targetProjectDir, 'src');
+
+if (fs.existsSync(srcDir)) {
+  targetBaseDir = srcDir;
+} else if (path.basename(targetProjectDir) !== 'src') {
+  fs.mkdirSync(srcDir, { recursive: true });
+  targetBaseDir = srcDir;
+}
+
+const standardFolders = [
+  'components/shared',
+  'layouts',
+  'pages',
+  'routes',
+  'hooks',
+  'services',
+  'contexts',
+  'constants',
+  'types',
+  'utils',
+  'validation',
+];
+
+const minimalFolders = [
+  'components',
+  'pages',
+  'hooks',
+  'services',
+  'utils',
+  'validation',
+];
+
+const foldersToCreate = isMinimal ? minimalFolders : standardFolders;
+
+let createdFoldersCount = 0;
+let skippedFoldersCount = 0;
+
+for (const folder of foldersToCreate) {
+  const fullPath = path.join(targetBaseDir, folder);
+  if (!fs.existsSync(fullPath)) {
+    fs.mkdirSync(fullPath, { recursive: true });
+    console.log(`  ${colors.green}✔ Created:${colors.reset} src/${folder}/`);
+    createdFoldersCount++;
+  } else {
+    skippedFoldersCount++;
+  }
+}
+
+console.log(`
+${colors.bright}${colors.green}🎉 Done! Your project is completely configured & ready!${colors.reset}
+  • Shadcn UI + Vite: ${colors.green}Initialized (--preset b0)${colors.reset}
+  • Folder Structure: ${colors.green}${createdFoldersCount} created${colors.reset}, ${skippedFoldersCount} existed
+  • Files:            ${colors.dim}0 files created (folders only)${colors.reset}
+
+${colors.bright}To get started:${colors.reset}
+${projectName && projectName !== '.' ? `  cd ${projectName}\n` : ''}  npm run dev
+`);

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "create-react-folder-structure",
+  "version": "1.0.0",
+  "description": "CLI to scaffold a clean, production-ready React folder structure with zero component clutter",
+  "main": "bin/cli.js",
+  "type": "module",
+  "bin": {
+    "create-react-folder-structure": "bin/cli.js",
+    "react-folder-structure": "bin/cli.js"
+  },
+  "keywords": [
+    "react",
+    "vite",
+    "shadcn",
+    "folder-structure",
+    "scaffold",
+    "cli"
+  ],
+  "author": "Amol Mahor",
+  "license": "MIT",
+  "files": [
+    "bin",
+    "README.md",
+    "LICENSE"
+  ],
+  "engines": {
+    "node": ">=16.0.0"
+  }
+}