@maz-ui/node 4.0.0-beta.11

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 LouisMazel
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,244 @@
+# @maz-ui/node
+
+Node.js utilities for Maz-UI ecosystem - Promise-based command execution and colored logging.
+
+## Installation
+
+```bash
+npm install @maz-ui/node
+```
+
+## Features
+
+- 🚀 **Promise-based command execution** with detailed logging
+- 🎨 **Colored console logging** with multiple log levels
+- ⚡ **TypeScript support** with full type safety
+- 📦 **Lightweight** - minimal dependencies
+- 🔧 **Configurable** - customizable logging behavior
+- 🛡️ **Error handling** - comprehensive error management
+
+## Usage
+
+### execPromise
+
+Execute shell commands with promise-based interface and automatic logging.
+
+```typescript
+import { execPromise, logger } from '@maz-ui/node'
+
+// Basic usage
+try {
+  const { stdout } = await execPromise('npm --version')
+  logger.log('npm version:', stdout.trim())
+}
+catch (error) {
+  logger.error('Command failed:', error)
+}
+
+// With options
+await execPromise('npm run build', {
+  packageName: 'my-package', // Adds [my-package] prefix to logs
+  noSuccess: true, // Skip success log
+  noStdout: true, // Skip stdout log
+  noStderr: true, // Skip stderr log
+  logger: customLogger // Use custom logger
+})
+```
+
+#### Options
+
+```typescript
+interface ExecOptions {
+  logger?: Logger // Custom logger instance
+  packageName?: string // Package name for log prefixes
+  noSuccess?: boolean // Skip success logging
+  noStdout?: boolean // Skip stdout logging
+  noStderr?: boolean // Skip stderr logging
+}
+```
+
+### Logger
+
+Colored console logging with multiple levels and error handling.
+
+```typescript
+import { logger } from '@maz-ui/node'
+
+// Basic logging
+logger.log('Regular message')
+logger.success('Operation completed successfully!')
+logger.warn('Warning message')
+logger.error('Error occurred', errorObject)
+
+// Special formatters
+logger.brand('🎨 Maz-UI Brand Message') // Blue bright
+logger.divider() // Prints separator line
+logger.eot() // End of transmission (empty line)
+
+// With error objects
+try {
+  throw new Error('Something went wrong')
+}
+catch (error) {
+  logger.error('Operation failed:', error)
+}
+```
+
+#### Logger Methods
+
+- **`log(...message)`** - Standard console log
+- **`success(...message)`** - Green colored success messages
+- **`warn(message, error?)`** - Yellow colored warnings
+- **`error(message, error?)`** - Red colored error messages
+- **`brand(message)`** - Blue bright branded messages
+- **`divider()`** - Prints a separator line
+- **`eot()`** - Prints an empty line (end of transmission)
+
+## Advanced Examples
+
+### Custom Logger Integration
+
+```typescript
+import { execPromise, logger, type Logger } from '@maz-ui/node'
+
+// Create custom logger with additional functionality
+const customLogger: Logger = {
+  ...logger,
+  log: (...args) => {
+    // eslint-disable-next-line no-console
+    console.log('[CUSTOM]', ...args)
+  }
+}
+
+// Use with execPromise
+await execPromise('npm test', {
+  logger: customLogger,
+  packageName: 'test-suite'
+})
+```
+
+### Build Script Example
+
+```typescript
+import { execPromise, logger } from '@maz-ui/node'
+
+async function buildProject() {
+  logger.brand('🚀 Starting build process...')
+  logger.divider()
+
+  try {
+    // Install dependencies
+    await execPromise('npm install', {
+      packageName: 'setup',
+      noStdout: true
+    })
+
+    // Run tests
+    await execPromise('npm test', {
+      packageName: 'test',
+      noStdout: true
+    })
+
+    // Build project
+    await execPromise('npm run build', {
+      packageName: 'build'
+    })
+
+    logger.eot()
+    logger.success('✅ Build completed successfully!')
+  }
+  catch (error) {
+    logger.error('❌ Build failed:', error)
+    process.exit(1)
+  }
+}
+
+buildProject()
+```
+
+### CI/CD Integration
+
+```typescript
+import { execPromise, logger } from '@maz-ui/node'
+
+async function ciPipeline() {
+  const steps = [
+    { name: 'Lint', command: 'npm run lint' },
+    { name: 'Test', command: 'npm test' },
+    { name: 'Build', command: 'npm run build' },
+    { name: 'Package', command: 'npm pack' }
+  ]
+
+  logger.brand('🔄 CI Pipeline Started')
+  logger.divider()
+
+  for (const step of steps) {
+    logger.log(`⏳ Running ${step.name}...`)
+
+    try {
+      await execPromise(step.command, {
+        packageName: step.name.toLowerCase(),
+        noStdout: true
+      })
+    }
+    catch (error) {
+      logger.error(`❌ ${step.name} failed:`, error)
+      process.exit(1)
+    }
+  }
+
+  logger.eot()
+  logger.success('🎉 All pipeline steps completed!')
+}
+```
+
+## API Reference
+
+### `execPromise(command, options?)`
+
+Executes a shell command and returns a promise.
+
+**Parameters:**
+
+- `command` (string): Shell command to execute
+- `options` (ExecOptions, optional): Execution options
+
+**Returns:**
+
+- `Promise<{ stdout: string, stderr: string }>`: Command output
+
+**Throws:**
+
+- Command execution errors with detailed logging
+
+### `logger`
+
+Console logger with colored output and error handling.
+
+**Type:** `Logger`
+
+All logger methods automatically handle error objects using `getErrorMessage` utility for consistent error formatting.
+
+## Dependencies
+
+- **colorette** - Terminal colors
+- **@maz-ui/utils** - Error message formatting
+- **Node.js built-ins** - child_process for command execution
+
+## Requirements
+
+- Node.js >= 18.0.0
+- TypeScript support included
+
+## Contributing
+
+Contributions are welcome! Please ensure:
+
+- New utilities follow existing patterns
+- TypeScript types are properly defined
+- Error handling is comprehensive
+- Documentation is updated accordingly
+
+## License
+
+MIT License - see LICENSE file for details.

