@outfitter/logging 0.1.0-rc.3 → 0.1.0

package/dist/index.d.ts

@@ -302,6 +302,33 @@ interface PrettyFormatterOptions {
 	timestamp?: boolean;
 }
 /**
+* Options for the console sink.
+*
+* Controls ANSI color output for terminal display. By default, colors are
+* auto-detected based on whether stdout is a TTY.
+*
+* @example
+* ```typescript
+* // Auto-detect TTY (default)
+* const sink = createConsoleSink();
+*
+* // Force colors off (for piped output, CI)
+* const plainSink = createConsoleSink({ colors: false });
+*
+* // Force colors on (even in non-TTY)
+* const colorSink = createConsoleSink({ colors: true });
+* ```
+*/
+interface ConsoleSinkOptions {
+	/**
+	* Enable ANSI colors in output.
+	* - `undefined` (default): Auto-detect based on stdout TTY status
+	* - `true`: Always use colors
+	* - `false`: Never use colors
+	*/
+	colors?: boolean;
+}
+/**
 * Options for the file sink.
 *
 * Configures the file path and append behavior for file-based logging.
@@ -447,6 +474,7 @@ declare function createPrettyFormatter(options?: PrettyFormatterOptions): Format
 * Create a console sink that writes to stdout/stderr.
 * Info and below go to stdout, warn and above go to stderr.
 *
+* @param options - Console sink options
 * @returns Sink configured for console output
 *
 * @example
@@ -455,9 +483,15 @@ declare function createPrettyFormatter(options?: PrettyFormatterOptions): Format
 *   name: "app",
 *   sinks: [createConsoleSink()],
 * });
+*
+* // Disable colors for CI/piped output
+* const plainLogger = createLogger({
+*   name: "app",
+*   sinks: [createConsoleSink({ colors: false })],
+* });
 * ```
 */
-declare function createConsoleSink(): Sink;
+declare function createConsoleSink(options?: ConsoleSinkOptions): Sink;
 /**
 * Create a file sink that writes to a specified file path.
 *
@@ -501,4 +535,4 @@ declare function configureRedaction(config: GlobalRedactionConfig): void;
 * ```
 */
 declare function flush(): Promise<void>;
-export { flush, createPrettyFormatter, createLogger, createJsonFormatter, createFileSink, createConsoleSink, createChildLogger, configureRedaction, Sink, RedactionConfig, PrettyFormatterOptions, LoggerInstance, LoggerConfig, LogRecord, LogLevel, GlobalRedactionConfig, Formatter, FileSinkOptions, DEFAULT_PATTERNS };
+export { flush, createPrettyFormatter, createLogger, createJsonFormatter, createFileSink, createConsoleSink, createChildLogger, configureRedaction, Sink, RedactionConfig, PrettyFormatterOptions, LoggerInstance, LoggerConfig, LogRecord, LogLevel, GlobalRedactionConfig, Formatter, FileSinkOptions, DEFAULT_PATTERNS, ConsoleSinkOptions };

package/dist/index.js

@@ -286,8 +286,9 @@ function createPrettyFormatter(options) {
     }
   };
 }
-function createConsoleSink() {
-  const formatter = createPrettyFormatter({ colors: true });
+function createConsoleSink(options) {
+  const useColors = options?.colors ?? process.stdout.isTTY ?? false;
+  const formatter = createPrettyFormatter({ colors: useColors });
   const sink = {
     formatter,
     write(record, formatted) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@outfitter/logging",
   "description": "Structured logging via logtape with redaction support for Outfitter",
-  "version": "0.1.0-rc.3",
+  "version": "0.1.0",
   "type": "module",
   "files": [
     "dist"
@@ -27,7 +27,7 @@
     "clean": "rm -rf dist"
   },
   "dependencies": {
-    "@outfitter/contracts": "0.1.0-rc.2",
+    "@outfitter/contracts": "0.1.0",
     "@logtape/logtape": "^2.0.0"
   },
   "devDependencies": {