evty 1.0.0

package/README.md

@@ -0,0 +1,82 @@
+# ⚡ evty
+
+A smart, zero-config CLI tool that automatically generates TypeScript definitions from your `.env` file—complete with **smart type inference** and **JSDoc support** for a better Developer Experience (DX).
+
+No installation required. Just run it via `npx`.
+
+---
+
+## ✨ Features
+
+- ⚡ **Zero Config**: Works out of the box. No complex JSON setups.
+- 🔮 **Smart Type Inference**: Automatically converts `PORT=3000` to `string | "3000"` and `DEBUG=true` to `"true" | "false"`.
+- 📝 **Auto JSDoc Comments**: Turns your `.env` comments (`# comment`) into TypeScript JSDoc code documentation. Hover over `process.env.VAR` in your editor to see descriptions instantly.
+- 👀 **Watch Mode**: Live-monitors changes in your `.env` file and updates types in real time.
+- 👶 **Friendly Defaults**: If you don't have a `.env` file yet, it gracefully generates a clean sample template for you.
+
+---
+
+## 🚀 Quick Start
+
+Run the following single command in your project's root folder:
+
+```bash
+npx evty
+```
+
+That's it! `evty` will scan your `.env`, generate an `env.d.ts` file, and start watching for any future changes.
+
+---
+
+## 💡 How It Works
+
+### 1. Your `.env` file:
+```env
+# The port number your local server runs on
+PORT=3000
+
+# Toggle development features
+DEBUG=true
+
+# MongoDB connection string
+DATABASE_URL=mongodb://localhost:27017/mydb
+```
+
+### 2. Auto-generated `env.d.ts`:
+```typescript
+declare global {
+  namespace NodeJS {
+    interface ProcessEnv {
+      /**
+       * The port number your local server runs on
+       */
+      PORT: "3000" | string;
+      /**
+       * Toggle development features
+       */
+      DEBUG: "true" | "false";
+      /**
+       * MongoDB connection string
+       */
+      DATABASE_URL: string;
+    }
+  }
+}
+export {};
+```
+
+### 3. Your Editor (Developer Experience):
+When typing `process.env.PORT` in VS Code or any modern IDE, you will get **full autocomplete** and see the precise comment as a hover popup.
+
+---
+
+## 🛠️ Requirements
+
+- [Node.js](https://nodejs.org) (v16 or higher recommended)
+- A TypeScript project (or JavaScript project using `@ts-check`)
+
+---
+
+## 📄 License
+
+This project is licensed under the MIT License.

package/index.js

@@ -0,0 +1,92 @@
+#!/usr/bin/env node
+
+const fs = require('fs');
+const path = require('path');
+
+const envPath = path.join(process.cwd(), '.env');
+const outputPath = path.join(process.cwd(), 'env.d.ts');
+
+// Function to infer the best TypeScript type from a .env value
+function inferType(value) {
+  const v = value.trim();
+  if (!v || v === '""' || v === "''") return 'string';
+  
+  // For Numbers (provides string-literal for autocomplete, but falls back to string)
+  if (!isNaN(v) && !isNaN(parseFloat(v))) {
+    return `"${v}" | string`;
+  }
+  
+  // For Booleans
+  if (v === 'true' || v === 'false') {
+    return '"true" | "false"';
+  }
+  
+  return 'string';
+}
+
+// Main logic to generate TypeScript definitions
+function generateTypes() {
+  // If .env doesn't exist, create a friendly default sample
+  if (!fs.existsSync(envPath)) {
+    const defaultEnv = `# Server port number\nPORT=3000\n\n# Enable debug mode\nDEBUG=true\n\n# Database connection URL\nDATABASE_URL=mongodb://localhost:27017/mydb\n`;
+    fs.writeFileSync(envPath, defaultEnv);
+    console.log('📝 .env file not found. Created a default sample for you!');
+  }
+
+  const content = fs.readFileSync(envPath, 'utf8');
+  const lines = content.split(/\r?\n/);
+
+  let typeDefinitions = 'declare global {\n  namespace NodeJS {\n    interface ProcessEnv {\n';
+  let currentComment = '';
+
+  lines.forEach(line => {
+    const trimmed = line.trim();
+
+    // Reset comment on empty lines
+    if (!trimmed) {
+      currentComment = '';
+      return;
+    }
+
+    // Process comment lines
+    if (trimmed.startsWith('#')) {
+      const commentText = trimmed.replace(/^#\s*/, '');
+      currentComment += currentComment ? `\n       * ${commentText}` : commentText;
+      return;
+    }
+
+    // Split by the first equals sign
+    const equalIndex = trimmed.indexOf('=');
+    if (equalIndex === -1) return;
+
+    const key = trimmed.substring(0, equalIndex).trim();
+    const value = trimmed.substring(equalIndex + 1).trim();
+
+    if (key) {
+      // Insert JSDoc if a comment exists right above the key
+      if (currentComment) {
+        typeDefinitions += `      /**\n       * ${currentComment}\n       */\n`;
+      }
+      
+      const smartType = inferType(value);
+      typeDefinitions += `      ${key}: ${smartType};\n`;
+      currentComment = '';
+    }
+  });
+
+  typeDefinitions += '    }\n  }\n}\nexport {};\n';
+
+  fs.writeFileSync(outputPath, typeDefinitions);
+  console.log('⚡ [evty] env.d.ts updated successfully with types and JSDoc!');
+}
+
+// Initial execution
+generateTypes();
+
+// Start watching the .env file
+console.log('👀 Watching .env file for changes... (Press Ctrl + C to exit)');
+fs.watchFile(envPath, { interval: 1000 }, (curr, prev) => {
+  if (curr.mtime !== prev.mtime) {
+    generateTypes();
+  }
+});

package/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "evty",
+  "version": "1.0.0",
+  "description": "A smart, zero-config CLI tool that automatically generates TypeScript definitions (with typed values and JSDoc) from your .env file.",
+  "main": "index.js",
+  "bin": {
+    "evty": "./index.js"
+  },
+  "keywords": ["env", "typescript", "dx", "cli", "tool", "autocomplete"],
+  "author": "Your Name",
+  "license": "MIT"
+}