cstyler 3.0.0 → 4.0.0

package/README.md

@@ -1,31 +1,73 @@
-# CSTYLER
-Hello World!
+# CSTYLER 🎨
+**A lightweight, powerful console styler by kormoi.com**
 
-Style your console log with your cstyler package by kormoi.com
+`cstyler` is a zero-dependency Node.js toolkit designed to make your terminal output beautiful. It features an intuitive chainable API, support for HEX/RGB colors, and a unique nested inline styling system.
 
-This cstyler kit is fully free to use. You can colorize your console log useing this kit. You can use dot notation to add more style like 'bold, underline, italic, dark(for color), bg for background'. You have all red, green, blue, yellow, cyan, purpal, colors on both text color and background color.
+---
 
-You can not use two color names e.g. 'red.blue'.
-How to use:
-INSTALLING:
+## 🚀 Key Features
+* **Auto-Detection:** Automatically strips styles if the terminal doesn't support them (perfect for logs).
+* **Chainable API:** Mix styles easily using dot notation.
+* **TrueColor Support:** Use HEX and RGB for millions of colors.
+* **Smart Nesting:** Complex nested styling using tagged template literals.
+* **No Overhead:** Built to be fast and lightweight.
 
-> npm install cstyler
->
+---
 
-Then it will install packages.
-IMPORT:
-const cstyle = require("cstyle");
+## 📦 Installation
 
-USE:
-console.log(cstyle.bold.underline.italic.dark.yellow("Here goes your text"));
+```bash
+npm install cstyler
+```
+## 🛠 Usage
+### 1. Basic Styling (Chainable)
+You can combine text styles and colors using simple dot notation.
+JavaScript
+```js
+const cstyler = require("cstyler");
 
-You can add these colors by name: red, green, blue, yellow, purpal, grey. You can darken them with a .dark property accessor. You can add rbg, hex, bgrgb and bghex color using .hex('#123456'), and rgb(100,100,100) and same for bg hex and bg rgb.
+// Bold, Underline, and Yellow text
+console.log(cstyler.bold.underline.yellow("Hello World!"));
 
-Feel free to use.
-<<<<<<< HEAD
-Regards from kormoi.com
-=======
-Regards from
-kormoi.com
-MD NASIRUDDIN AHMED
->>>>>>> 7cb483c (Second commit)
+// Darkened green text
+console.log(cstyler.green.dark("Subtle green message"));
+```
+### 2. Custom Colors (HEX & RGB)
+Go beyond the standard 16 colors with TrueColor support.
+JavaScript
+```js
+// Foreground Colors
+console.log(cstyler.hex('#FF5733')("Vibrant Orange"));
+console.log(cstyler.rgb(100, 150, 200)("Custom Blue"));
+
+// Background Colors
+console.log(cstyler.bgHex('#333').white("White text on dark grey"));
+```
+### 3. Inline Nested Styling (Tagged Templates)
+This is the most powerful way to style complex strings. Use {style text} syntax inside backticks.
+JavaScript
+```js
+console.log(cstyler`
+  {bold.red Critical Error:} {italic.gray Connection failed.} 
+  {bold.green Success! {italic.white kormoi.com is online.}}
+  {hex('#00dbde').bold Powerful custom colors work inside too!}
+`);
+```
+🎨 Available Styles
+| Category | Available Properties |
+| :--- | :--- |
+| **Formatting** | bold, italic, underline, dark |
+| **Colors** | red, green, blue, yellow, purple, cyan, white, gray, magenta |
+| **Backgrounds** | bgRed, bgGreen, bgBlue, bgYellow, bgPurple, bgGray |
+| **Custom** | .hex(), .rgb(), .bgHex(), .bgRgb() |
+
+> Note: You cannot use two foreground colors at once (e.g., red.blue). The last color in the chain will take priority.
+
+## 🛡 Smart Terminal Detection
+`cstyler` is smart. If you pipe your output to a file or run it in an environment that doesn't support ANSI colors, it will **silently return plain text.** Your logs will remain clean and readable without any "garbage" characters.
+
+## 👨‍💻 Author
+### MD NASIRUDDIN AHMED
+Visit us at: kormoi.com
+
+`Feel free to use and contribute! Regards from kormoi.com.`

