mynth-logger 1.0.13 → 1.0.14

package/.eslintignore

@@ -0,0 +1 @@
+dist

package/.eslintrc.json

@@ -0,0 +1,68 @@
+{
+  "parser": "@typescript-eslint/parser",
+  "extends": [
+    "eslint:recommended",
+    "plugin:ava/recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:import/errors",
+    "plugin:import/warnings",
+    "plugin:import/typescript"
+  ],
+  "plugins": [
+    "ava",
+    "import",
+    "@typescript-eslint",
+    "file-extension-in-import-ts"
+  ],
+  "settings": {
+    "import/resolver": {
+      "node": {
+        "paths": ["src"]
+      }
+    }
+  },
+  "rules": {
+    "padding-line-between-statements": [
+      "error",
+      { "blankLine": "always", "prev": "*", "next": "block" },
+      { "blankLine": "always", "prev": "block", "next": "*" },
+      { "blankLine": "always", "prev": "*", "next": "block-like" },
+      { "blankLine": "always", "prev": "block-like", "next": "*" }
+    ],
+    "@typescript-eslint/no-unused-vars": [
+      "warn",
+      {
+        "argsIgnorePattern": "^_",
+        "varsIgnorePattern": "^_",
+        "caughtErrorsIgnorePattern": "^_"
+      }
+    ],
+    "@typescript-eslint/naming-convention": [
+      "error",
+      {
+        "selector": ["parameter", "variable"],
+        "leadingUnderscore": "forbid",
+        "format": null
+      },
+      {
+        "selector": "parameter",
+        "leadingUnderscore": "require",
+        "format": null,
+        "modifiers": ["unused"]
+      }
+    ],
+    "no-constant-condition": "off",
+    "file-extension-in-import-ts/file-extension-in-import-ts": "error",
+    "import/no-unresolved": ["error", { "ignore": ["\\.js$"] }],
+    "no-restricted-imports": ["error", { "patterns": ["src/*"] }]
+  },
+  "overrides": [
+    {
+      "files": ["tests/**/*.ts"],
+      "rules": {
+        "import/no-unresolved": "off",
+        "file-extension-in-import-ts/file-extension-in-import-ts": "off"
+      }
+    }
+  ]
+}

package/.github/workflows/CI.yaml

@@ -17,10 +17,11 @@ jobs:
       - name: Set up Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: 18.16.1
+          node-version: 18
+          check-latest: true
 
       - name: Update npm
-        run: npm install -g npm@9.7.2
+        run: npm install -g npm@latest
 
       - name: Install dependencies
         run: npm ci --include dev
@@ -39,7 +40,11 @@ jobs:
       - name: Set up Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: 18.16.1
+          node-version: 18
+          check-latest: true
+
+      - name: Update npm
+        run: npm install -g npm@latest
 
       - name: Install dependencies
         run: npm install --include dev
@@ -58,7 +63,11 @@ jobs:
       - name: Set up Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: 18.16.1
+          node-version: 18
+          check-latest: true
+
+      - name: Update npm
+        run: npm install -g npm@latest
 
       - name: Install dependencies
         run: npm install --include dev

package/.github/workflows/npm-publish.yml

@@ -16,21 +16,34 @@ jobs:
           ref: ${{ github.head_ref }}
           fetch-depth: 0
           token: ${{ secrets.PAT }}
+
       - uses: actions/setup-node@v3
         with:
-          node-version: 18.16.1
+          node-version: 18
+          check-latest: true
           registry-url: https://registry.npmjs.org/
-      - run: npm ci
-      - run: npm run build
+
+      - name: Update npm
+        run: npm install -g npm@latest
+
+      - name: Install dependencies
+        run: npm ci --include dev
+
+      - name: Build
+        run: npm run build
+
       - name: Git configuration
         run: |
           git config --local user.email "github-actions[bot]@users.noreply.github.com"
           git config --local user.name "github-actions[bot]"
+
       - run: npm version --commit-hooks true patch
+
       - name: Git commit and push
         env:
           GITHUB_TOKEN: ${{ secrets.PAT }}
         run: git push origin
+
       - run: npm publish
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}

package/dist/src/index.js

