xw-devtool-cli 1.0.17 → 1.0.18

package/README_EN.md

@@ -0,0 +1,225 @@
+# xw-devtool-cli
+
+[中文文档](./README.md) | **English**
+
+A Node.js-based developer command-line toolbox designed to provide out-of-the-box common development tools to help developers handle daily tasks quickly.
+
+Key features include: Base64 encoding/decoding, image format conversion, image <-> Base64, Mock data generation, timestamp/date formatting, time calculation, URL encoding/decoding, UUID generation, Chinese pinyin conversion, color conversion, variable format conversion, hash calculation, QR code generation, special symbols, Markdown snippets, VS Code snippet generation, etc. All results are automatically copied to the clipboard, greatly improving development efficiency.
+
+## ✨ Features
+
+- **Base64 Tools**: Convert strings to/from Base64, supports reading from clipboard, file, or manual input.
+- **Image Tools**:
+  - **Format Conversion**: Convert between PNG, JPG, WebP, with adjustable compression quality.
+  - **Image ↔ Base64**: Convert images to Base64 strings and vice versa.
+  - **Placeholder Image**: Quickly generate placeholder images with custom size, color, and text.
+- **Mock Data**:
+  - Generate: Lorem Ipsum, Chinese characters, ID cards, Emails, URLs, Order IDs, Phone numbers.
+  - Supports batch generation.
+- **Time Tools**:
+  - **Formatting**: Timestamp/Date string -> `YYYY-MM-DD HH:mm:ss`.
+  - **Timestamp**: Quickly get current millisecond timestamp.
+  - **Calculation**: Calculate date differences or offsets (Add/Subtract).
+- **Dev Tools**:
+  - **URL Encode/Decode**
+  - **Unicode Encode/Decode**: Text <-> Unicode escape sequences (\uXXXX).
+  - **UUID**: Generate UUID v4.
+  - **Pinyin**: Convert Chinese characters to Pinyin (without tone).
+  - **Color Converter**: Hex <-> RGB.
+  - **Variable Format**: CamelCase, PascalCase, SnakeCase, KebabCase, ConstantCase.
+  - **Hash Calculator**: MD5, SHA1, SHA256, SHA512, SM3.
+  - **QR Code**: Display QR codes in terminal, save as PNG.
+  - **Special Symbols**: 170+ symbols, arrows, math symbols, etc.
+  - **Emoji Picker**: Browse and copy emojis.
+  - **HTML Entity**: Encode/Decode HTML entities.
+  - **Markdown Snippets**: Common Markdown templates.
+  - **VS Code Snippets**: Generate VS Code snippet JSON from code.
+- **Convenience**:
+  - File selection dialog (Windows).
+  - Auto-copy results to clipboard.
+  - Auto-read from clipboard.
+  - Save large results to file.
+- **Internationalization (i18n)**:
+  - Support **English** and **Chinese**.
+  - Switch via **Settings** in the menu or use CLI flags: `xw-devtool --en` / `xw-devtool --zh`.
+
+## 📦 Installation
+
+### Global Installation (Recommended)
+```bash
+npm install -g xw-devtool-cli
+```
+After installation, use `xw-devtool` or `xw-dev` command.
+
+### Run via npx
+```bash
+npx xw-devtool-cli@latest
+```
+
+## 🚀 Quick Start
+
+Run in terminal:
+```bash
+xw-devtool
+```
+
+Or specify language directly:
+```bash
+xw-devtool --en  # Start in English
+xw-devtool --zh  # Start in Chinese
+```
+
+The interactive menu will appear:
+
+```text
+=================================
+      xw-devtool-cli Menu
+=================================
+1. Image <-> Base64
+2. Image Format Convert
+3. Placeholder Image Generator
+4. QR Code Generator
+5. URL Encode/Decode
+6. String Encode/Decode (Base64)
+7. Unicode Encode/Decode
+8. HTML Entity Encode/Decode
+9. Variable Format Converter
+a. JSON Format (Minify/Prettify)
+b. Chinese to Pinyin
+c. Time Format / Timestamp
+d. Time Calculation (Diff/Offset)
+e. Color Converter (Hex <-> RGB)
+f. Get UUID
+g. Hash Calculator (MD5/SHA/SM3)
+h. Mock Text
+i. Special Characters (Symbols)
+j. Emoji Picker
+k. Markdown Snippets
+l. VS Code Snippet Generator
+s. Settings (Language)
+0. Exit
+=================================
+```
+
+## 📖 Detailed Usage
+
+### 1. Image <-> Base64
+- Select `1`.
+- **Image -> Base64**:
+  - Select image file.
+  - Output Base64 string (can save to `.txt`).
+- **Base64 -> Image**:
+  - Input Base64 string (file or clipboard).
+  - Auto-detect format and save as file.
+
+### 2. Image Format Convert
+- Select `2`.
+- Select source image.
+- Select target format (PNG / JPG / WebP).
+- Set quality/compression.
+- Saved in the same directory.
+
+### 3. Placeholder Image Generator
+- Select `3`.
+- **Mode 1: Local Image File**
+  - Generate file locally.
+  - Customize: Size, Colors, Text, Format.
+- **Mode 2: Remote Image URL**
+  - Generate URL and copy to clipboard.
+  - Supports: Picsum Photos, DummyImage, Via Placeholder, Placehold.jp, DevTool Tech, FPO Img.
+
+### 4. QR Code Generator
+- Select `4`.
+- Input text or URL.
+- Preview in terminal.
+- Option to save as PNG.
+
+### 5. URL Encode/Decode
+- Select `5`.
+- Select `Encode` or `Decode`.
+- Input URL, result auto-copied.
+
+### 6. String Base64
+- Select `6`.
+- Input sources: Clipboard, File, Manual.
+- Output: Copy, Save to file.
+
+### 7. Unicode Encode/Decode
+- Select `7`.
+- **Encode**: Text to Unicode escape sequences.
+  - **Non-ASCII Only**: Recommended.
+  - **All Characters**.
+- **Decode**: Unicode to Text.
+
+### 8. HTML Entity Encode/Decode
+- Select `8`.
+- **Standard**: Special chars only.
+- **Everything**: All chars.
+
+### 9. Variable Format Converter
+- Select `9`.
+- Input variable name.
+- Shows CamelCase, PascalCase, SnakeCase, KebabCase, ConstantCase.
+- Select one to copy.
+
+### 10. JSON Format
+- Select `a`.
+- **Minify**: Remove whitespace.
+- **Prettify (2/4 spaces)**.
+- **Note**: Results copied to clipboard only (to avoid flooding terminal).
+
+### 11. Chinese to Pinyin
+- Select `b`.
+- Input Chinese string.
+- Output Pinyin (no tone).
+
+### 12. Time Format
+- Select `c`.
+- Timestamp <-> Date String.
+- Enter to get current timestamp.
+
+### 13. Time Calculation
+- Select `d`.
+- **Diff**: Calculate difference between two dates.
+- **Offset**: Calculate date after add/subtract time units.
+
+### 14. Color Converter
+- Select `e`.
+- Hex <-> RGB.
+
+### 15. Get UUID
+- Select `f`.
+- Generate UUID v4.
+
+### 16. Hash Calculator
+- Select `g`.
+- Input text.
+- Shows MD5, SHA1, SHA256, SHA512, SM3.
+
+### 17. Mock Data
+- Select `h`.
+- Generate Lorem Ipsum, Names, IDs, Emails, Phones, etc.
+
+### 18. Special Symbols
+- Select `i`.
+- Grid view of symbols.
+- Select index to copy.
+
+### 19. Emoji Picker
+- Select `j`.
+- Categorized emojis.
+- Select to copy.
+
+### 20. Markdown Snippets
+- Select `k`.
+- Templates for Headers, Lists, Tables, Links, etc.
+
+### 21. VS Code Snippet Generator
+- Select `l`.
+- Convert code to `.code-snippets` JSON body.
+- Auto-escapes quotes/newlines.
+- Copied to clipboard.
+
+## 📄 License
+
+ISC

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xw-devtool-cli",
-  "version": "1.0.17",
+  "version": "1.0.18",
   "type": "module",
   "description": "基于node的开发者助手cli",
   "main": "index.js",
@@ -11,7 +11,8 @@
   "files": [
     "bin",
     "src",
-    "README.md"
+    "README.md",
+    "README_EN.md"
   ],
   "scripts": {
     "start": "node bin/index.js",