@hatterjiang/term-color-render 1.0.4 → 1.0.5

package/README.md

@@ -1,18 +1,82 @@
 # term color render
 
+Render ANSI colors for the terminal using a simple tag syntax like `[red]text[/red]`.
+
+## Install
+
+```sh
+npm install @hatterjiang/term-color-render
+```
+
+## Usage
+
 ```js
+// ESM
 import { renderColor } from "@hatterjiang/term-color-render";
 
+// CommonJS
+const { renderColor } = require("@hatterjiang/term-color-render");
+
 console.log(renderColor('hello [red]red world[/red], [bold][green]bold and green text[/green][/bold]'));
 ```
 
+The second argument optionally forces color on (`true`) or off (`false`):
+
+```js
+renderColor("[red]hi[/red]", true);   // "\x1b[31mhi\x1b[0m\x1b[0m"
+renderColor("[red]hi[/red]", false);  // "hi"
+```
+
+When omitted, color is enabled automatically based on the environment.
+
+## Supported tags
+
+Wrap text in a tag to start it and close with the matching `[/tag]`.
+
+```sh
+[red]red text[/red]
+[green]green text[/green]
+[yellow]yellow text[/yellow]
+[blue]blue text[/blue]
+[pink]pink text[/pink]
+[cyan]cyan text[/cyan]
+[bold]bold text[/bold]
+[under]underlined text[/under]
+[blink]blinking text[/blink]
+```
+
+Tags can be nested; closing an inner tag re-applies the outer one:
+
+```
+[bold][green]bold and green text[/green][/bold]
+```
+
+## Escaping
+
+Escape a bracket with a backslash to keep it as literal text:
+
+```
+\[red\]hi   →  [red]hi
+```
+
+## Unknown and unclosed tags
+
+Tags that are not in the list above are left as literal text, and unclosed tags are
+preserved instead of being dropped:
+
+```
+[foo]bar[/foo]   →  [foo]bar[/foo]
+[red             →  [red
+```
+
+## Color detection
+
+When the second argument is omitted, color is controlled by the environment:
+
+- `FORCE_COLOR` — if set, color is enabled unless its value is `"0"`.
+- `NO_COLOR` — if set, color is disabled.
+- Otherwise, color is enabled only when both `stdout` and `stderr` are TTYs.
+
+## TypeScript
 
-Supported colors:
-- `[red]red text[/red]`
-- `[blue]blue text[/blue]`
-- `[green]green text[/green]`
-- `[yellow]yellow text[/yellow]`
-- `[cyan]cyan text[/cyan]`
-- `[pink]cyan text[/pink]`
-- `[bold]bold text[/bold]`
-- `[under]under text[/under]`
+Type definitions are included and resolved automatically.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hatterjiang/term-color-render",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "Render color for term use syntax like [red]text[/red]",
   "license": "MIT",
   "author": "Hatter Jiang",