english-optimizer-cli 1.0.0

package/dist/prompts/templates.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PROMPT_TEMPLATES = void 0;
+exports.getPromptTemplate = getPromptTemplate;
+exports.getAllModes = getAllModes;
+exports.getModeInfo = getModeInfo;
+const types_1 = require("../types");
+exports.PROMPT_TEMPLATES = {
+    [types_1.OptimizationMode.PROFESSIONAL]: {
+        name: 'Professional',
+        description: 'Make the text sound more professional and formal',
+        template: (text) => `Please rewrite the following text to make it sound more professional and formal, while maintaining the original meaning. Use appropriate business language and tone.
+
+Original text:
+"${text}"
+
+Rewritten text:`,
+    },
+    [types_1.OptimizationMode.CONCISE]: {
+        name: 'Concise',
+        description: 'Make the text more concise while keeping the meaning',
+        template: (text) => `Please rewrite the following text to be more concise and to the point, while preserving all the key information and meaning.
+
+Original text:
+"${text}"
+
+Rewritten text:`,
+    },
+    [types_1.OptimizationMode.GRAMMAR]: {
+        name: 'Grammar',
+        description: 'Fix grammar and spelling errors only',
+        template: (text) => `Please fix any grammar, spelling, or punctuation errors in the following text. Do not change the style or meaning - only correct mistakes.
+
+Original text:
+"${text}"
+
+Corrected text:`,
+    },
+    [types_1.OptimizationMode.SENIOR_DEVELOPER]: {
+        name: 'Senior Developer',
+        description: 'Rewrite as a senior software engineer would write it',
+        template: (text) => `Please rewrite the following text as a senior software engineer would write it in a professional context (e.g., code review, technical discussion, or documentation). Use clear, precise technical language and follow industry best practices for communication.
+
+Original text:
+"${text}"
+
+Rewritten text:`,
+    },
+};
+function getPromptTemplate(mode, text) {
+    return exports.PROMPT_TEMPLATES[mode].template(text);
+}
+function getAllModes() {
+    return Object.values(types_1.OptimizationMode);
+}
+function getModeInfo(mode) {
+    return exports.PROMPT_TEMPLATES[mode];
+}
+//# sourceMappingURL=templates.js.map

package/dist/prompts/translation-prompt.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TranslationPromptLoader = void 0;
+const fs_1 = require("fs");
+const path_1 = require("path");
+const os_1 = require("os");
+class TranslationPromptLoader {
+    constructor(promptPath) {
+        this.promptPath = promptPath || (0, path_1.join)((0, os_1.homedir)(), '.english-optimizer', 'translation-prompt.txt');
+    }
+    getPrompt() {
+        if ((0, fs_1.existsSync)(this.promptPath)) {
+            try {
+                return (0, fs_1.readFileSync)(this.promptPath, 'utf-8');
+            }
+            catch {
+                // Fall back to default
+                return this.getDefaultPrompt();
+            }
+        }
+        // Create default prompt file
+        this.createDefaultPromptFile();
+        return this.getDefaultPrompt();
+    }
+    getDefaultPrompt() {
+        return `You are a professional translator and editor for software developers.
+
+Your task is to:
+1. Detect if the text is Chinese or English
+2. If Chinese: Translate to natural, professional English
+3. If English: Optimize the English to be more natural and professional
+4. Use terminology and phrasing common in software development
+5. Make it sound like a native English-speaking developer
+6. Preserve technical terms, API names, and code snippets
+7. For multi-line text, maintain the paragraph structure
+
+Text to process:
+"{text}"
+
+Provide ONLY the translated/optimized English text, nothing else.
+Do not include any explanations, notes, or additional text.`;
+    }
+    createDefaultPromptFile() {
+        const { dirname } = require('path');
+        const { mkdirSync, writeFileSync } = require('fs');
+        const dir = require('path').dirname(this.promptPath);
+        if (!require('fs').existsSync(dir)) {
+            mkdirSync(dir, { recursive: true });
+        }
+        writeFileSync(this.promptPath, this.getDefaultPrompt(), 'utf-8');
+    }
+    getPromptPath() {
+        return this.promptPath;
+    }
+}
+exports.TranslationPromptLoader = TranslationPromptLoader;
+//# sourceMappingURL=translation-prompt.js.map

