@darksheep/logger 1.0.2 → 1.0.4

package/CHANGELOG.md

@@ -1,5 +1,33 @@
 # Changelog
 
+## [1.0.4](https://github.com/DarkSheepSoftware/node-packages/compare/logger-v1.0.3...logger-v1.0.4) (2024-08-28)
+
+
+### 🔨 Code Refactoring
+
+* Remove all eslint inline suppressions ([dc1d62f](https://github.com/DarkSheepSoftware/node-packages/commit/dc1d62f5fa9cd50f884d6b68a30d448685c6c2d2))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @darksheep/environment bumped from 3.0.6 to 3.0.7
+
+## [1.0.3](https://github.com/DarkSheepSoftware/node-packages/compare/logger-v1.0.2...logger-v1.0.3) (2024-08-12)
+
+
+### 🧹 Chores
+
+* update env access ([#309](https://github.com/DarkSheepSoftware/node-packages/issues/309)) ([c0bb192](https://github.com/DarkSheepSoftware/node-packages/commit/c0bb192deb0d016f3893e14ab6270461d5f5b07d))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @darksheep/environment bumped from 3.0.5 to 3.0.6
+
 ## [1.0.2](https://github.com/DarkSheepSoftware/node-packages/compare/logger-v1.0.1...logger-v1.0.2) (2024-08-01)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@darksheep/logger",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "Logging your stuff to where ever you want it",
   "license": "UNLICENCED",
   "type": "module",
@@ -17,23 +17,19 @@
     "!assert.zod.js"
   ],
   "scripts": {
-    "lint": "eslint .",
-    "lint:fix": "eslint . --fix",
     "prepack": "tsc",
     "test": "node --test src/**/*.test.js",
     "test:watch": "node --watch --test src/**/*.test.js"
   },
   "dependencies": {
+    "@darksheep/environment": "3.0.7",
     "deepmerge-ts": "7.1.0",
     "stacktrace-parser": "0.1.10",
     "traverse": "0.6.9"
   },
   "devDependencies": {
-    "@darksheep/eslint": "~5.1.0",
-    "@types/eslint": "~9.6.0",
-    "@types/node": "~20.14.0",
+    "@types/node": "~20.16.0",
     "@types/traverse": "~0.6.33",
-    "eslint": "~9.8.0",
     "nock": "~13.5.0",
     "typescript": "~5.5.0",
     "zod": "~3.23.0"

package/src/replacer.js

@@ -1,5 +1,3 @@
-/* eslint no-invalid-this: 0 */
-
 import Traverse from 'traverse';
 
 import { nodesToPath } from './utilities/json-path.js';
@@ -20,50 +18,61 @@ import { nodesToPath } from './utilities/json-path.js';
  * @returns {unknown}
  */
 export function replace(object, replacers = []) {
-  /** @type {import('traverse').Traverse<unknown>} */
-  const traverse = Traverse(object);
+  return Traverse(object).forEach(
+    /**
+     * @param {unknown} value Current property in the traversed object
+     * @this {import('traverse').TraverseContext}
+     * @returns {void}
+     */
+    function (value) {
+      if (value == null) {
+        return this.remove();
+      }
 
-  return traverse.forEach(function (value) {
-    if (value == null) {
-      return this.remove();
-    }
+      if (this.circular != null) {
+        return this.update({ $ref: nodesToPath(this.circular.path) });
+      }
 
-    if (this.circular != null) {
-      return this.update({ $ref: nodesToPath(this.circular.path) });
-    }
+      for (const replacer of replacers) {
+        if (replacer.shouldReplace(value, this.path)) {
+          const replaced = replacer.replace(value, this.path);
 
-    for (const replacer of replacers) {
-      if (replacer.shouldReplace(value, this.path)) {
-        const replaced = replacer.replace(value, this.path);
+          if (replaced == null) {
+            return this.remove(replacer.stopHere);
+          }
 
-        if (replaced == null) {
-          return this.remove(replacer.stopHere);
+          return this.update(replaced, replacer.stopHere);
         }
-
-        return this.update(replaced, replacer.stopHere);
       }
-    }
 
-    if (typeof value.toJSON === 'function') {
-      try {
-        return this.update(value.toJSON());
-      } catch { }
-    }
+      if (
+        typeof value === 'object' &&
+        'toJSON' in value &&
+        typeof value.toJSON === 'function'
+      ) {
+        try {
+          return this.update(value.toJSON());
+        } catch { }
+      }
 
-    if (
-      value instanceof Object &&
-      Object.getPrototypeOf(value) !== Object.getPrototypeOf({}) &&
-      Object.getPrototypeOf(value) !== Object.getPrototypeOf([])
-    ) {
-      return this.update({ $class: value.constructor.name });
-    }
+      if (
+        value instanceof Object &&
+        Object.getPrototypeOf(value) !== Object.getPrototypeOf({}) &&
+        Object.getPrototypeOf(value) !== Object.getPrototypeOf([])
+      ) {
+        return this.update({ $class: value.constructor.name });
+      }
 
-    if (Object.getPrototypeOf(value).constructor === Object) {
-      this.update({ ...value });
-    }
+      if (Object.getPrototypeOf(value).constructor === Object) {
+        this.update({ ...value });
+      }
 
-    if (Object.getPrototypeOf(value).constructor === Array) {
-      this.update([ ...value ]);
-    }
-  });
+      if (
+        Array.isArray(value) &&
+        Object.getPrototypeOf(value).constructor === Array
+      ) {
+        this.update([ ...value ]);
+      }
+    },
+  );
 }

package/src/utilities/environment.js

@@ -1,61 +1,32 @@
+import { getTypedEnv } from '@darksheep/environment';
+
 import { parseFilters } from './parse-filters.js';
 import { parseLogLevel } from './parse-log-level.js';
 
-/**
- * @param {undefined | string} input The env var to check for booleaness
- * @param {boolean} fallback The fallback bool
- * @returns {boolean}
- */
-function parseBoolean(input, fallback) {
-  if (input === 'true' || input === '1') {
-    return true;
-  }
-
-  if (input === 'false' || input === '0') {
-    return false;
-  }
-
-  return fallback;
-}
-
-/**
- * @param {undefined | string} input The env var to check to see if its an int
- * @param {number} fallback The fallback number
- * @returns {number}
- */
-function parseInt(input, fallback) {
-  if (typeof input === 'string') {
-    const number = Number.parseInt(input, 10);
-
-    if (Number.isNaN(number) === false) {
-      return number;
-    }
-  }
-
-  return fallback;
-}
-
-const isDevelopment = process.env.NODE_ENV === 'development';
-const isTesting = process.env.NODE_ENV === 'test';
-const isProduction = process.env.NODE_ENV === 'production';
-
-const logLevel = parseLogLevel(
-  process.env.LOG_LEVEL,
-  process.env.NODE_ENV,
-);
-const logFilters = parseFilters(process.env.LOG_FILTERS, [ /.*/ ]);
-const secretFilters = parseFilters(process.env.LOG_SECRETS);
-const includeCallsite = parseBoolean(process.env.LOG_CALLSITES, false);
-const stringMaxLength = parseInt(process.env.LOG_MAX_LENGTH, 1024);
+const {
+  NODE_ENV = 'production',
+  LOG_LEVEL,
+  LOG_FILTERS,
+  LOG_SECRETS,
+  LOG_CALLSITES = false,
+  LOG_MAX_LENGTH = 1024,
+} = getTypedEnv({
+  NODE_ENV: '?string',
+  LOG_LEVEL: '?string',
+  LOG_FILTERS: '?string',
+  LOG_SECRETS: '?string',
+  LOG_CALLSITES: '?boolean',
+  LOG_MAX_LENGTH: '?number',
+});
 
 export const environment = {
-  isDevelopment,
-  isTesting,
-  isProduction,
-
-  logLevel,
-  logFilters,
-  secretFilters,
-  includeCallsite,
-  stringMaxLength,
+  isDevelopment: NODE_ENV === 'development',
+  isTesting: NODE_ENV === 'test',
+  isProduction: NODE_ENV === 'production',
+
+  logLevel: parseLogLevel(LOG_LEVEL, NODE_ENV),
+  logFilters: parseFilters(LOG_FILTERS, [ /.*/ ]),
+  secretFilters: parseFilters(LOG_SECRETS),
+  includeCallsite: LOG_CALLSITES,
+  stringMaxLength: LOG_MAX_LENGTH,
 };

package/types/utilities/environment.d.ts

@@ -1,25 +1,19 @@
 export namespace environment {
-    export { isDevelopment };
-    export { isTesting };
-    export { isProduction };
-    export { logLevel };
-    export { logFilters };
-    export { secretFilters };
-    export { includeCallsite };
-    export { stringMaxLength };
+    export let isDevelopment: boolean;
+    export let isTesting: boolean;
+    export let isProduction: boolean;
+    export let logLevel: import("./log-types.js").LogLevel;
+    export let logFilters: {
+        allowed: RegExp[];
+        blocked: RegExp[];
+    };
+    export let secretFilters: {
+        allowed: RegExp[];
+        blocked: RegExp[];
+    };
+    export { LOG_CALLSITES as includeCallsite };
+    export { LOG_MAX_LENGTH as stringMaxLength };
 }
-declare const isDevelopment: boolean;
-declare const isTesting: boolean;
-declare const isProduction: boolean;
-declare const logLevel: import("./log-types.js").LogLevel;
-declare const logFilters: {
-    allowed: RegExp[];
-    blocked: RegExp[];
-};
-declare const secretFilters: {
-    allowed: RegExp[];
-    blocked: RegExp[];
-};
-declare const includeCallsite: boolean;
-declare const stringMaxLength: number;
+declare const LOG_CALLSITES: boolean;
+declare const LOG_MAX_LENGTH: number;
 export {};