neon-terminal 0.1.0

package/cjs/package.json

@@ -0,0 +1 @@
+{"type":"commonjs"}

package/cjs/src/index.js

@@ -0,0 +1,65 @@
+// neon-terminal — tiny ANSI color + TTY helpers for terminal output.
+
+// Raw ANSI codes. `reset` closes any style.
+const codes = {
+  reset: '\x1b[0m',
+  bold: '\x1b[1m',
+  dim: '\x1b[2m',
+  italic: '\x1b[3m',
+  underline: '\x1b[4m',
+
+  black: '\x1b[30m',
+  red: '\x1b[31m',
+  green: '\x1b[32m',
+  yellow: '\x1b[33m',
+  blue: '\x1b[34m',
+  magenta: '\x1b[35m',
+  cyan: '\x1b[36m',
+  white: '\x1b[37m',
+  grey: '\x1b[90m',
+  gray: '\x1b[90m',
+};
+
+/**
+ * Whether ANSI color should be emitted for a given stream.
+ *
+ * Honors the conventional env switches:
+ *   - NO_COLOR (any value)      → always false
+ *   - FORCE_COLOR (any value)   → always true
+ * Otherwise falls back to `stream.isTTY`.
+ *
+ * @param {{ isTTY?: boolean }} [stream] defaults to process.stdout
+ * @returns {boolean}
+ */
+function supportsColor(stream = process.stdout) {
+  const env = (typeof process !== 'undefined' && process.env) || {};
+  if ('NO_COLOR' in env) return false;
+  if ('FORCE_COLOR' in env) return true;
+  return Boolean(stream && stream.isTTY);
+}
+
+/**
+ * Wrap `text` in the ANSI code(s) named by `style`, followed by a reset.
+ * Returns `text` untouched when the style is unknown or `enabled` is false.
+ *
+ * @param {string} text
+ * @param {string | string[]} style
+ * @param {boolean} [enabled] defaults to supportsColor()
+ * @returns {string}
+ */
+function colorize(text, style, enabled = supportsColor()) {
+  const names = Array.isArray(style) ? style : [style];
+  const open = names.map((n) => codes[n]).filter(Boolean).join('');
+  if (!enabled || !open) return String(text);
+  return `${open}${text}${codes.reset}`;
+}
+
+// Convenience: paint.red('hi'), paint.bold('hi'), ...
+const paint = Object.fromEntries(
+  Object.keys(codes)
+    .filter((name) => name !== 'reset')
+    .map((name) => [name, (text, enabled = true) => colorize(text, name, enabled)])
+);
+
+module.exports = { codes, supportsColor, colorize, paint };
+module.exports.default = module.exports;

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "neon-terminal",
+  "version": "0.1.0",
+  "description": "Tiny ANSI color and TTY helpers for terminal output.",
+  "type": "module",
+  "module": "src/index.js",
+  "main": "cjs/src/index.js",
+  "exports": {
+    "types": "./types/index.d.ts",
+    "import": "./src/index.js",
+    "require": "./cjs/src/index.js",
+    "default": "./cjs/src/index.js"
+  },
+  "types": "types/index.d.ts",
+  "typings": "types/index.d.ts",
+  "engines": {
+    "node": ">=12"
+  },
+  "scripts": {
+    "test": "npm run test:esm && npm run test:cjs",
+    "test:esm": "node test/terminal.test.js",
+    "test:cjs": "node cjs/test/terminal.test.js"
+  },
+  "files": [
+    "/src",
+    "/cjs/src",
+    "/cjs/package.json",
+    "/types"
+  ],
+  "license": "MIT",
+  "keywords": [
+    "terminal",
+    "ansi",
+    "color",
+    "colour",
+    "tty",
+    "neon"
+  ]
+}

package/src/index.js

@@ -0,0 +1,66 @@
+// neon-terminal — tiny ANSI color + TTY helpers for terminal output.
+
+// Raw ANSI codes. `reset` closes any style.
+export const codes = {
+  reset: '\x1b[0m',
+  bold: '\x1b[1m',
+  dim: '\x1b[2m',
+  italic: '\x1b[3m',
+  underline: '\x1b[4m',
+
+  black: '\x1b[30m',
+  red: '\x1b[31m',
+  green: '\x1b[32m',
+  yellow: '\x1b[33m',
+  blue: '\x1b[34m',
+  magenta: '\x1b[35m',
+  cyan: '\x1b[36m',
+  white: '\x1b[37m',
+  grey: '\x1b[90m',
+  gray: '\x1b[90m',
+};
+
+/**
+ * Whether ANSI color should be emitted for a given stream.
+ *
+ * Honors the conventional env switches:
+ *   - NO_COLOR (any value)      → always false
+ *   - FORCE_COLOR (any value)   → always true
+ * Otherwise falls back to `stream.isTTY`.
+ *
+ * @param {{ isTTY?: boolean }} [stream] defaults to process.stdout
+ * @returns {boolean}
+ */
+export function supportsColor(stream = process.stdout) {
+  const env = (typeof process !== 'undefined' && process.env) || {};
+  if ('NO_COLOR' in env) return false;
+  if ('FORCE_COLOR' in env) return true;
+  return Boolean(stream && stream.isTTY);
+}
+
+/**
+ * Wrap `text` in the ANSI code(s) named by `style`, followed by a reset.
+ * Returns `text` untouched when the style is unknown or `enabled` is false.
+ *
+ * @param {string} text
+ * @param {keyof codes | Array<keyof codes>} style
+ * @param {boolean} [enabled] defaults to supportsColor()
+ * @returns {string}
+ */
+export function colorize(text, style, enabled = supportsColor()) {
+  const names = Array.isArray(style) ? style : [style];
+  const open = names.map((n) => codes[n]).filter(Boolean).join('');
+  if (!enabled || !open) return String(text);
+  return `${open}${text}${codes.reset}`;
+}
+
+// Convenience: paint.red('hi'), paint.bold('hi'), ...
+// Each ignores the ambient TTY check unless you pass a second arg, so it always
+// colors — handy when you've already decided color is on.
+export const paint = Object.fromEntries(
+  Object.keys(codes)
+    .filter((name) => name !== 'reset')
+    .map((name) => [name, (text, enabled = true) => colorize(text, name, enabled)])
+);
+
+export default { codes, supportsColor, colorize, paint };

package/types/index.d.ts

@@ -0,0 +1,38 @@
+export type StyleName =
+  | 'reset'
+  | 'bold'
+  | 'dim'
+  | 'italic'
+  | 'underline'
+  | 'black'
+  | 'red'
+  | 'green'
+  | 'yellow'
+  | 'blue'
+  | 'magenta'
+  | 'cyan'
+  | 'white'
+  | 'grey'
+  | 'gray';
+
+export type PaintName = Exclude<StyleName, 'reset'>;
+
+export const codes: Record<StyleName, string>;
+
+export function supportsColor(stream?: { isTTY?: boolean }): boolean;
+
+export function colorize(
+  text: unknown,
+  style: StyleName | StyleName[],
+  enabled?: boolean
+): string;
+
+export const paint: Record<PaintName, (text: unknown, enabled?: boolean) => string>;
+
+declare const _default: {
+  codes: typeof codes;
+  supportsColor: typeof supportsColor;
+  colorize: typeof colorize;
+  paint: typeof paint;
+};
+export default _default;