infographic-cli 0.1.0 → 0.4.0

package/CHANGELOG.md

@@ -8,8 +8,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [0.1.0] - 2025-01-20
 
 ### Added
-- Initial release of `@antv/infographic-cli`
-- Simple command `ifgc` to render infographics from .info files to SVG
+- Initial release of `infographic-cli`
+- Simple command `ifgc` to render infographics from .ifgc files to SVG
 - Support for 236+ built-in infographic templates
 - `template` command to list all available templates
 - Theme support (`--theme` option)
@@ -19,7 +19,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Comprehensive test suite (26 tests)
 
 ### Features
-- Render from file: `ifgc -i input.info -o output.svg`
+- Render from file: `ifgc -i input.ifgc -o output.svg`
 - Render from stdin: `echo "..." | ifgc -o output.svg`
 - List templates: `ifgc template`
 - Automatic output file naming (defaults to input.svg)

package/README.md

@@ -1,8 +1,8 @@
-# @antv/infographic-cli
+# infographic-cli
 
-[![npm version](https://badge.fury.io/js/%40antv%2Finfographic-cli.svg)](https://www.npmjs.com/package/@antv/infographic-cli)
+[![npm version](https://badge.fury.io/js/infographic-cli.svg)](https://www.npmjs.com/package/infographic-cli)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-[![Node.js Version](https://img.shields.io/node/v/%40antv%2Finfographic-cli.svg)](https://www.npmjs.com/package/@antv/infographic-cli)
+[![Node.js Version](https://img.shields.io/node/v/infographic-cli.svg)](https://www.npmjs.com/package/infographic-cli)
 
 Command-line interface for [AntV Infographic](https://github.com/antvis/Infographic) - render declarative infographic syntax to SVG images.
 
@@ -10,18 +10,18 @@ Command-line interface for [AntV Infographic](https://github.com/antvis/Infograp
 
 ```bash
 # Install
-npm install -g @antv/infographic-cli
+npm install -g infographic-cli
 
-# Render from stdin
-echo 'infographic list-row-simple-horizontal-arrow
+# Render from string (quickest for testing)
+ifgc -s "infographic list-row-simple-horizontal-arrow
 data
   title My First Infographic
   items
     - label Step 1
-    - label Step 2' | ifgc -o output.svg
+    - label Step 2" -o output.svg
 
 # Render from file
-ifgc -i input.info -o output.svg
+ifgc -i input.ifgc -o output.svg
 
 # List available templates
 ifgc template
@@ -30,7 +30,7 @@ ifgc template
 ## Installation
 
 ```bash
-npm install -g @antv/infographic-cli
+npm install -g infographic-cli
 ```
 
 This installs two commands: `ifgc` (short) and `infographic` (long).
@@ -40,24 +40,32 @@ This installs two commands: `ifgc` (short) and `infographic` (long).
 ### Basic Rendering
 
 ```bash
+# From string (quickest for testing)
+ifgc -s "infographic list-row-simple-horizontal-arrow
+data
+  title My Chart
+  items
+    - label Item 1" -o output.svg
+
 # From file (output defaults to input.svg)
-ifgc -i input.info
+ifgc -i input.ifgc
 
 # Specify output file
-ifgc -i input.info -o output.svg
+ifgc -i input.ifgc -o output.svg
 
 # From stdin
 echo '...' | ifgc -o output.svg
 
 # From stdin with file input
-cat input.info | ifgc -o output.svg
+cat input.ifgc | ifgc -o output.svg
 ```
 
 ### Options
 
 | Option | Description |
 |--------|-------------|
-| `-i, --input <file>` | Input .info file (omit to read from stdin) |
+| `-s, --string <content>` | Input .ifgc content as a string |
+| `-i, --input <file>` | Input .ifgc file |
 | `-o, --output <file>` | Output file (default: input.svg) |
 | `--background <color>` | Background color (default: transparent) |
 | `-c, --config <file>` | JSON configuration file |
@@ -77,7 +85,7 @@ Visit [AntV Infographic](https://github.com/antvis/Infographic) to see template
 ### Example 1: Simple Step List
 
 ```bash
-cat > steps.info << EOF
+cat > steps.ifgc << EOF
 infographic list-row-simple-horizontal-arrow
 data
   title Getting Started
@@ -91,13 +99,13 @@ data
       desc Export and share
 EOF
 
-ifgc -i steps.info -o steps.svg
+ifgc -i steps.ifgc -o steps.svg
 ```
 
 ### Example 2: Timeline
 
 ```bash
-cat > timeline.info << EOF
+cat > timeline.ifgc << EOF
 infographic timeline-horizontal-basic-date
 data
   title Project Roadmap
@@ -112,13 +120,13 @@ data
       desc Launch
 EOF
 
-ifgc -i timeline.info -o timeline.svg
+ifgc -i timeline.ifgc -o timeline.svg
 ```
 
 ### Example 3: Using Theme
 
 ```bash
-cat > swot.info << EOF
+cat > swot.ifgc << EOF
 infographic compare-quadrant-four-areas-card
 data
   title SWOT Analysis
@@ -133,7 +141,7 @@ data
       desc External risks
 EOF
 
-ifgc -i swot.info -o swot.svg -t dark
+ifgc -i swot.ifgc -o swot.svg -t dark
 ```
 
 ### Example 4: From stdin

package/dist/commands/render.js

@@ -4,9 +4,13 @@ import { error, info, success } from '../utils/error.js';
 import { getInputData } from '../utils/input.js';
 import { getDefaultOutput, writeOutput } from '../utils/output.js';
 export async function renderCommand(options) {
-    const { input, output: userOutput, quiet, config: configFile, theme, } = options;
+    const { input, string: stringInput, output: userOutput, quiet, config: configFile, theme, } = options;
     const log = quiet ? () => { } : info;
-    // Validate input
+    // Validate input - cannot use both input file and string
+    if (input && stringInput) {
+        error('Cannot use both --input and --string options. Please use one.');
+    }
+    // Validate input file exists
     if (input && input !== '-') {
         try {
             await fs.access(input);
@@ -39,7 +43,14 @@ export async function renderCommand(options) {
         output = '/dev/stdout';
     }
     // Read input data
-    const inputData = await getInputData(input && input !== '-' ? input : undefined);
+    let inputData;
+    if (stringInput) {
+        // Convert \n to actual newlines and unescape other escape sequences
+        inputData = stringInput.replace(/\\n/g, '\n').replace(/\\t/g, '\t');
+    }
+    else {
+        inputData = await getInputData(input && input !== '-' ? input : undefined);
+    }
     if (!inputData.trim()) {
         error('No input data provided');
     }

package/dist/index.js

@@ -13,7 +13,8 @@ program
     .version(packageJson.default.version);
 // Main options (render by default, like mmdc)
 program
-    .option('-i, --input <file>', 'Input .info file (omit to read from stdin)')
+    .option('-i, --input <file>', 'Input .ifgc file (omit to read from stdin)')
+    .option('-s, --string <content>', 'Input .ifgc content as a string (use \\n for newlines)')
     .option('-o, --output <file>', 'Output file (default: input file with .svg extension)')
     .option('--background <color>', 'Background color (default: transparent)', 'transparent')
     .option('-c, --config <file>', 'JSON configuration file')

package/dist-types/commands/render.d.ts

@@ -1,5 +1,6 @@
 export interface RenderOptions {
     input?: string;
+    string?: string;
     output?: string;
     background?: string;
     quiet?: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "infographic-cli",
-  "version": "0.1.0",
+  "version": "0.4.0",
   "description": "Command-line interface for AntV Infographic",
   "license": "MIT",
   "author": "lyw405",