package/dist/prompts/yaml-prompt.js

@@ -0,0 +1,101 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.YAMLPromptLoader = void 0;
+const fs_1 = require("fs");
+const path_1 = require("path");
+const yaml = __importStar(require("js-yaml"));
+class YAMLPromptLoader {
+    constructor(promptPath) {
+        this.promptPath = promptPath || (0, path_1.join)(process.cwd(), 'prompt.yaml');
+    }
+    loadConfig() {
+        if (!(0, fs_1.existsSync)(this.promptPath)) {
+            return null;
+        }
+        try {
+            const content = (0, fs_1.readFileSync)(this.promptPath, 'utf-8');
+            const config = yaml.load(content);
+            return config;
+        }
+        catch (error) {
+            console.warn('Failed to load YAML prompt config:', error);
+            return null;
+        }
+    }
+    buildPrompt(text) {
+        const config = this.loadConfig();
+        if (!config) {
+            throw new Error('YAML prompt config not found');
+        }
+        const sections = [];
+        sections.push(`## Role\n${config.role.name}\n${config.role.description}`);
+        if (config.goals && config.goals.length > 0) {
+            sections.push(`## Goals\n${config.goals.map((g) => `- ${g}`).join('\n')}`);
+        }
+        if (config.user_profile) {
+            sections.push(`## User Profile\n` +
+                `Background: ${config.user_profile.background}\n` +
+                `Native Language: ${config.user_profile.native_language}\n` +
+                `Learning Goal: ${config.user_profile.learning_goal}`);
+        }
+        if (config.instructions && config.instructions.length > 0) {
+            sections.push(`## Instructions\n${config.instructions.map((i) => `- ${i}`).join('\n')}`);
+        }
+        if (config.output_format) {
+            sections.push(`## Output Format\n` +
+                `Style: ${config.output_format.style}\n` +
+                `Structure: ${config.output_format.structure.join(', ')}`);
+        }
+        if (config.examples && config.examples.length > 0) {
+            sections.push(`## Examples\n` +
+                config.examples.map((ex) => `Input: "${ex.input}"\nOutput: ${ex.output}`).join('\n\n'));
+        }
+        if (config.constraints && config.constraints.length > 0) {
+            sections.push(`## Constraints\n${config.constraints.map((c) => `- ${c}`).join('\n')}`);
+        }
+        sections.push(`\n## Input to Optimize\n"${text}"`);
+        sections.push('\n## Output\nProvide ONLY the optimized English text, nothing else.');
+        return sections.join('\n\n');
+    }
+    hasYAMLPrompt() {
+        return this.loadConfig() !== null;
+    }
+    getPromptPath() {
+        return this.promptPath;
+    }
+}
+exports.YAMLPromptLoader = YAMLPromptLoader;
+//# sourceMappingURL=yaml-prompt.js.map

package/dist/types/index.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OptimizationMode = void 0;
+var OptimizationMode;
+(function (OptimizationMode) {
+    OptimizationMode["PROFESSIONAL"] = "professional";
+    OptimizationMode["CONCISE"] = "concise";
+    OptimizationMode["GRAMMAR"] = "grammar";
+    OptimizationMode["SENIOR_DEVELOPER"] = "senior_developer";
+})(OptimizationMode || (exports.OptimizationMode = OptimizationMode = {}));
+//# sourceMappingURL=index.js.map

package/dist/utils/display.js

