@mg21st/dev-assist 1.0.0

package/docs/contributing.md

@@ -0,0 +1,101 @@
+---
+title: Contributing
+nav_order: 7
+---
+
+# Contributing
+
+Contributions are welcome! Please read this guide before opening a pull request.
+
+---
+
+## Getting Started
+
+1. **Fork** the repository on GitHub.
+
+2. **Clone** your fork:
+
+   ```bash
+   git clone https://github.com/<your-username>/dev-assist.git
+   cd dev-assist
+   ```
+
+3. **Install dependencies**:
+
+   ```bash
+   npm install
+   cd ui && npm install && cd ..
+   ```
+
+4. **Create a feature branch**:
+
+   ```bash
+   git checkout -b feature/my-feature
+   ```
+
+---
+
+## Development Workflow
+
+### Run in development mode
+
+```bash
+npm run dev
+```
+
+### Lint
+
+```bash
+npm run lint
+```
+
+### Build
+
+```bash
+npm run build
+```
+
+### Build only the CLI
+
+```bash
+npm run build:cli
+```
+
+### Build only the UI
+
+```bash
+npm run build:ui
+```
+
+---
+
+## Project Structure
+
+See the [Architecture](./architecture) page for a full breakdown of the project layout.
+
+---
+
+## Pull Request Guidelines
+
+- Keep PRs focused — one feature or bug fix per PR.
+- Ensure `npm run lint` passes before submitting.
+- Ensure `npm run build` succeeds.
+- Add or update documentation in the `docs/` folder if your change affects user-facing behaviour.
+- Describe what your PR does and why in the PR description.
+
+---
+
+## Reporting Issues
+
+Please open an issue on [GitHub Issues](https://github.com/moazzamgodil/dev-assist/issues) with:
+
+- A clear description of the problem.
+- Steps to reproduce it.
+- Expected behaviour vs. actual behaviour.
+- Your Node.js and npm versions (`node -v`, `npm -v`).
+
+---
+
+## License
+
+By contributing, you agree that your contributions will be licensed under the [MIT License](https://opensource.org/licenses/MIT).

package/docs/index.md

@@ -0,0 +1,50 @@
+---
+title: Home
+layout: home
+nav_order: 1
+---
+
+# DevAssist 🚀
+
+> All-in-one developer toolkit: Auto Test Generator, API Docs Generator & API Testing UI
+
+[![npm version](https://img.shields.io/npm/v/dev-assist.svg)](https://www.npmjs.com/package/dev-assist)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![CI](https://github.com/moazzamgodil/dev-assist/actions/workflows/ci.yml/badge.svg)](https://github.com/moazzamgodil/dev-assist/actions/workflows/ci.yml)
+
+---
+
+## What is DevAssist?
+
+**DevAssist** is a command-line toolkit that helps developers work faster by automating repetitive tasks:
+
+| Feature | Description |
+|---------|-------------|
+| 🧪 **Auto Test Generator** | AST-based test stub generation for JavaScript & TypeScript files |
+| 📚 **API Docs Generator** | Extracts Express routes and generates OpenAPI specs and Markdown |
+| 🌐 **Local UI Server** | React dashboard with test viewer, API docs browser and built-in HTTP client |
+| ⚡ **API Testing Tab** | Lightweight Postman-like HTTP testing interface |
+| 🧙 **Interactive Wizard** | Guided CLI setup experience |
+
+---
+
+## Quick Start
+
+```bash
+# Install globally
+npm install -g dev-assist
+
+# Run the interactive wizard
+dev-assist
+```
+
+---
+
+## Navigation
+
+- [Installation](./installation) — How to install and set up DevAssist
+- [Usage](./usage) — CLI commands and options
+- [Configuration](./configuration) — Configuration file reference
+- [API Reference](./api-reference) — Server API endpoints
+- [Architecture](./architecture) — Project internals
+- [Contributing](./contributing) — How to contribute

package/docs/installation.md

@@ -0,0 +1,95 @@
+---
+title: Installation
+nav_order: 2
+---
+
+# Installation
+
+## Prerequisites
+
+- **Node.js** >= 16.0.0
+- **npm** >= 7.0.0
+
+---
+
+## Global Installation (Recommended)
+
+Install DevAssist as a global CLI tool:
+
+```bash
+npm install -g dev-assist
+```
+
+Verify the installation:
+
+```bash
+dev-assist --version
+```
+
+---
+
+## Local Installation
+
+You can also install DevAssist as a project dependency:
+
+```bash
+npm install --save-dev dev-assist
+```
+
+Then invoke it via `npx`:
+
+```bash
+npx dev-assist
+```
+
+Or add a script to your `package.json`:
+
+```json
+{
+  "scripts": {
+    "assist": "dev-assist"
+  }
+}
+```
+
+---
+
+## Building from Source
+
+1. **Clone the repository**
+
+   ```bash
+   git clone https://github.com/moazzamgodil/dev-assist.git
+   cd dev-assist
+   ```
+
+2. **Install root dependencies**
+
+   ```bash
+   npm install
+   ```
+
+3. **Install UI dependencies**
+
+   ```bash
+   cd ui && npm install && cd ..
+   ```
+
+4. **Build everything**
+
+   ```bash
+   npm run build
+   ```
+
+5. **Link globally** (optional)
+
+   ```bash
+   npm link
+   ```
+
+---
+
+## Next Steps
+
+- [Usage](./usage) — Learn the CLI commands
+- [Configuration](./configuration) — Set up your config file

package/docs/usage.md

@@ -0,0 +1,107 @@
+---
+title: Usage
+nav_order: 3
+---
+
+# Usage
+
+## Interactive Wizard
+
+The easiest way to get started is the interactive wizard, which guides you through all available options:
+
+```bash
+dev-assist
+```
+
+The wizard will ask you to choose between generating tests, generating API docs, or starting the UI server.
+
+---
+
+## CLI Commands
+
+### `dev-assist generate`
+
+Generate tests, API docs, or both.
+
+#### Generate Tests
+
+```bash
+dev-assist generate --tests --source ./src --output ./__tests__ --framework jest
+```
+
+| Flag | Alias | Description | Default |
+|------|-------|-------------|---------|
+| `--tests` | | Generate test stubs | |
+| `--source <path>` | `-s` | Source directory to parse | `./src` |
+| `--output <path>` | `-o` | Output directory for tests | `./__tests__` |
+| `--framework <name>` | `-f` | Test framework (`jest` or `vitest`) | `jest` |
+
+#### Generate API Docs
+
+```bash
+dev-assist generate --docs --source ./src --output ./docs
+```
+
+| Flag | Alias | Description | Default |
+|------|-------|-------------|---------|
+| `--docs` | | Generate API documentation | |
+| `--source <path>` | `-s` | Source directory to parse | `./src` |
+| `--output <path>` | `-o` | Output directory for docs | `./docs` |
+
+#### Generate Both
+
+```bash
+dev-assist generate --source ./src
+```
+
+Omitting `--tests` or `--docs` will generate both.
+
+---
+
+### `dev-assist serve`
+
+Start the local UI server and open the dashboard in your browser.
+
+```bash
+dev-assist serve --port 3000
+```
+
+| Flag | Alias | Description | Default |
+|------|-------|-------------|---------|
+| `--port <number>` | `-p` | Port to listen on | `3000` |
+
+Once started, open your browser at `http://localhost:3000` (or the configured port).
+
+The UI provides:
+
+- **Dashboard** — Project summary and statistics
+- **Tests Viewer** — Browse generated test files
+- **API Docs Browser** — Explore generated API documentation
+- **HTTP Client** — Send test requests to your API endpoints
+
+---
+
+## Examples
+
+### Typical Workflow
+
+```bash
+# 1. Install DevAssist
+npm install -g dev-assist
+
+# 2. Add a config file to your project
+# (see Configuration page)
+
+# 3. Generate tests and docs together
+dev-assist generate --source ./src
+
+# 4. Start the UI to review results
+dev-assist serve
+```
+
+### CI / Automation
+
+```bash
+# Generate docs as part of a CI pipeline
+dev-assist generate --docs --source ./src --output ./docs
+```

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@mg21st/dev-assist",
+  "version": "1.0.0",
+  "description": "All-in-one developer toolkit: Auto Test Generator, API Docs Generator, and API Testing UI",
+  "main": "dist/cli/index.js",
+  "bin": {
+    "dev-assist": "./bin/dev-assist.js"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json && npm run build:ui",
+    "build:cli": "tsc -p tsconfig.build.json",
+    "build:ui": "cd ui && npm run build",
+    "dev": "ts-node src/cli/index.ts",
+    "lint": "eslint src --ext .ts",
+    "start": "node bin/dev-assist.js"
+  },
+  "keywords": [
+    "cli",
+    "testing",
+    "api-docs",
+    "developer-tools"
+  ],
+  "author": "",
+  "license": "MIT",
+  "dependencies": {
+    "@babel/parser": "^7.23.0",
+    "@babel/traverse": "^7.23.0",
+    "@babel/types": "^7.23.0",
+    "chalk": "^4.1.2",
+    "chokidar": "^3.5.3",
+    "commander": "^11.1.0",
+    "cors": "^2.8.5",
+    "express": "^4.18.2",
+    "express-rate-limit": "^8.2.1",
+    "inquirer": "^8.2.6",
+    "open": "^8.4.2",
+    "ora": "^5.4.1",
+    "socket.io": "^4.6.1"
+  },
+  "devDependencies": {
+    "@types/babel__traverse": "^7.20.4",
+    "@types/cors": "^2.8.17",
+    "@types/express": "^4.17.21",
+    "@types/inquirer": "^8.2.10",
+    "@types/node": "^20.10.0",
+    "@typescript-eslint/eslint-plugin": "^6.13.0",
+    "@typescript-eslint/parser": "^6.13.0",
+    "eslint": "^8.54.0",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.3.2"
+  },
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/cli/index.ts

@@ -0,0 +1,108 @@
+#!/usr/bin/env node
+import { Command } from 'commander';
+import chalk from 'chalk';
+import { TestGenerator } from '../generators/testGenerator';
+import { DocsGenerator } from '../generators/docsGenerator';
+import { runWizard } from './wizard';
+import { loadConfig } from '../config';
+
+const program = new Command();
+
+program
+  .name('dev-assist')
+  .description('🚀 DevAssist - Auto Test Generator, API Docs & Testing UI')
+  .version('1.0.0');
+
+program
+  .command('generate')
+  .description('Generate tests and/or API docs')
+  .option('--tests', 'Generate test files only')
+  .option('--docs', 'Generate API docs only')
+  .option('-s, --source <dir>', 'Source directory', './src')
+  .option('-o, --output <dir>', 'Output directory', './__tests__')
+  .option('-f, --framework <framework>', 'Test framework (jest|vitest)', 'jest')
+  .action(async (options) => {
+    const config = await loadConfig();
+    const generateTests = options.tests || (!options.docs);
+    const generateDocs = options.docs || (!options.tests);
+
+    if (generateTests) {
+      console.log(chalk.cyan('\n🧪 Generating Tests...\n'));
+      const generator = new TestGenerator();
+      await generator.generate({
+        sourceDir: options.source || config.sourceDir || './src',
+        outputDir: options.output || config.testOutputDir || './__tests__',
+        framework: (options.framework || config.testFramework || 'jest') as 'jest' | 'vitest',
+      });
+    }
+
+    if (generateDocs) {
+      console.log(chalk.cyan('\n📚 Generating API Docs...\n'));
+      const generator = new DocsGenerator();
+      await generator.generate({
+        sourceDir: options.source || config.sourceDir || './src',
+        outputDir: options.output || config.docsOutputDir || './docs',
+      });
+    }
+  });
+
+program
+  .command('serve')
+  .description('Start the local UI server')
+  .option('-p, --port <port>', 'Port number', '3000')
+  .option('--no-open', 'Do not open browser automatically')
+  .action(async (options) => {
+    const config = await loadConfig();
+    const port = parseInt(options.port || config.port?.toString() || '3000', 10);
+    
+    console.log(chalk.cyan(`\n🌐 Starting DevAssist UI on port ${port}...\n`));
+    
+    const { startServer } = await import('../server/index');
+    await startServer({ port, openBrowser: options.open !== false });
+  });
+
+program
+  .action(async () => {
+    try {
+      const answers = await runWizard();
+      
+      if (answers.action === 'serve') {
+        const { startServer } = await import('../server/index');
+        await startServer({ port: answers.port || 3000, openBrowser: true });
+        return;
+      }
+
+      const config = await loadConfig();
+      const doTests = answers.action === 'tests' || answers.action === 'both';
+      const doDocs = answers.action === 'docs' || answers.action === 'both';
+
+      if (doTests) {
+        console.log(chalk.cyan('\n🧪 Generating Tests...\n'));
+        const generator = new TestGenerator();
+        await generator.generate({
+          sourceDir: answers.sourceDir || config.sourceDir || './src',
+          outputDir: answers.testOutputDir || config.testOutputDir || './__tests__',
+          framework: (answers.testFramework || config.testFramework || 'jest') as 'jest' | 'vitest',
+        });
+      }
+
+      if (doDocs) {
+        console.log(chalk.cyan('\n📚 Generating API Docs...\n'));
+        const generator = new DocsGenerator();
+        await generator.generate({
+          sourceDir: answers.sourceDir || config.sourceDir || './src',
+          outputDir: answers.docsOutputDir || config.docsOutputDir || './docs',
+        });
+      }
+
+      console.log(chalk.green.bold('\n✅ DevAssist completed successfully!\n'));
+    } catch (error) {
+      if ((error as NodeJS.ErrnoException).code === 'ERR_USE_AFTER_CLOSE') {
+        process.exit(0);
+      }
+      console.error(chalk.red('\n❌ Error:', error));
+      process.exit(1);
+    }
+  });
+
+program.parse(process.argv);

package/src/cli/wizard.ts

@@ -0,0 +1,63 @@
+import inquirer from 'inquirer';
+import chalk from 'chalk';
+import { DevAssistConfig } from '../shared/types';
+
+export async function runWizard(): Promise<Partial<DevAssistConfig> & { action?: string }> {
+  console.log(chalk.cyan.bold('\n🚀 Welcome to DevAssist CLI Wizard\n'));
+
+  const answers = await inquirer.prompt([
+    {
+      type: 'list',
+      name: 'action',
+      message: 'What would you like to do?',
+      choices: [
+        { name: '🧪 Generate Tests', value: 'tests' },
+        { name: '📚 Generate API Docs', value: 'docs' },
+        { name: '🔥 Generate Both (Tests + Docs)', value: 'both' },
+        { name: '🌐 Start UI Server', value: 'serve' },
+      ],
+    },
+    {
+      type: 'input',
+      name: 'sourceDir',
+      message: 'Source directory to scan:',
+      default: './src',
+    },
+    {
+      type: 'list',
+      name: 'testFramework',
+      message: 'Test framework:',
+      choices: ['jest', 'vitest'],
+      when: (a) => a.action === 'tests' || a.action === 'both',
+    },
+    {
+      type: 'input',
+      name: 'testOutputDir',
+      message: 'Test output directory:',
+      default: './__tests__',
+      when: (a) => a.action === 'tests' || a.action === 'both',
+    },
+    {
+      type: 'input',
+      name: 'docsOutputDir',
+      message: 'Docs output directory:',
+      default: './docs',
+      when: (a) => a.action === 'docs' || a.action === 'both',
+    },
+    {
+      type: 'number',
+      name: 'port',
+      message: 'UI server port:',
+      default: 3000,
+      when: (a) => a.action === 'serve',
+    },
+    {
+      type: 'confirm',
+      name: 'watchMode',
+      message: 'Enable watch mode?',
+      default: false,
+    },
+  ]);
+
+  return answers;
+}

package/src/config.ts

@@ -0,0 +1,29 @@
+import * as path from 'path';
+import * as fs from 'fs';
+import { DevAssistConfig } from './shared/types';
+
+const DEFAULT_CONFIG: DevAssistConfig = {
+  testFramework: 'jest',
+  sourceDir: './src',
+  testOutputDir: './__tests__',
+  docsOutputDir: './docs',
+  port: 3000,
+  watchMode: false,
+  baseUrl: 'http://localhost:3000',
+};
+
+export async function loadConfig(): Promise<DevAssistConfig> {
+  const configPath = path.resolve(process.cwd(), 'dev-assist.config.js');
+  
+  if (fs.existsSync(configPath)) {
+    try {
+      // eslint-disable-next-line @typescript-eslint/no-var-requires
+      const userConfig = require(configPath) as Partial<DevAssistConfig>;
+      return { ...DEFAULT_CONFIG, ...userConfig };
+    } catch {
+      // Ignore config load errors
+    }
+  }
+  
+  return DEFAULT_CONFIG;
+}