package/index.js

@@ -1,5 +1,9 @@
 class cstyler {
   constructor() {
+    // SILENT CHECK: No printing, just querying the environment
+    this.enabled = process.stdout.isTTY && 
+                   (process.stdout.getColorDepth ? process.stdout.getColorDepth() > 1 : true);
+
     this.styleMap = {
       // Text styles
       bold: ['\x1b[1m', '\x1b[22m'],
@@ -31,244 +35,104 @@ class cstyler {
   }
 
   createStyler(styles) {
-    const styler = (text) =>
-      styles.reduce((str, { open, close }) => open + str + close, text);
+    const styler = (text) => {
+      // Return plain text if terminal doesn't support styling
+      if (!this.enabled) return text;
+      return styles.reduce((str, { open, close }) => open + str + close, text);
+    };
 
-    const addStyle = (open, close) =>
-      this.createStyler([...styles, { open, close }]);
+    const addStyle = (open, close) => this.createStyler([...styles, { open, close }]);
 
+    // Map standard styles
     for (const [name, [open, close]] of Object.entries(this.styleMap)) {
       Object.defineProperty(styler, name, {
-        get: () => addStyle(open, close),
+        get: () => this.enabled ? addStyle(open, close) : styler,
       });
     }
 
-    // RGB foreground color
+    // RGB Support
     styler.rgb = (r, g, b) => {
-      if (![r, g, b].every((n) => Number.isInteger(n) && n >= 0 && n <= 255)) {
-        console.error('Invalid RGB value. Falling back to white.');
-        return addStyle('\x1b[37m', '\x1b[39m');
-      }
+      if (!this.enabled) return styler;
       return addStyle(`\x1b[38;2;${r};${g};${b}m`, '\x1b[39m');
     };
 
-    // Hex foreground color
+    // Hex Support
     styler.hex = (hex) => {
-      try {
-        if (typeof hex !== 'string') throw new Error();
-        hex = hex.replace(/^#/, '').slice(0, 6);
-        const r = parseInt(hex.slice(0, 2), 16);
-        const g = parseInt(hex.slice(2, 4), 16);
-        const b = parseInt(hex.slice(4, 6), 16);
-        return styler.rgb(r, g, b);
-      } catch {
-        console.error('Invalid hex color. Falling back to white.');
-        return addStyle('\x1b[37m', '\x1b[39m');
-      }
-    };
-
-    // HSL to RGB conversion helper
-    function hslToRgb(h, s, l) {
-      s /= 100;
-      l /= 100;
-      const k = (n) => (n + h / 30) % 12;
-      const a = s * Math.min(l, 1 - l);
-      const f = (n) =>
-        l - a * Math.max(-1, Math.min(k(n) - 3, Math.min(9 - k(n), 1)));
-      return [Math.round(255 * f(0)), Math.round(255 * f(8)), Math.round(255 * f(4))];
-    }
-
-    styler.hsl = (h, s, l) => {
-      if (
-        typeof h !== 'number' ||
-        h < 0 ||
-        h > 360 ||
-        typeof s !== 'number' ||
-        s < 0 ||
-        s > 100 ||
-        typeof l !== 'number' ||
-        l < 0 ||
-        l > 100
-      ) {
-        console.error('Invalid HSL value. Falling back to white.');
-        return addStyle('\x1b[37m', '\x1b[39m');
-      }
-      const [r, g, b] = hslToRgb(h, s, l);
+      if (!this.enabled) return styler;
+      const cleanHex = hex.replace(/^#/, '');
+      const r = parseInt(cleanHex.slice(0, 2), 16);
+      const g = parseInt(cleanHex.slice(2, 4), 16);
+      const b = parseInt(cleanHex.slice(4, 6), 16);
       return styler.rgb(r, g, b);
     };
 
-    // Parse tagged template literals with inline nested styles
+    // Tagged Template Parser
     styler.tag = (strings, ...values) => {
-      let fullText = '';
-      for (let i = 0; i < strings.length; i++) {
-        fullText += strings[i];
-        if (i < values.length) fullText += values[i];
-      }
+      const fullText = strings.reduce((acc, str, i) => acc + str + (values[i] || ''), '');
       return this.parseInlineStyles(fullText);
     };
 
-    // Helper: parse parameters string to array for hex, rgb, hsl
-    this.parseParameters = (paramStr) => {
-      // Remove spaces outside quotes, split by commas respecting quotes
-      const params = [];
-      let current = '';
-      let inQuotes = false;
-      for (let c of paramStr.trim()) {
-        if (c === "'" || c === '"') {
-          inQuotes = !inQuotes;
-          current += c;
-        } else if (c === ',' && !inQuotes) {
-          if (current.length) params.push(current.trim());
-          current = '';
-        } else {
-          current += c;
-        }
-      }
-      if (current.length) params.push(current.trim());
-      // Remove quotes from strings
-      return params.map((p) => p.replace(/^['"]|['"]$/g, ''));
-    };
-
-    // Recursive parser for nested inline styles with support for parameterized styles
     this.parseInlineStyles = (text) => {
-      const parse = (str, start = 0) => {
-        let result = '';
-        let i = start;
-
+      const parse = (str) => {
+        let result = '', i = 0;
         while (i < str.length) {
           if (str[i] === '{') {
-            // Find matching closing brace for nested block
-            let level = 1;
-            let j = i + 1;
+            let level = 1, j = i + 1;
             while (j < str.length && level > 0) {
               if (str[j] === '{') level++;
               else if (str[j] === '}') level--;
               j++;
             }
-            if (level !== 0) {
-              // Unmatched brace, treat literally
-              result += str.slice(i);
-              break;
-            }
+            if (level !== 0) { result += str.slice(i); break; }
 
-            // Extract content between braces
             const content = str.slice(i + 1, j - 1);
-
-            // Find first space to separate styles from text
             const spaceIdx = content.indexOf(' ');
 
             if (spaceIdx === -1) {
-              // No space, treat as literal text with braces
               result += '{' + content + '}';
             } else {
               const styleStr = content.slice(0, spaceIdx);
               const innerText = content.slice(spaceIdx + 1);
-
-              // Parse styles separated by '.'
-              // But styles may have params, like hex('#ff00ff'), rgb(255,0,0)
-              const styleParts = [];
-
-              let currentStyle = '';
-              let parenLevel = 0;
-              for (let ch of styleStr) {
-                if (ch === '.' && parenLevel === 0) {
-                  if (currentStyle) styleParts.push(currentStyle);
-                  currentStyle = '';
-                } else {
-                  if (ch === '(') parenLevel++;
-                  else if (ch === ')') parenLevel--;
-                  currentStyle += ch;
+              const parsedInner = parse(innerText);
+
+              if (!this.enabled) {
+                result += parsedInner;
+              } else {
+                // regex: match style name OR styleName(params)
+                const styleParts = styleStr.match(/(\w+(\([^)]*\))?)/g) || [];
+                let styledText = parsedInner;
+
+                for (let part of styleParts.reverse()) {
+                  if (part.startsWith('hex')) {
+                    const val = part.match(/\(([^)]+)\)/)?.[1].replace(/['"]/g, '');
+                    styledText = styler.hex(val)(styledText);
+                  } else if (part.startsWith('rgb')) {
+                    const vals = part.match(/\(([^)]+)\)/)?.[1].split(',').map(Number);
+                    styledText = styler.rgb(...vals)(styledText);
+                  } else if (this.styleMap[part]) {
+                    const [open, close] = this.styleMap[part];
+                    styledText = open + styledText + close;
+                  }
                 }
+                result += styledText;
               }
-              if (currentStyle) styleParts.push(currentStyle);
-
-              // Parse inner text recursively (to support nested styles)
-              const parsedInner = parse(innerText, 0);
-
-              // Apply styles in order (left to right)
-              let styledText = parsedInner;
-
-              for (let style of styleParts.reverse()) {
-                // Check if style has parameters (like hex(...))
-                let name = style;
-                let params = null;
-
-                const paramStart = style.indexOf('(');
-                if (paramStart !== -1 && style.endsWith(')')) {
-                  name = style.slice(0, paramStart);
-                  const paramStr = style.slice(paramStart + 1, -1);
-                  params = this.parseParameters(paramStr);
-                }
-
-                // Handle styles
-                if (name === 'hex' && params && params.length === 1) {
-                  styledText = this.styleMap[name]
-                    ? this.applyStyle(styledText, this.styleMap[name])
-                    : styler.hex(params[0])(styledText);
-                } else if (
-                  name === 'rgb' &&
-                  params &&
-                  params.length === 3 &&
-                  params.every((p) => !isNaN(p))
-                ) {
-                  styledText = styler.rgb(
-                    parseInt(params[0]),
-                    parseInt(params[1]),
-                    parseInt(params[2])
-                  )(styledText);
-                } else if (
-                  name === 'hsl' &&
-                  params &&
-                  params.length === 3 &&
-                  params.every((p) => !isNaN(p))
-                ) {
-                  styledText = styler.hsl(
-                    parseFloat(params[0]),
-                    parseFloat(params[1]),
-                    parseFloat(params[2])
-                  )(styledText);
-                } else if (this.styleMap[name]) {
-                  const [open, close] = this.styleMap[name];
-                  styledText = open + styledText + close;
-                } else {
-                  console.warn(`Unknown style: ${style}`);
-                }
-              }
-
-              result += styledText;
             }
-
             i = j;
           } else {
-            result += str[i];
-            i++;
+            result += str[i++];
           }
         }
-
         return result;
       };
       return parse(text);
     };
 
-    // Helper to apply raw style array (for internal use)
-    this.applyStyle = (text, [open, close]) => open + text + close;
-
     return new Proxy(styler, {
-      apply: (target, thisArg, args) => {
-        // Tagged template literal usage
-        if (Array.isArray(args[0]) && 'raw' in args[0]) {
-          return styler.tag(...args);
-        }
-        // Direct call with string
-        return styler(...args);
-      },
-      get: (target, prop) => {
-        if (prop in styler) return styler[prop];
-        console.warn(`Invalid style: ${String(prop)}`);
-        return styler;
-      },
+      apply: (target, thisArg, args) => 
+        (Array.isArray(args[0]) && 'raw' in args[0]) ? styler.tag(...args) : styler(...args),
+      get: (target, prop) => (prop in styler) ? styler[prop] : styler,
     });
   }
 }
 
-module.exports = new cstyler();
+module.exports = new cstyler();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cstyler",
-  "version": "3.0.0",
+  "version": "4.0.0",
   "description": "Chainable terminal text styling tool (bold, colors, etc.)",
   "main": "index.js",
   "keywords": [
@@ -10,7 +10,16 @@
     "chainable",
     "bold",
     "style",
-    "styler"
+    "styler",
+    "ansi",
+    "colors",
+    "terminal",
+    "styling",
+    "cli",
+    "template",
+    "rgb",
+    "hex",
+    "hsl"
   ],
   "author": "MD Nasiruddin Ahmed",
   "license": "ISC",

package/readme.txt

@@ -1,23 +0,0 @@
-# cstyler
-Hello World!
-
-You can style with color and style on the console text with this package
-
-This cstyler kit is fully free to use. You can colorize your console log useing this kit. You can use dot notation to add more style like 'bold, underline, italic, dark(for color), bg for background'. You have all red, green, blue, yellow, cyan, purpal, colors on both text color and background color.
-
-You can not use two color names e.g. 'red.blue'.
-How to use:
-INSTALLING:
-
-> npm install cstyler
->
-
-Then it will install packages.
-IMPORT:
-const cstyle = require("cstyle");
-
-USE:
-console.log(cstyle.bold.underline.italic.dark.yellow("Here goes your text"));
-
-Feel free to use.
-Regards from kormoi.com