@@ -39,12 +39,14 @@ const pinoSettings = {
     },
 };
 exports.pinoSettings = pinoSettings;
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
 const formatItem = (item) => {
     if (typeof item === "undefined") {
         return "undefined";
     }
     // Remove colors from strings
     if (typeof item === "string") {
+        // eslint-disable-next-line no-control-regex
         return item.replace(/\x1b\[[0-9;]*m/g, "");
     }
     let stringified = "";
@@ -54,36 +56,41 @@ const formatItem = (item) => {
     catch {
         stringified = String(item);
     }
-    return stringified.replace(/^\'|\'$/g, "");
+    return stringified.replace(/^'|'$/g, "");
 };
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
 const format = (items) => {
     return Array.from(items)
         .map((item) => formatItem(item))
         .join(" ");
 };
 const overrideConsole = (logger) => {
-    console.log = function () {
-        logger.info(format(Array.from(arguments)));
+    console.log = function (...args) {
+        logger.info(format(Array.from(args)));
     };
-    console.info = function () {
-        logger.info(format(Array.from(arguments)));
+    console.info = function (...args) {
+        logger.info(format(Array.from(args)));
     };
-    console.warn = function () {
-        logger.warn(format(Array.from(arguments)));
+    console.warn = function (...args) {
+        logger.warn(format(Array.from(args)));
     };
-    console.error = function () {
-        logger.error(format(Array.from(arguments)));
+    console.error = function (...args) {
+        logger.error(format(Array.from(args)));
     };
-    console.debug = function () {
-        logger.debug(format(Array.from(arguments)));
+    console.debug = function (...args) {
+        logger.debug(format(Array.from(args)));
     };
 };
-const setupLogging = async (settings = pinoSettings) => {
-    let pretty;
+const loadPretty = async () => {
     try {
-        pretty = await Promise.resolve().then(() => __importStar(require("pino-pretty")));
+        return await Promise.resolve().then(() => __importStar(require("pino-pretty")));
+    }
+    catch {
+        return null;
     }
-    catch { }
+};
+const setupLogging = async (settings = pinoSettings) => {
+    const pretty = await loadPretty();
     const logger = pretty
         ? (0, pino_1.default)(settings, pretty.default({ colorize: true }))
         : (0, pino_1.default)(settings);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mynth-logger",
-  "version": "1.0.13",
+  "version": "1.0.14",
   "description": "Package to format logs for mynth microservices.",
   "main": "dist/src/index.js",
   "typings": "dist/src/index.d.ts",
@@ -8,22 +8,24 @@
     "test": "npx ava",
     "build": "npx tsc",
     "prettier": "npx prettier -w '**/*.{js,jsx,ts,tsx,json,yml.j2,yml,yaml,.*}'",
-    "lint": "concurrently \"npx prettier --check '**/*.{js,jsx,ts,tsx,json,yml.j2,yml,yaml,.*}'\" \"npx eslint --max-warnings=0\""
+    "lint": "concurrently \"npx prettier --check '**/*.{js,jsx,ts,tsx,json,yml.j2,yml,yaml,.*}'\" \"npx eslint . --max-warnings=0\""
   },
   "repository": {
     "type": "git",
     "url": "git@github.com-mynth:MynthAI/mynth-logger.git"
   },
   "dependencies": {
-    "ava": "^5.3.1",
-    "json5": "^2.2.3",
     "pino": "^8.15.0"
   },
   "devDependencies": {
     "@types/node": "^20.5.0",
+    "@typescript-eslint/eslint-plugin": "^6.8.0",
+    "ava": "^5.3.1",
     "concurrently": "^8.2.0",
     "eslint": "^8.47.0",
     "eslint-plugin-ava": "^14.0.0",
+    "eslint-plugin-file-extension-in-import-ts": "^1.0.2",
+    "eslint-plugin-import": "^2.28.1",
     "pino-pretty": "^10.2.0",
     "prettier": "^3.0.2",
     "tsx": "^3.12.7",

package/src/index.ts

@@ -1,4 +1,3 @@
-import JSON5 from "json5";
 import pino, { Logger, LoggerOptions } from "pino";
 
 const pinoSettings: LoggerOptions = {
@@ -12,6 +11,7 @@ const pinoSettings: LoggerOptions = {
   },
 };
 
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
 const formatItem = (item: any): string => {
   if (typeof item === "undefined") {
     return "undefined";
@@ -19,19 +19,22 @@ const formatItem = (item: any): string => {
 
   // Remove colors from strings
   if (typeof item === "string") {
+    // eslint-disable-next-line no-control-regex
     return item.replace(/\x1b\[[0-9;]*m/g, "");
   }
 
   let stringified = "";
+
   try {
     stringified = JSON.stringify(item) || String(item);
   } catch {
     stringified = String(item);
   }
 
-  return stringified.replace(/^\'|\'$/g, "");
+  return stringified.replace(/^'|'$/g, "");
 };
 
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
 const format = (items: any[]): string => {
   return Array.from(items)
     .map((item) => formatItem(item))
@@ -39,35 +42,39 @@ const format = (items: any[]): string => {
 };
 
 const overrideConsole = (logger: Logger) => {
-  console.log = function () {
-    logger.info(format(Array.from(arguments)));
+  console.log = function (...args) {
+    logger.info(format(Array.from(args)));
   };
 
-  console.info = function () {
-    logger.info(format(Array.from(arguments)));
+  console.info = function (...args) {
+    logger.info(format(Array.from(args)));
   };
 
-  console.warn = function () {
-    logger.warn(format(Array.from(arguments)));
+  console.warn = function (...args) {
+    logger.warn(format(Array.from(args)));
   };
 
-  console.error = function () {
-    logger.error(format(Array.from(arguments)));
+  console.error = function (...args) {
+    logger.error(format(Array.from(args)));
   };
 
-  console.debug = function () {
-    logger.debug(format(Array.from(arguments)));
+  console.debug = function (...args) {
+    logger.debug(format(Array.from(args)));
   };
 };
 
+const loadPretty = async () => {
+  try {
+    return await import("pino-pretty");
+  } catch {
+    return null;
+  }
+};
+
 const setupLogging = async (
   settings: LoggerOptions = pinoSettings
 ): Promise<Logger> => {
-  let pretty;
-  try {
-    pretty = await import("pino-pretty");
-  } catch {}
-
+  const pretty = await loadPretty();
   const logger = pretty
     ? pino(settings, pretty.default({ colorize: true }))
     : pino(settings);