x-fidelity 3.15.0 → 3.16.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [3.16.0](https://github.com/zotoio/x-fidelity/compare/v3.15.0...v3.16.0) (2025-03-19)
+
+
+### Features
+
+* add support for disabling colored logging via XFI_LOG_COLOR env var ([cafcf5b](https://github.com/zotoio/x-fidelity/commit/cafcf5b6fde9b29dbe31a62cba491ab42c24b759))
+
 # [3.15.0](https://github.com/zotoio/x-fidelity/compare/v3.14.0...v3.15.0) (2025-03-12)
 
 

package/README.md

@@ -50,6 +50,7 @@ x-fidelity is an advanced CLI tool and paired config server designed to perform
    - [Basic Usage](#basic-usage)
    - [Advanced Usage](#advanced-usage)
    - [Environment Variables](#environment-variables)
+   - [Logging Options](#logging-options)
    - [Local Configuration](#local-configuration)
    - [Remote Configuration](#remote-configuration)
 8. [Hosting Config Servers](#hosting-config-servers)
@@ -475,6 +476,7 @@ x-fidelity supports the following environment variables:
 - `CERT_PATH`: The path to SSL certificates for HTTPS config server.
 - `NODE_TLS_REJECT_UNAUTHORIZED`: Set to '0' to allow self-signed certificates (use with caution).
 - `XFI_SHARED_SECRET`: Shared secret for securing telemetry and certain server routes.
+- `XFI_LOG_COLOR`: Set to 'false' to disable colored output in logs.
 
 Example usage:
 
@@ -483,6 +485,7 @@ export OPENAI_API_KEY=your_api_key_here
 export OPENAI_MODEL=gpt-4
 export XFI_LISTEN_PORT=9999
 export XFI_SHARED_SECRET=your_shared_secret_here
+export XFI_LOG_COLOR=false
 xfidelity -o true
 ```
 
@@ -500,6 +503,23 @@ The local config directory should contain:
 
 You can override default archetypes or add new ones by placing the corresponding JSON files in the local config directory.
 
+### Logging Options
+
+x-fidelity provides options to customize the logging output:
+
+1. **Log Level**: Set the logging level using the `XFI_LOG_LEVEL` environment variable:
+   ```sh
+   export XFI_LOG_LEVEL=debug
+   ```
+   Available levels: trace, debug, info, warn, error, fatal
+
+2. **Colored Output**: You can disable colored logging output using an environment variable:
+   ```sh
+   export XFI_LOG_COLOR=false
+   ```
+
+This is particularly useful in CI/CD environments or when redirecting logs to files.
+
 ### Remote Configuration
 
 To use a remote configuration server, use the `-c` or `--configServer` option:

package/dist/demoConfig/rules/functionComplexity-iterative-rule.json

@@ -17,7 +17,7 @@
                         "cognitiveComplexity": 30,
                         "nestingDepth": 10,
                         "parameterCount": 5,
-                        "returnCount": 5
+                        "returnCount": 10
                     }
                 },
                 "operator": "astComplexity",
@@ -26,7 +26,7 @@
                     "cognitiveComplexity": 30,
                     "nestingDepth": 10,
                     "parameterCount": 5,
-                    "returnCount": 5
+                    "returnCount": 10
                 }
             }
         ]

package/dist/utils/logger.js

@@ -38,6 +38,8 @@ function getLogPrefix() {
 }
 // Initialize logger function that will create the singleton if it doesn't exist
 function getLogger(force) {
+    // Determine if color should be enabled based on environment variable only
+    const useColor = process.env.XFI_LOG_COLOR !== 'false';
     if (!loggerInstance || force) {
         const fileTransport = pino_1.default.destination({
             dest: 'x-fidelity.log',
@@ -49,7 +51,7 @@ function getLogger(force) {
             options: {
                 loglevel: loglevel,
                 sync: false,
-                colorize: true,
+                colorize: useColor,
                 translateTime: 'SYS:yyyy-mm-dd HH:MM:ss.l o',
                 ignore: 'pid,hostname',
                 singleLine: true,

package/dist/utils/logger.test.js

@@ -2,6 +2,16 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const logger_1 = require("./logger");
 describe('Logger utilities', () => {
+    // Save original environment
+    const originalEnv = process.env;
+    beforeEach(() => {
+        // Reset environment before each test
+        process.env = Object.assign({}, originalEnv);
+    });
+    afterAll(() => {
+        // Restore original environment
+        process.env = originalEnv;
+    });
     describe('generateLogPrefix', () => {
         it('should generate a string of length 8', () => {
             const prefix = (0, logger_1.generateLogPrefix)();
@@ -29,4 +39,13 @@ describe('Logger utilities', () => {
             expect(newPrefix.length).toBe(8);
         });
     });
+    describe('logger color configuration', () => {
+        it('should respect XFI_LOG_COLOR environment variable', () => {
+            process.env.XFI_LOG_COLOR = 'false';
+            (0, logger_1.resetLogger)();
+            // This test doesn't directly assert the colorize option
+            // as it's internal to pino, but ensures the code path is executed
+            expect(process.env.XFI_LOG_COLOR).toBe('false');
+        });
+    });
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "x-fidelity",
-  "version": "3.15.0",
+  "version": "3.16.0",
   "description": "cli for opinionated framework adherence checks",
   "main": "dist/index",
   "types": "dist/index.d.ts",

package/src/demoConfig/rules/functionComplexity-iterative-rule.json

@@ -17,7 +17,7 @@
                         "cognitiveComplexity": 30,
                         "nestingDepth": 10,
                         "parameterCount": 5,
-                        "returnCount": 5
+                        "returnCount": 10
                     }
                 },
                 "operator": "astComplexity",
@@ -26,7 +26,7 @@
                     "cognitiveComplexity": 30,
                     "nestingDepth": 10,
                     "parameterCount": 5,
-                    "returnCount": 5
+                    "returnCount": 10
                 }
             }
         ]

package/src/plugins/xfiPluginAst/sampleRules/functionComplexity-iterative-rule.json

@@ -17,7 +17,7 @@
                         "cognitiveComplexity": 30,
                         "nestingDepth": 10,
                         "parameterCount": 5,
-                        "returnCount": 5
+                        "returnCount": 10
                     }
                 },
                 "operator": "astComplexity",
@@ -26,7 +26,7 @@
                     "cognitiveComplexity": 30,
                     "nestingDepth": 10,
                     "parameterCount": 5,
-                    "returnCount": 5
+                    "returnCount": 10
                 }
             }
         ]

package/src/utils/logger.test.ts

@@ -1,6 +1,18 @@
-import { generateLogPrefix, setLogPrefix, getLogPrefix, resetLogPrefix } from './logger';
+import { generateLogPrefix, setLogPrefix, getLogPrefix, resetLogPrefix, resetLogger } from './logger';
 
 describe('Logger utilities', () => {
+    // Save original environment
+    const originalEnv = process.env;
+    
+    beforeEach(() => {
+        // Reset environment before each test
+        process.env = { ...originalEnv };
+    });
+    
+    afterAll(() => {
+        // Restore original environment
+        process.env = originalEnv;
+    });
     describe('generateLogPrefix', () => {
         it('should generate a string of length 8', () => {
             const prefix = generateLogPrefix();
@@ -31,4 +43,14 @@ describe('Logger utilities', () => {
             expect(newPrefix.length).toBe(8);
         });
     });
+    
+    describe('logger color configuration', () => {
+        it('should respect XFI_LOG_COLOR environment variable', () => {
+            process.env.XFI_LOG_COLOR = 'false';
+            resetLogger();
+            // This test doesn't directly assert the colorize option
+            // as it's internal to pino, but ensures the code path is executed
+            expect(process.env.XFI_LOG_COLOR).toBe('false');
+        });
+    });
 });

package/src/utils/logger.ts

@@ -1,6 +1,7 @@
 import { randomUUID } from 'crypto';
 import pino from 'pino';
 import { maskSensitiveData } from './maskSensitiveData';
+import { options } from '../core/cli';
 
 // Initialize variables
 let loggerInstance: pino.Logger | undefined;
@@ -32,6 +33,9 @@ export function getLogPrefix(): string {
 
 // Initialize logger function that will create the singleton if it doesn't exist
 function getLogger(force?: boolean): pino.Logger {
+    // Determine if color should be enabled based on environment variable only
+    const useColor = process.env.XFI_LOG_COLOR !== 'false';
+    
     if (!loggerInstance || force) {
         const fileTransport = pino.destination({
             dest: 'x-fidelity.log',
@@ -44,7 +48,7 @@ function getLogger(force?: boolean): pino.Logger {
             options: {
                 loglevel: loglevel,
                 sync: false,
-                colorize: true,
+                colorize: useColor,
                 translateTime: 'SYS:yyyy-mm-dd HH:MM:ss.l o',
                 ignore: 'pid,hostname',
                 singleLine: true,

package/website/docs/environment-variables.md

@@ -42,8 +42,15 @@ GITHUB_WEBHOOK_SECRET=your_github_webhook_secret
 ```bash
 # Set logging level (default: 'info')
 XFI_LOG_LEVEL=debug
+
+# Disable colored output in logs (default: enabled)
+XFI_LOG_COLOR=false
 ```
 
+The `XFI_LOG_COLOR` environment variable controls whether log output includes ANSI color codes. This is particularly useful in CI/CD environments, when redirecting logs to files, or when your terminal doesn't support colors.
+
+Setting `XFI_LOG_COLOR=false` will disable all colored output in logs, making them plain text. This can improve readability in environments where color codes might appear as strange characters.
+
 ## Usage Examples
 
 ### Basic Setup

package/website/docs/getting-started.md

@@ -62,6 +62,7 @@ Options:
 - `CERT_PATH`: SSL certificate path
 - `NODE_TLS_REJECT_UNAUTHORIZED`: Allow self-signed certs
 - `XFI_SHARED_SECRET`: Shared secret for security
+- `XFI_LOG_COLOR`: Set to 'false' to disable colored output in logs
 - `NOTIFICATIONS_ENABLED`: Enable notification system
 - `NOTIFICATION_PROVIDERS`: Comma-separated list of notification providers to use
 - `CODEOWNERS_PATH`: Path to CODEOWNERS file (default: .github/CODEOWNERS)