andrud 1.0.0

package/README.md

@@ -0,0 +1,310 @@
+# andrud
+
+<p align="center">
+  <img src="https://img.shields.io/npm/v/@andrud/cli?style=for-the-badge&color=%2300C9FF&labelColor=%23222" alt="npm version">
+  <img src="https://img.shields.io/npm/dm/@andrud/cli?style=for-the-badge&color=%2392FE9D&labelColor=%23222" alt="npm downloads">
+  <img src="https://img.shields.io/github/license/MurShidM01/andrud?style=for-the-badge&color=%23ff6b6b&labelColor=%23222" alt="license">
+  <img src="https://img.shields.io/github/stars/MurShidM01/andrud?style=for-the-badge&color=%23ffd93d&labelColor=%23222" alt="stars">
+  <img src="https://img.shields.io/github/forks/MurShidM01/andrud?style=for-the-badge&color=%236bcb77&labelColor=%23222" alt="forks">
+</p>
+
+<p align="center">
+  <img src="https://img.shields.io/badge/Node.js-18+-green?style=for-the-badge&logo=node.js&logoColor=white" alt="node">
+  <img src="https://img.shields.io/badge/TypeScript-5.4-blue?style=for-the-badge&logo=typescript&logoColor=white" alt="typescript">
+  <img src="https://img.shields.io/badge/Android-Studio-3DDC84?style=for-the-badge&logo=android&logoColor=white" alt="android">
+  <img src="https://img.shields.io/badge/Kotlin-7F52FF?style=for-the-badge&logo=kotlin&logoColor=white" alt="kotlin">
+</p>
+
+<h1 align="center">⚡ Modern Android Project Scaffolding CLI</h1>
+
+<p align="center">
+  <strong>andrud</strong> is a blazing-fast, interactive CLI tool for generating production-ready Android project structures in seconds. Built for developers who value speed, consistency, and modern Android development practices.
+</p>
+
+<p align="center">
+  <img src="https://i.imgur.com/example.gif" width="600" alt="andrud demo">
+</p>
+
+---
+
+## ✨ Features
+
+| Feature | Description |
+|---------|-------------|
+| 🚀 **Blazing Fast** | Generate complete Android projects in under 5 seconds |
+| 🎨 **Multiple Templates** | Kotlin, Java, Jetpack Compose, Native C++/NDK support |
+| 💎 **Interactive CLI** | Beautiful prompts powered by @clack/prompts |
+| 📦 **Production Ready** | Industry-standard Gradle configuration with latest versions |
+| 🎯 **TypeScript** | Fully typed codebase for reliability |
+| 🔧 **Customizable** | Configure SDK versions, features, and more |
+| 📱 **Modern Android** | Android 15 (SDK 35/36) with Jetpack libraries |
+| 🌙 **Beautiful UI** | Colorful terminal output with gradients |
+
+---
+
+## 📋 Templates
+
+| Template | Language | UI Framework | Use Case |
+|----------|----------|--------------|----------|
+| `kotlin-xml` | Kotlin | XML Views | Traditional Android development |
+| `kotlin-compose` | Kotlin | Jetpack Compose | Modern declarative UI |
+| `java-xml` | Java | XML Views | Java projects & legacy codebases |
+| `native-cpp` | Kotlin + C++ | XML Views | High-performance & game development |
+
+---
+
+## 🚀 Quick Start
+
+### Installation
+
+```bash
+# Install globally via npm
+npm install -g @andrud/cli
+
+# Verify installation
+andrud --version
+```
+
+### Create a New Project
+
+```bash
+# Interactive mode (recommended)
+andrud create
+
+# With all options specified
+andrud new MyApp -t kotlin-compose -p com.example.myapp -d ./projects
+
+# Quick create with defaults
+andrud new MyApp
+```
+
+### Available Commands
+
+| Command | Description |
+|---------|-------------|
+| `andrud create` | Interactive project creation |
+| `andrud new <name>` | Create project with name |
+| `andrud list` | Show all available templates |
+| `andrud info <template>` | View template details |
+
+---
+
+## 📖 Usage Examples
+
+### Interactive Project Creation
+
+```bash
+$ andrud create
+
+? Enter your app name: MyAwesomeApp
+? Enter package name: com.example.myawesomeapp
+? Select template: kotlin-compose
+? Project directory: ./projects
+
+⚡ Generating project structure...
+✅ MyAwesomeApp created successfully!
+```
+
+### Create with Options
+
+```bash
+# Kotlin with Jetpack Compose
+andrud new MyComposeApp -t kotlin-compose -p com.mydomain.app
+
+# Kotlin with XML Views
+andrud new MyKotlinApp -t kotlin-xml -p com.mydomain.app
+
+# Java with XML Views
+andrud new MyJavaApp -t java-xml -p com.mydomain.app
+
+# Native C++ with NDK
+andrud new MyNativeApp -t native-cpp -p com.mydomain.app
+```
+
+### List Templates
+
+```bash
+$ andrud list
+
+╔══════════════════════════════════════════════════════════════╗
+║                    Android Project Templates                   ║
+╚══════════════════════════════════════════════════════════════╝
+
+  1. Kotlin with XML Layouts
+     Traditional Android Views with Kotlin...
+
+  2. Kotlin with Jetpack Compose
+     Modern declarative UI...
+
+  3. Java with XML Layouts
+     Traditional Android Views with Java...
+
+  4. Kotlin with Native C++/NDK
+     Native C++ development with JNI...
+```
+
+---
+
+## 🏗️ Project Structure
+
+Generated projects include:
+
+```
+MyApp/
+├── app/
+│   ├── src/main/
+│   │   ├── java/          # Java/Kotlin source files
+│   │   ├── res/           # Resources (layouts, values, drawables)
+│   │   ├── AndroidManifest.xml
+│   │   └── ...
+│   ├── build.gradle.kts   # App-level build config
+│   └── proguard-rules.pro
+├── gradle/wrapper/        # Gradle wrapper files
+├── build.gradle.kts       # Root build config
+├── settings.gradle.kts    # Project settings
+├── gradle.properties      # Gradle properties
+├── .gitignore
+└── README.md
+```
+
+---
+
+## ⚙️ Configuration
+
+### SDK Versions
+
+```bash
+# Custom SDK versions
+andrud new MyApp --min-sdk 24 --target-sdk 35
+```
+
+### Features
+
+```bash
+# Disable specific features
+andrud new MyApp --no-git --no-readme
+
+# Skip dependency installation
+andrud new MyApp --skip-install
+```
+
+---
+
+## 🛠️ Development
+
+### Setup
+
+```bash
+# Clone the repository
+git clone https://github.com/MurShidM01/andrud.git
+cd andrud
+
+# Install dependencies
+npm install
+
+# Build the project
+npm run build
+
+# Run in development mode
+npm run dev -- create
+```
+
+### Available Scripts
+
+| Script | Description |
+|--------|-------------|
+| `npm run build` | Build TypeScript to JavaScript |
+| `npm run dev` | Build and run in development |
+| `npm run link` | Link package globally for testing |
+| `npm test` | Run tests |
+
+---
+
+## 📦 What's Included
+
+### Dependencies
+- **@clack/prompts** - Beautiful interactive prompts
+- **cac** - Lightweight CLI argument parser
+- **fs-extra** - Enhanced file system operations
+- **ora** - Elegant terminal spinners
+- **picocolors** - Terminal colors
+- **gradient-string** - Gradient text effects
+- **update-notifier** - Check for updates
+
+### Dev Dependencies
+- **TypeScript 5.4** - Type safety
+- **@types/node** - Node.js type definitions
+
+---
+
+## 🎯 Tech Stack
+
+<p align="center">
+  <img src="https://skillicons.dev/icons?i=nodejs,typescript,androidstudio,kotlin,gradle,npm" alt="Tech Stack">
+</p>
+
+---
+
+## 📊 Statistics
+
+<p align="center">
+  <img src="https://img.shields.io/github/repo-size/MurShidM01/andrud?style=for-the-badge" alt="repo size">
+  <img src="https://img.shields.io/github/languages/code-size/MurShidM01/andrud?style=for-the-badge" alt="code size">
+  <img src="https://img.shields.io/github/languages/count/MurShidM01/andrud?style=for-the-badge" alt="languages">
+  <img src="https://img.shields.io/tokei/lines/github/MurShidM01/andrud?style=for-the-badge" alt="lines of code">
+</p>
+
+---
+
+## 🤝 Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+---
+
+## 📝 License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+---
+
+## 🙏 Acknowledgments
+
+- [Android Open Source Project](https://source.android.com/)
+- [Jetpack Compose](https://developer.android.com/compose)
+- [Kotlin](https://kotlinlang.org/)
+- [Gradle](https://gradle.org/)
+
+---
+
+## 📮 Contact
+
+<p align="center">
+  <a href="https://github.com/MurShidM01/andrud/issues">
+    <img src="https://img.shields.io/badge/Issues-Open-green?style=for-the-badge&logo=github" alt="issues">
+  </a>
+  <a href="https://github.com/MurShidM01/andrud/discussions">
+    <img src="https://img.shields.io/badge/Discussions-Q&A-blue?style=for-the-badge&logo=github" alt="discussions">
+  </a>
+</p>
+
+---
+
+<p align="center">
+  <strong>Made with ❤️ by <a href="https://github.com/MurShidM01">MurShidM01</a></strong>
+</p>
+
+<p align="center">
+  <img src="https://img.shields.io/badge/JavaScript-ES2022-yellow?style=for-the-badge&logo=javascript&logoColor=black" alt="js">
+  <img src="https://img.shields.io/badge/PowerShell-7+-blue?style=for-the-badge&logo=powershell" alt="powershell">
+</p>
+
+<p align="center">
+  <substar>Star ⭐ this repo if you find it useful!</substar>
+</p>

package/bin/andrud.js

@@ -0,0 +1,24 @@
+#!/usr/bin/env node
+
+/**
+ * @andrud/cli - Android Project Scaffolding CLI
+ *
+ * Entry point for the andrud CLI tool.
+ * This file is used when running via `node bin/andrud.js`
+ */
+
+// Run the CLI
+import('../dist/cli/index.js').then((module) => {
+  if (module.runCli) {
+    Promise.resolve(module.runCli()).catch((error) => {
+      console.error('CLI execution failed:', error);
+      process.exit(1);
+    });
+  } else {
+    console.error('Failed to load CLI: runCli function not found');
+    process.exit(1);
+  }
+}).catch((error) => {
+  console.error('Failed to start CLI:', error);
+  process.exit(1);
+});

package/package.json

@@ -0,0 +1,80 @@
+{
+  "name": "andrud",
+  "version": "1.0.0",
+  "description": "Modern Android project scaffolding CLI tool - Generate production-ready Android projects in seconds",
+  "type": "module",
+  "bin": {
+    "andrud": "./bin/andrud.js"
+  },
+  "main": "./dist/cli/index.js",
+  "types": "./dist/cli/index.d.ts",
+  "keywords": [
+    "android",
+    "cli",
+    "scaffolding",
+    "generator",
+    "kotlin",
+    "java",
+    "jetpack-compose",
+    "ndk",
+    "native",
+    "project-template",
+    "android-studio",
+    "mobile-development"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/cli/index.d.ts",
+      "import": "./dist/cli/index.js"
+    },
+    "./core": {
+      "types": "./dist/core/index.d.ts",
+      "import": "./dist/core/index.js"
+    },
+    "./ui": {
+      "types": "./dist/ui/index.d.ts",
+      "import": "./dist/ui/index.js"
+    },
+    "./utils": {
+      "types": "./dist/utils/index.d.ts",
+      "import": "./dist/utils/index.js"
+    }
+  },
+  "scripts": {
+    "build": "tsc -b",
+    "build:all": "tsc -b",
+    "dev": "npm run build && node bin/andrud.js",
+    "link": "npm run build && npm link",
+    "test": "node --test"
+  },
+  "author": "MurShidM01",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/MurShidM01/andrud.git"
+  },
+  "homepage": "https://github.com/MurShidM01/andrud#readme",
+  "bugs": {
+    "url": "https://github.com/MurShidM01/andrud/issues"
+  },
+  "dependencies": {
+    "@clack/prompts": "^0.7.0",
+    "cac": "^6.7.14",
+    "ejs": "^3.1.10",
+    "fs-extra": "^11.2.0",
+    "gradient-string": "^2.0.2",
+    "ora": "^8.0.1",
+    "picocolors": "^1.0.1",
+    "update-notifier": "^7.0.0",
+    "validate-npm-package-name": "^4.0.0"
+  },
+  "devDependencies": {
+    "@types/ejs": "^3.1.5",
+    "@types/fs-extra": "^11.0.4",
+    "@types/node": "^20.12.12",
+    "typescript": "^5.4.5"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  }
+}

package/src/__tests__/context.test.ts

@@ -0,0 +1,133 @@
+/**
+ * Test suite for context builder
+ */
+
+import { test } from 'node:test';
+import assert from 'node:assert';
+import {
+  buildDefaultProjectContext,
+  buildTemplateContext,
+  validateContext
+} from '../core/context.js';
+import type { TemplateType } from '../core/types.js';
+
+test('Context - Build Default Context', async (t) => {
+  await t.test('should create valid default context', () => {
+    const context = buildDefaultProjectContext(
+      'MyApp',
+      'com.example.myapp',
+      './my-project',
+      'kotlin-compose' as TemplateType,
+      { git: true, readme: true }
+    );
+
+    assert.strictEqual(context.appName, 'MyApp');
+    assert.strictEqual(context.packageName, 'com.example.myapp');
+    assert.strictEqual(context.template, 'kotlin-compose');
+    assert.strictEqual(context.language, 'kotlin');
+    assert.strictEqual(context.uiFramework, 'compose');
+  });
+
+  await t.test('should set default features', () => {
+    const context = buildDefaultProjectContext(
+      'MyApp',
+      'com.example.myapp',
+      './my-project',
+      'kotlin-xml' as TemplateType
+    );
+
+    assert.strictEqual(context.git, true);
+    assert.strictEqual(context.readme, true);
+    assert.strictEqual(context.androidX, true);
+  });
+});
+
+test('Context - Build Template Context', async (t) => {
+  await t.test('should build full template context', () => {
+    const baseContext = buildDefaultProjectContext(
+      'MyApp',
+      'com.example.myapp',
+      './my-project',
+      'kotlin-compose' as TemplateType
+    );
+
+    const context = buildTemplateContext({
+      appName: baseContext.appName,
+      packageName: baseContext.packageName,
+      projectDirectory: baseContext.projectDirectory,
+      template: baseContext.template,
+      uiFramework: baseContext.uiFramework,
+      language: baseContext.language,
+      android: baseContext.android,
+      gradle: baseContext.gradle,
+      features: baseContext as unknown as Record<string, boolean>
+    });
+
+    assert.ok(context.appNameCamel);
+    assert.ok(context.appNamePascal);
+    assert.ok(context.appNameKebab);
+    assert.ok(context.appNameSnake);
+    assert.ok(context.packagePath);
+    assert.ok(context.year);
+    assert.ok(context.generatorVersion);
+  });
+
+  await t.test('should generate correct app name transformations', () => {
+    const baseContext = buildDefaultProjectContext(
+      'MyAwesomeApp',
+      'com.example.myapp',
+      './my-project',
+      'kotlin-compose' as TemplateType
+    );
+
+    const context = buildTemplateContext({
+      appName: baseContext.appName,
+      packageName: baseContext.packageName,
+      projectDirectory: baseContext.projectDirectory,
+      template: baseContext.template,
+      uiFramework: baseContext.uiFramework,
+      language: baseContext.language,
+      android: baseContext.android,
+      gradle: baseContext.gradle,
+      features: baseContext as unknown as Record<string, boolean>
+    });
+
+    assert.ok(context.appNamePascal.includes('Awesome'));
+    assert.ok(context.packagePath.includes('/'));
+  });
+});
+
+test('Context - Validate Context', async (t) => {
+  await t.test('should accept valid context', () => {
+    const baseContext = buildDefaultProjectContext(
+      'MyApp',
+      'com.example.myapp',
+      './my-project',
+      'kotlin-compose' as TemplateType
+    );
+
+    const result = validateContext(baseContext);
+    assert.strictEqual(result.valid, true);
+  });
+
+  await t.test('should reject context with missing appName', () => {
+    const result = validateContext({
+      appName: '',
+      packageName: 'com.example.myapp',
+      template: 'kotlin-compose' as TemplateType
+    });
+
+    assert.strictEqual(result.valid, false);
+    assert.ok(result.errors.length > 0);
+  });
+
+  await t.test('should reject context with missing packageName', () => {
+    const result = validateContext({
+      appName: 'MyApp',
+      packageName: '',
+      template: 'kotlin-compose' as TemplateType
+    });
+
+    assert.strictEqual(result.valid, false);
+  });
+});

package/src/__tests__/generator.test.ts

@@ -0,0 +1,107 @@
+/**
+ * Test suite for generator utilities
+ */
+
+import { test } from 'node:test';
+import assert from 'node:assert';
+import {
+  validateContext,
+  validateProjectDirectory
+} from '../core/generator.js';
+import type { TemplateContext } from '../core/types.js';
+
+test('Generator - Validate Context', async (t) => {
+  await t.test('should accept valid context', () => {
+    const context: Partial<TemplateContext> = {
+      appName: 'MyApp',
+      packageName: 'com.example.myapp',
+      projectDirectory: './my-project',
+      template: 'kotlin-compose',
+      language: 'kotlin',
+      uiFramework: 'compose',
+      android: {
+        minSdk: 31,
+        targetSdk: 36,
+        compileSdk: 36
+      },
+      gradle: {
+        agpVersion: '8.7.3',
+        gradleVersion: '8.14',
+        kotlinVersion: '2.0.21'
+      }
+    };
+
+    const result = validateContext(context);
+    assert.strictEqual(result.valid, true);
+  });
+
+  await t.test('should reject context with missing appName', () => {
+    const context: Partial<TemplateContext> = {
+      appName: '',
+      packageName: 'com.example.myapp'
+    };
+
+    const result = validateContext(context);
+    assert.strictEqual(result.valid, false);
+    assert.ok(result.errors.some(e => e.includes('appName')));
+  });
+
+  await t.test('should reject context with missing packageName', () => {
+    const context: Partial<TemplateContext> = {
+      appName: 'MyApp',
+      packageName: ''
+    };
+
+    const result = validateContext(context);
+    assert.strictEqual(result.valid, false);
+    assert.ok(result.errors.some(e => e.includes('packageName')));
+  });
+
+  await t.test('should reject context with missing template', () => {
+    const context: Partial<TemplateContext> = {
+      appName: 'MyApp',
+      packageName: 'com.example.myapp',
+      template: undefined
+    };
+
+    const result = validateContext(context);
+    assert.strictEqual(result.valid, false);
+    assert.ok(result.errors.some(e => e.includes('template')));
+  });
+
+  await t.test('should reject context with missing language', () => {
+    const context: Partial<TemplateContext> = {
+      appName: 'MyApp',
+      packageName: 'com.example.myapp',
+      template: 'kotlin-compose',
+      language: undefined
+    };
+
+    const result = validateContext(context);
+    assert.strictEqual(result.valid, false);
+    assert.ok(result.errors.some(e => e.includes('language')));
+  });
+});
+
+test('Generator - Validate Project Directory', async (t) => {
+  await t.test('should validate non-existent directory', async () => {
+    const result = await validateProjectDirectory(
+      '/tmp/nonexistent-dir-' + Date.now(),
+      { overwrite: false }
+    );
+
+    assert.strictEqual(result.valid, true);
+  });
+
+  await t.test('should allow non-empty directory with overwrite', async () => {
+    // Note: This would require actual file system operations
+    // In a real test, we'd mock the filesystem
+    const result = await validateProjectDirectory(
+      '/tmp/test-dir',
+      { overwrite: true }
+    );
+
+    // Just assert the result has the expected shape
+    assert.ok(typeof result.valid === 'boolean');
+  });
+});