package/dist/index.d.mts

@@ -0,0 +1,24 @@
+declare const logger: {
+    divider: () => void;
+    eot: () => void;
+    brand: (message: string) => void;
+    log: (...message: unknown[]) => void;
+    success: (...message: string[]) => void;
+    error: (message: string, error?: unknown) => void;
+    warn: (message: string, error?: unknown) => void;
+};
+type Logger = typeof logger;
+
+declare function execPromise(command: string, { logger, packageName, noSuccess, noStdout, noStderr }?: {
+    logger?: Logger;
+    packageName?: string;
+    noSuccess?: boolean;
+    noStdout?: boolean;
+    noStderr?: boolean;
+}): Promise<{
+    stdout: string;
+    stderr: string;
+}>;
+
+export { execPromise, logger };
+export type { Logger };

package/dist/index.d.ts

@@ -0,0 +1,24 @@
+declare const logger: {
+    divider: () => void;
+    eot: () => void;
+    brand: (message: string) => void;
+    log: (...message: unknown[]) => void;
+    success: (...message: string[]) => void;
+    error: (message: string, error?: unknown) => void;
+    warn: (message: string, error?: unknown) => void;
+};
+type Logger = typeof logger;
+
+declare function execPromise(command: string, { logger, packageName, noSuccess, noStdout, noStderr }?: {
+    logger?: Logger;
+    packageName?: string;
+    noSuccess?: boolean;
+    noStdout?: boolean;
+    noStderr?: boolean;
+}): Promise<{
+    stdout: string;
+    stderr: string;
+}>;
+
+export { execPromise, logger };
+export type { Logger };

package/dist/index.mjs

