astrod-cli 1.0.0

package/README.md

@@ -0,0 +1,66 @@
+# astrod-cli
+
+A CLI tool that injects pre-defined folder structures into existing **Vite**, **Next**, and **React Native** projects.
+
+## Installation
+
+Install the package globally or use it directly with `npx`.
+
+```bash
+npm install -g astrod-cli
+```
+
+Or run without installation:
+
+```bash
+npx astrod-cli init
+```
+
+## Usage
+
+Navigate to your project's root directory and run:
+
+```bash
+astrod init
+```
+
+### Options
+
+- `-f, --force`: Overwrite the existing `src/` directory if it exists.
+- `-d, --dry-run`: List the files and folders that would be created without actually creating them.
+
+## Supported Frameworks
+
+The tool automatically detects the project framework by checking your `package.json` dependencies:
+
+- **Vite**
+- **Next.js**
+- **React Native**
+
+## Structure Types
+
+You can choose between two types of folder structures:
+
+### 1. Open Structure (Standard)
+A traditional flat structure for smaller projects.
+
+- **Vite**: `src/components`, `src/pages`, `src/hooks`, `src/utils`
+- **Next**: `src/app`, `src/components`, `src/lib`
+- **React Native**: `src/components`, `src/screens`, `src/navigation`
+
+### 2. Module-based (Feature-driven)
+A modular structure ideal for large-scale applications.
+
+- **Vite**: `src/modules`, `src/shared/components`, `src/shared/hooks`, `src/shared/utils`
+- **Next**: `src/app`, `src/modules`, `src/shared/components`, `src/shared/lib`
+- **React Native**: `src/modules`, `src/shared/components`, `src/shared/navigation`
+
+## Requirements
+
+- Node.js (v14 or higher)
+- A project with a `package.json` file.
+- ES Modules enabled (`"type": "module"` in your project's `package.json` is recommended but not required for the target project).
+
+## License
+
+ISC

package/bin/cli.js

@@ -0,0 +1,112 @@
+#!/usr/bin/env node
+
+import { Command } from 'commander';
+import fs from 'fs-extra';
+import inquirer from 'inquirer';
+import path from 'path';
+import { fileURLToPath } from 'url';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+const program = new Command();
+
+async function detectFramework() {
+  const pkgPath = path.join(process.cwd(), 'package.json');
+  if (!fs.existsSync(pkgPath)) {
+    return null;
+  }
+
+  const pkg = await fs.readJson(pkgPath);
+  const deps = { ...pkg.dependencies, ...pkg.devDependencies };
+
+  if (deps['next']) return 'next';
+  if (deps['vite']) return 'vite';
+  if (deps['react-native']) return 'react-native';
+
+  return null;
+}
+
+async function listFiles(dir, baseDir = '') {
+  const files = await fs.readdir(dir);
+  let results = [];
+
+  for (const file of files) {
+    const fullPath = path.join(dir, file);
+    const relativePath = path.join(baseDir, file);
+    const stat = await fs.stat(fullPath);
+
+    if (stat.isDirectory()) {
+      results = results.concat(await listFiles(fullPath, relativePath));
+    } else {
+      results.push(relativePath);
+    }
+  }
+
+  return results;
+}
+
+program
+  .name('my-struct')
+  .description('CLI to inject folder structures into Vite, Next, and React Native projects')
+  .version('1.0.0');
+
+program
+  .command('init')
+  .description('Initialize the folder structure')
+  .option('-f, --force', 'Overwrite existing src directory')
+  .option('-d, --dry-run', 'List files that would be created without actually creating them')
+  .action(async (options) => {
+    try {
+      const framework = await detectFramework();
+
+      if (!framework) {
+        console.error('\x1b[31mError: No supported framework (Vite, Next, or React Native) detected in package.json.\x1b[0m');
+        process.exit(1);
+      }
+
+      console.log(`\x1b[34mDetected framework: ${framework}\x1b[0m`);
+
+      const { structureType } = await inquirer.prompt([
+        {
+          type: 'list',
+          name: 'structureType',
+          message: 'Which folder structure would you like to use?',
+          choices: [
+            { name: 'Open Structure (Standard)', value: 'open' },
+            { name: 'Module-based (Feature-driven)', value: 'module' }
+          ]
+        }
+      ]);
+
+      const templateDir = path.join(__dirname, '..', 'templates', framework, structureType, 'src');
+      const targetDir = path.join(process.cwd(), 'src');
+
+      if (options.dryRun) {
+        console.log('\x1b[33m--- Dry Run: The following files would be created ---\x1b[0m');
+        const files = await listFiles(templateDir);
+        files.forEach(file => {
+          console.log(`src/${file}`);
+        });
+        return;
+      }
+
+      if (fs.existsSync(targetDir) && !options.force) {
+        console.warn('\x1b[33mWarning: The "src" directory already exists. Use --force to overwrite.\x1b[0m');
+        process.exit(1);
+      }
+
+      await fs.copy(templateDir, targetDir, {
+        overwrite: options.force,
+        errorOnExist: !options.force
+      });
+
+      console.log(`\x1b[32mSuccessfully injected ${structureType} structure for ${framework} into src/ folder!\x1b[0m`);
+
+    } catch (error) {
+      console.error('\x1b[31mAn error occurred:\x1b[0m', error.message);
+      process.exit(1);
+    }
+  });
+
+program.parse(process.argv);

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "astrod-cli",
+  "version": "1.0.0",
+  "description": "A CLI tool that injects folder structures into existing Vite, Next, and React Native projects.",
+  "type": "module",
+  "main": "./bin/cli.js",
+  "bin": {
+    "astrod": "./bin/cli.js"
+  },
+  "files": [
+    "bin",
+    "templates",
+    "README.md"
+  ],
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "cli",
+    "folder-structure",
+    "vite",
+    "next",
+    "react-native"
+  ],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "commander": "^11.1.0",
+    "fs-extra": "^11.2.0",
+    "inquirer": "^9.2.12",
+    "path": "^0.12.7"
+  }
+}