@@ -0,0 +1,80 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.displayWelcome = displayWelcome;
+exports.displayModeInfo = displayModeInfo;
+exports.displayOptimization = displayOptimization;
+exports.displayDiff = displayDiff;
+exports.displayError = displayError;
+exports.displaySuccess = displaySuccess;
+exports.displayInfo = displayInfo;
+exports.displayWarning = displayWarning;
+exports.displayHelp = displayHelp;
+exports.displayHistoryEntry = displayHistoryEntry;
+const chalk_1 = __importDefault(require("chalk"));
+const diff_1 = require("diff");
+const templates_1 = require("../prompts/templates");
+function displayWelcome() {
+    console.log(chalk_1.default.cyan.bold('\n🚀 English Optimizer CLI\n'));
+}
+function displayModeInfo(mode) {
+    const modeInfo = (0, templates_1.getModeInfo)(mode);
+    console.log(chalk_1.default.yellow(`\n[${modeInfo.name} Mode]`));
+    console.log(chalk_1.default.gray(modeInfo.description));
+}
+function displayOptimization(original, optimized) {
+    console.log(chalk_1.default.gray('\n' + '─'.repeat(60)));
+    // Show original
+    console.log(chalk_1.default.red('\n❌ Original:'));
+    console.log(chalk_1.default.gray(original));
+    // Show optimized
+    console.log(chalk_1.default.green('\n✅ Optimized:'));
+    console.log(chalk_1.default.white(optimized));
+    console.log(chalk_1.default.gray('\n' + '─'.repeat(60)));
+}
+function displayDiff(original, optimized) {
+    const differences = (0, diff_1.diffLines)(original, optimized);
+    differences.forEach((part) => {
+        const color = part.added ? chalk_1.default.green : part.removed ? chalk_1.default.red : chalk_1.default.gray;
+        const prefix = part.added ? '+ ' : part.removed ? '- ' : '  ';
+        process.stdout.write(color(prefix + part.value));
+    });
+    console.log();
+}
+function displayError(error) {
+    const message = typeof error === 'string' ? error : error.message;
+    console.log(chalk_1.default.red('\n❌ Error:'), chalk_1.default.white(message));
+}
+function displaySuccess(message) {
+    console.log(chalk_1.default.green('\n✅'), chalk_1.default.white(message));
+}
+function displayInfo(message) {
+    console.log(chalk_1.default.cyan('\nℹ️'), chalk_1.default.white(message));
+}
+function displayWarning(message) {
+    console.log(chalk_1.default.yellow('\n⚠️'), chalk_1.default.white(message));
+}
+function displayHelp() {
+    console.log(chalk_1.default.cyan('\n📖 Hotkeys:\n'));
+    console.log(chalk_1.default.gray('  Ctrl+P - Professional tone'));
+    console.log(chalk_1.default.gray('  Ctrl+C - Concise version'));
+    console.log(chalk_1.default.gray('  Ctrl+G - Grammar fix'));
+    console.log(chalk_1.default.gray('  Ctrl+D - Senior developer style'));
+    console.log(chalk_1.default.gray('  Ctrl+R - Reset to original'));
+    console.log(chalk_1.default.gray('  Ctrl+H - View history'));
+    console.log(chalk_1.default.gray('  Ctrl+Q - Quit\n'));
+}
+function displayHistoryEntry(entry) {
+    console.log(chalk_1.default.gray('\n' + '─'.repeat(60)));
+    console.log(chalk_1.default.cyan(`\nID: ${entry.id}`));
+    console.log(chalk_1.default.gray(`Time: ${entry.timestamp.toLocaleString()}`));
+    console.log(chalk_1.default.yellow(`Mode: ${(0, templates_1.getModeInfo)(entry.mode).name}`));
+    console.log(chalk_1.default.red('\n❌ Original:'));
+    console.log(chalk_1.default.gray(entry.original));
+    console.log(chalk_1.default.green('\n✅ Optimized:'));
+    console.log(chalk_1.default.white(entry.optimized));
+    console.log(chalk_1.default.gray('\n' + '─'.repeat(60)));
+}
+//# sourceMappingURL=display.js.map

package/docker-compose.yml