@@ -0,0 +1,198 @@
+import { exec } from 'node:child_process';
+import * as tty from 'tty';
+
+function e(t) {
+  return t instanceof Error ? t.message : typeof t == "string" ? t : t && typeof t == "object" && "message" in t ? String(t.message) : t ? String(t) : "An unexpected error occurred";
+}
+
+const {
+  env = {},
+  argv = [],
+  platform = "",
+} = typeof process === "undefined" ? {} : process;
+
+const isDisabled = "NO_COLOR" in env || argv.includes("--no-color");
+const isForced = "FORCE_COLOR" in env || argv.includes("--color");
+const isWindows = platform === "win32";
+const isDumbTerminal = env.TERM === "dumb";
+
+const isCompatibleTerminal =
+  tty && tty.isatty && tty.isatty(1) && env.TERM && !isDumbTerminal;
+
+const isCI =
+  "CI" in env &&
+  ("GITHUB_ACTIONS" in env || "GITLAB_CI" in env || "CIRCLECI" in env);
+
+const isColorSupported =
+  !isDisabled &&
+  (isForced || (isWindows && !isDumbTerminal) || isCompatibleTerminal || isCI);
+
+const replaceClose = (
+  index,
+  string,
+  close,
+  replace,
+  head = string.substring(0, index) + replace,
+  tail = string.substring(index + close.length),
+  next = tail.indexOf(close)
+) => head + (next < 0 ? tail : replaceClose(next, tail, close, replace));
+
+const clearBleed = (index, string, open, close, replace) =>
+  index < 0
+    ? open + string + close
+    : open + replaceClose(index, string, close, replace) + close;
+
+const filterEmpty =
+  (open, close, replace = open, at = open.length + 1) =>
+  (string) =>
+    string || !(string === "" || string === undefined)
+      ? clearBleed(
+          ("" + string).indexOf(close, at),
+          string,
+          open,
+          close,
+          replace
+        )
+      : "";
+
+const init = (open, close, replace) =>
+  filterEmpty(`\x1b[${open}m`, `\x1b[${close}m`, replace);
+
+const colors = {
+  reset: init(0, 0),
+  bold: init(1, 22, "\x1b[22m\x1b[1m"),
+  dim: init(2, 22, "\x1b[22m\x1b[2m"),
+  italic: init(3, 23),
+  underline: init(4, 24),
+  inverse: init(7, 27),
+  hidden: init(8, 28),
+  strikethrough: init(9, 29),
+  black: init(30, 39),
+  red: init(31, 39),
+  green: init(32, 39),
+  yellow: init(33, 39),
+  blue: init(34, 39),
+  magenta: init(35, 39),
+  cyan: init(36, 39),
+  white: init(37, 39),
+  gray: init(90, 39),
+  bgBlack: init(40, 49),
+  bgRed: init(41, 49),
+  bgGreen: init(42, 49),
+  bgYellow: init(43, 49),
+  bgBlue: init(44, 49),
+  bgMagenta: init(45, 49),
+  bgCyan: init(46, 49),
+  bgWhite: init(47, 49),
+  blackBright: init(90, 39),
+  redBright: init(91, 39),
+  greenBright: init(92, 39),
+  yellowBright: init(93, 39),
+  blueBright: init(94, 39),
+  magentaBright: init(95, 39),
+  cyanBright: init(96, 39),
+  whiteBright: init(97, 39),
+  bgBlackBright: init(100, 49),
+  bgRedBright: init(101, 49),
+  bgGreenBright: init(102, 49),
+  bgYellowBright: init(103, 49),
+  bgBlueBright: init(104, 49),
+  bgMagentaBright: init(105, 49),
+  bgCyanBright: init(106, 49),
+  bgWhiteBright: init(107, 49),
+};
+
+const createColors = ({ useColor = isColorSupported } = {}) =>
+  useColor
+    ? colors
+    : Object.keys(colors).reduce(
+        (colors, key) => ({ ...colors, [key]: String }),
+        {}
+      );
+
+const {
+  reset,
+  bold,
+  dim,
+  italic,
+  underline,
+  inverse,
+  hidden,
+  strikethrough,
+  black,
+  red,
+  green,
+  yellow,
+  blue,
+  magenta,
+  cyan,
+  white,
+  gray,
+  bgBlack,
+  bgRed,
+  bgGreen,
+  bgYellow,
+  bgBlue,
+  bgMagenta,
+  bgCyan,
+  bgWhite,
+  blackBright,
+  redBright,
+  greenBright,
+  yellowBright,
+  blueBright,
+  magentaBright,
+  cyanBright,
+  whiteBright,
+  bgBlackBright,
+  bgRedBright,
+  bgGreenBright,
+  bgYellowBright,
+  bgBlueBright,
+  bgMagentaBright,
+  bgCyanBright,
+  bgWhiteBright,
+} = createColors();
+
+const log = console.log;
+const logger = {
+  divider: () => log("----------------------------------------"),
+  eot: () => log(),
+  brand: (message) => log(blueBright(message)),
+  log: (...message) => log(...message),
+  success: (...message) => log(...message.map((m) => green(m))),
+  error: (message, error) => {
+    const errorMessage = error ? e(error) : "";
+    log(red(message), errorMessage ? red(errorMessage) : "");
+  },
+  warn: (message, error) => {
+    const errorMessage = error ? e(error) : "";
+    log(yellow(message), errorMessage ? yellow(errorMessage) : "");
+  }
+};
+
+async function execPromise(command, { logger: logger$1, packageName, noSuccess, noStdout, noStderr } = {}) {
+  const internalLogger = logger$1 ?? logger;
+  const packageNameStr = packageName ? `[${packageName}]` : "";
+  return await new Promise((resolve, reject) => {
+    exec(command, (error, stdout, stderr) => {
+      if (stdout && !noStdout) {
+        internalLogger.log(`\u{1F7E1} ${packageNameStr}(${command})`, stdout);
+      }
+      if (stderr && !noStderr) {
+        internalLogger.warn(`\u{1F7E1} ${packageNameStr}(${command})`, stderr);
+      }
+      if (error) {
+        internalLogger.error(`\u{1F534} ${packageNameStr}(${command}) Execution failed - ${error.message}.`, error.message);
+        reject(error);
+      } else {
+        if (!noSuccess) {
+          internalLogger.success(`\u{1F7E2} ${packageNameStr}(${command}) Execution success`);
+        }
+        resolve({ stdout, stderr });
+      }
+    });
+  });
+}
+
+export { execPromise, logger };

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "@maz-ui/node",
+  "type": "module",
+  "version": "4.0.0-beta.11",
+  "packageManager": "pnpm@10.13.1",
+  "description": "Node utilities for Maz-UI library",
+  "author": "Louis Mazel <me@loicmazuel.com>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/LouisMazel/maz-ui.git"
+  },
+  "bugs": "https://github.com/LouisMazel/maz-ui/issues",
+  "keywords": [
+    "node",
+    "utilities",
+    "maz-ui",
+    "promise",
+    "logger"
+  ],
+  "sideEffects": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs"
+    },
+    "./*": "./src/*"
+  },
+  "main": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "LICENSE",
+    "README.md",
+    "dist"
+  ],
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "scripts": {
+    "build": "unbuild",
+    "dev": "unbuild --stub",
+    "typecheck": "tsc --noEmit --skipLibCheck",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "pre-commit": "lint-staged"
+  },
+  "devDependencies": {
+    "@maz-ui/utils": "4.0.0-beta.11",
+    "colorette": "^2.0.20",
+    "typescript": "^5.8.3",
+    "unbuild": "^3.5.0"
+  },
+  "lint-staged": {
+    "*.{js,jsx,ts,tsx,mjs,mts,cjs,md,yml,json}": [
+      "eslint --fix"
+    ]
+  },
+  "gitHead": "604f754078f4e50e3db39793c28709e1dc1020c7"
+}