@tng-sh/js 0.1.4 → 0.1.5

package/README.md

@@ -4,69 +4,79 @@ High-performance test generation and context analysis for JavaScript/TypeScript,
 
 ## Installation
 
+Install the package as a development dependency in your project:
+
 ```bash
 npm install @tng-sh/js --save-dev
 ```
 
-## Quick Start
+## Usage
 
 ### 1. Initialize
-Run the init command to create a `tng.config.js` configuration file in your project:
+First, run the init command to create a `tng.config.js` configuration file. This file stores your API keys and project settings.
 
 ```bash
-npx -p @tng-sh/js tng init
+npx tng init
 ```
 
-### 2. Generate Tests
-Generate a test for a specific function in a file:
+### 2. Interactive Mode (TUI)
+The most powerful way to use TNG is via the high-performance terminal interface. It provides a guided experience for all analysis tasks.
 
 ```bash
-npx -p @tng-sh/js tng -f path/to/file.js -m functionName -t react_component
+npx tng i
+```
+
+**Capabilities in TUI:**
+*   **Generate Tests**: Guided test creation for methods, components, and utilities.
+*   **Audit Method**: Deep security, performance, and best-practice auditing.
+*   **Trace Method**: Symbolic execution and logic flow visualization.
+*   **X-Ray Method**: Deep dependency and side-effect analysis.
+*   **Check Duplicates**: High-performance clone detection across the codebase.
+*   **Dead Code**: Identify unreachable logic and unused variables/parameters.
+*   **User Stats**: Review your usage metrics and generation history.
+
+### 3. Command Line Interface (CLI) ⚙️
+For direct execution or integration into scripts.
+
+```bash
+# See file outline and method list
+npx tng -f path/to/file.js --outline
+
+# Generate tests for a specific method
+npx tng -f path/to/file.js -m functionName -t react_component
+
+# Check for code clones
+npx tng -f path/to/file.js --clones
 ```
 
 **Supported Types (`-t`):**
-- `react_component`
-- `express_handler`
-- `graphql_resolver`
-- `nest_js` (Service/Controller)
-- `orm_model`
-- `background_job`
-- `mailer`
-- `utility`
-
-### 3. Interactive Mode
-Launch the interactive UI to explore and generate tests visually:
+`react_component`, `express_handler`, `graphql_resolver`, `nest_js`, `orm_model`, `background_job`, `mailer`, `utility`.
+
+### 4. Machine-Readable Output (`--json`) 🤖
+Add the `--json` flag to any command to receive output as structured JSON events. This is ideal for CI/CD pipelines or custom integrations.
 
 ```bash
-npx -p @tng-sh/js tng i
+npx tng -f path/to/file.js --clones --json
 ```
 
 ## Features
 
-- ⚡️ **Fast AST Analysis**: Powered by Rust and the `oxc` parser for blazing fast static analysis.
-- 🖥️ **Interactive UI**: Rich Go-based terminal UI for managing test generation.
-- 🎨 **Prettier Integration**: Automatically formats generated tests to match your project style.
-- 📘 **TypeScript Support**: First-class support for TypeScript analysis.
+-   **Oxc-Powered**: Blazing fast AST analysis using the industry-leading Rust parser.
+-   **Multi-Platform**: Native support for macOS (Intel/ARM) and Linux (x64/ARM64).
+-   **Prettier Integration**: Automatically formats generated code to match your existing style.
+-   **TypeScript Native**: First-class support for `.ts` and `.tsx` analysis and generation.
 
-## Configuration
+## ⚙️ Configuration
 
-The `tng.config.js` file allows you to customize the behavior:
+Your `tng.config.js` allows for full customization:
 
 ```javascript
 module.exports = {
-  // API Configuration
   API_KEY: "your-api-key-here",
   API_URL: "https://app.tng.sh/",
-
-  // Framework Detection
-  // Options: express, nextjs, nestjs, generic
-  FRAMEWORK: "express",
-
-  // Testing Configuration
-  // Options: jest, mocha, vitest
-  TEST_FRAMEWORK: "jest",
-
-  // Test Directory
-  TEST_DIRECTORY: "tests"
+  FRAMEWORK: "express",        // Options: express, nextjs, nestjs, generic
+  TESTS_PATH: "tests",         // Where to save generated tests
+  TEST_FRAMEWORK: "jest"       // Options: jest, mocha, vitest
 };
 ```
+

package/bin/tng.js

@@ -27,8 +27,8 @@ process.on('uncaughtException', (err) => {
 
 program
     .name('tng')
-    .description('TNG - Automated Test Generation, and audit generation for JavaScript')
-    .version('0.1.4');
+    .description('TNG - Automated Test Generation, and Audit generation for JavaScript')
+    .version('0.1.5');
 
 /**
  * @command init

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@tng-sh/js",
-    "version": "0.1.4",
+    "version": "0.1.5",
     "description": "TNG JavaScript CLI",
     "repository": {
         "type": "git",