@@ -0,0 +1,22 @@
+version: '3.8'
+
+services:
+  ollama:
+    image: ollama/ollama:latest
+    container_name: english-optimizer-ollama
+    ports:
+      - "11434:11434"
+    volumes:
+      - ollama_data:/root/.ollama
+    environment:
+      - OLLAMA_HOST=0.0.0.0
+    restart: unless-stopped
+    healthcheck:
+      test: ["CMD", "curl", "-f", "http://localhost:11434/api/tags"]
+      interval: 30s
+      timeout: 10s
+      retries: 5
+
+volumes:
+  ollama_data:
+    driver: local

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "english-optimizer-cli",
+  "version": "1.0.0",
+  "description": "CLI tool to help non-native English speakers improve their writing using AI",
+  "main": "dist/index.js",
+  "bin": {
+    "fuck-abc": "./dist/index.js"
+  },
+  "scripts": {
+    "build": "tsc",
+    "start": "node dist/index.js",
+    "dev": "ts-node src/index.ts",
+    "watch": "tsc --watch",
+    "install-config": "node scripts/install-config.js"
+  },
+  "keywords": [
+    "cli",
+    "english",
+    "learning",
+    "ai",
+    "optimizer"
+  ],
+  "author": "",
+  "license": "MIT",
+  "dependencies": {
+    "axios": "^1.6.0",
+    "chalk": "^5.3.0",
+    "cli-cursor": "^4.0.0",
+    "clipboardy": "^3.0.0",
+    "commander": "^12.0.0",
+    "diff": "^5.1.0",
+    "dotenv": "^16.3.0",
+    "inquirer": "^9.2.0",
+    "js-yaml": "^4.1.0",
+    "keypress": "^0.2.1",
+    "ora": "^8.0.0",
+    "uuid": "^9.0.0",
+    "zod": "^3.22.0"
+  },
+  "devDependencies": {
+    "@types/diff": "^5.0.0",
+    "@types/inquirer": "^9.0.0",
+    "@types/js-yaml": "^4.0.9",
+    "@types/node": "^20.10.0",
+    "@types/uuid": "^9.0.0",
+    "eslint": "^8.55.0",
+    "prettier": "^3.1.0",
+    "ts-node": "^10.9.0",
+    "typescript": "^5.3.0"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  }
+}

package/prompt.yaml

@@ -0,0 +1,48 @@
+role:
+  name: Native English Full-Stack Engineer Coach
+  description: >
+    You are a senior full-stack software engineer who is a native English speaker.
+    You have strong experience in frontend, backend, system design, and real-world
+    engineering collaboration. You communicate naturally, clearly, and professionally,
+    just like in daily standups, design reviews, and team discussions.
+
+goals:
+  - Help the user learn natural, spoken English used by software engineers
+  - Translate the user's input into idiomatic, native-level English
+  - Optimize wording to sound natural, confident, and professional
+  - Match the tone of real workplace communication (meetings, chats, reviews)
+
+user_profile:
+  background: Software Engineer
+  native_language: Chinese
+  learning_goal: Improve practical English for daily engineering communication
+
+instructions:
+  - Always assume the user wants to improve their English, not just get a literal translation
+  - Rewrite the input in a way a native English-speaking engineer would naturally say it
+  - Prefer conversational, work-friendly language over academic or overly formal English
+  - Keep sentences concise and clear, like real team communication
+  - Avoid textbook-style translations or unnatural phrasing
+  - If multiple natural expressions are possible, choose the most commonly used one
+
+output_format:
+  style: >
+    Natural, spoken English commonly used in engineering teams.
+    Sounds like real conversations in meetings, Slack, or code reviews.
+  structure:
+    - Optimized English version
+    - (Optional) A brief explanation of why this phrasing is more natural
+
+examples:
+  - input: '这个需求我已经完成了，但是还需要再测试一下'
+    output: >
+      I've finished this feature, but I still need to do some more testing.
+
+  - input: '这个问题我稍后再跟进'
+    output: >
+      I'll follow up on this later.
+
+constraints:
+  - Do not over-explain unless the user explicitly asks
+  - Do not change the original meaning
+  - Do not use overly complex vocabulary unless it fits real engineering conversations