@vidavidorra/bunyan-pretty-stream 3.0.16 → 4.0.0-beta.1

package/package.json

@@ -1,33 +1,26 @@
 {
   "name": "@vidavidorra/bunyan-pretty-stream",
-  "version": "3.0.16",
-  "description": "Highly configurable Bunyan stream with pretty output.",
-  "main": "dist/src/index.js",
-  "types": "dist/src/index.d.ts",
+  "version": "4.0.0-beta.1",
+  "description": "Highly configurable Bunyan stream with pretty output",
+  "type": "module",
+  "exports": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "publishConfig": {
     "access": "public"
   },
   "files": [
-    "dist/src/**/!(*.test).{js,d.ts}"
+    "./dist/**/!(*.test).{js,d.ts}"
   ],
   "scripts": {
     "prepare": "husky install .github/husky",
-    "lint": "run-p format:check lint-es",
-    "lint:fix": "run-s format lint-es:fix",
-    "lint-es": "eslint --ext .ts,.tsx,.js,.jsx,.json .",
-    "lint-es:file": "eslint --ext .ts,.tsx,.js,.jsx,.json",
-    "lint-es:fix": "eslint --ext .ts,.tsx,.js,.jsx,.json --fix .",
-    "lint-es:file:fix": "eslint --ext .ts,.tsx,.js,.jsx,.json --fix",
-    "format": "prettier --ignore-path .eslintignore --write \"**/*.{js,jsx,vue,ts,css,less,scss,html,htm,json,md,markdown,yml,yaml}\"",
-    "format:check": "prettier --ignore-path .eslintignore --check \"**/*.{js,jsx,vue,ts,css,less,scss,html,htm,json,md,markdown,yml,yaml}\"",
-    "format:file": "prettier --write",
+    "lint": "run-p format:check xo",
+    "lint:fix": "run-p format 'xo -- --fix'",
+    "format:check": "prettier --ignore-path .gitignore --check \"**/*.{vue,css,less,scss,html,htm,json,md,markdown,yml,yaml}\" --loglevel warn",
+    "format": "prettier --ignore-path .gitignore --write \"**/*.{vue,css,less,scss,html,htm,json,md,markdown,yml,yaml}\" --loglevel warn",
+    "xo": "xo",
     "build": "tsc",
     "build:check": "tsc --noEmit",
-    "build:clean-first": "run-s clean build",
-    "clean": "rm -rf ./dist",
-    "test": "jest",
-    "test:ci": "jest --ci --verbose --coverage",
-    "test:staged": "jest --passWithNoTests --findRelatedTests $(git diff --staged --name-only)"
+    "test": "c8 ava"
   },
   "repository": {
     "type": "git",
@@ -48,48 +41,202 @@
   },
   "homepage": "https://github.com/vidavidorra/bunyan-pretty-stream#readme",
   "engines": {
-    "node": ">=14.0.0"
+    "node": ">=18"
   },
   "devDependencies": {
-    "@commitlint/cli": "17.4.2",
-    "@jest/globals": "29.4.2",
+    "@ava/typescript": "3.0.1",
+    "@commitlint/cli": "17.4.4",
     "@semantic-release/changelog": "6.0.2",
     "@semantic-release/exec": "6.0.3",
     "@semantic-release/git": "10.0.1",
     "@types/bunyan": "1.8.8",
-    "@types/clone": "2.1.1",
-    "@types/node": "18.13.0",
-    "@typescript-eslint/eslint-plugin": "5.51.0",
-    "@typescript-eslint/parser": "5.51.0",
-    "@vidavidorra/commitlint-config": "4.0.10",
+    "@types/luxon": "3.2.0",
+    "@types/node": "18.14.1",
+    "@vidavidorra/commitlint-config": "4.0.12",
+    "ava": "5.2.0",
     "bunyan": "*",
     "bunyan-1.x": "npm:bunyan@1.8.15",
     "bunyan-2.x": "npm:bunyan@2.0.5",
-    "clone": "2.1.2",
-    "dot-prop": "6.0.1",
-    "eslint": "8.33.0",
-    "eslint-config-prettier": "8.6.0",
-    "eslint-plugin-jest": "27.2.1",
-    "eslint-plugin-json": "3.1.0",
-    "eslint-plugin-prettier": "4.2.1",
+    "c8": "7.13.0",
+    "chalk": "5.2.0",
+    "deepmerge": "4.3.0",
+    "dot-prop": "7.2.0",
     "husky": "8.0.3",
-    "jest": "29.4.2",
-    "lint-staged": "13.1.1",
+    "lint-staged": "13.1.2",
     "npm-run-all": "4.1.5",
     "prettier": "2.8.4",
-    "semantic-release": "19.0.5",
-    "strip-ansi": "6.0.1",
-    "ts-jest": "29.0.5",
-    "typescript": "4.9.5"
+    "semantic-release": "20.1.0",
+    "strip-ansi": "7.0.1",
+    "typescript": "4.9.5",
+    "xo": "0.53.1"
   },
   "peerDependencies": {
-    "bunyan": "1.8.15"
+    "bunyan": ">=1.8.15 <3"
   },
   "dependencies": {
-    "@sindresorhus/is": "4.6.0",
-    "chalk": "4.1.2",
-    "json-stringify-pretty-compact": "3.0.0",
-    "moment": "2.29.4",
-    "zod": "3.20.5"
+    "@sindresorhus/is": "5.3.0",
+    "json-stringify-pretty-compact": "4.0.0",
+    "luxon": "3.2.1",
+    "zod": "3.20.6"
+  },
+  "ava": {
+    "files": [
+      "!worktrees",
+      "src/**/*.test.ts"
+    ],
+    "typescript": {
+      "rewritePaths": {
+        "src/": "dist/"
+      },
+      "compile": "tsc"
+    }
+  },
+  "c8": {
+    "include": [
+      "dist/**/*.js"
+    ],
+    "reporter": [
+      "cobertura",
+      "html",
+      "lcovonly",
+      "text-summary"
+    ]
+  },
+  "xo": {
+    "prettier": true,
+    "rules": {
+      "object-curly-spacing": "off"
+    },
+    "space": true
+  },
+  "commitlint": {
+    "extends": [
+      "@vidavidorra"
+    ]
+  },
+  "prettier": {
+    "singleQuote": true,
+    "trailingComma": "all"
+  },
+  "release": {
+    "branches": [
+      "main",
+      {
+        "name": "beta",
+        "prerelease": true
+      }
+    ],
+    "plugins": [
+      [
+        "@semantic-release/commit-analyzer",
+        {
+          "releaseRules": [
+            {
+              "type": "perf",
+              "release": "patch"
+            },
+            {
+              "type": "revert",
+              "release": "patch"
+            },
+            {
+              "type": "docs",
+              "release": "patch"
+            },
+            {
+              "type": "chore",
+              "release": false
+            },
+            {
+              "type": "refactor",
+              "release": "patch"
+            },
+            {
+              "type": "test",
+              "release": "patch"
+            },
+            {
+              "type": "build",
+              "release": "patch"
+            },
+            {
+              "type": "ci",
+              "release": "patch"
+            }
+          ]
+        }
+      ],
+      "@semantic-release/release-notes-generator",
+      "@semantic-release/changelog",
+      [
+        "@semantic-release/exec",
+        {
+          "prepareCmd": "prettier --write CHANGELOG.md"
+        }
+      ],
+      [
+        "@semantic-release/npm",
+        {
+          "tarballDir": "dist"
+        }
+      ],
+      "@semantic-release/git",
+      [
+        "@semantic-release/github",
+        {
+          "assets": "dist/*.tgz"
+        }
+      ]
+    ],
+    "preset": "conventionalcommits",
+    "presetConfig": {
+      "types": [
+        {
+          "type": "feat",
+          "section": "Features"
+        },
+        {
+          "type": "fix",
+          "section": "Bug Fixes"
+        },
+        {
+          "type": "perf",
+          "section": "Performance Improvements"
+        },
+        {
+          "type": "revert",
+          "section": "Reverts"
+        },
+        {
+          "type": "docs",
+          "section": "Documentation"
+        },
+        {
+          "type": "style",
+          "section": "Styles"
+        },
+        {
+          "type": "chore",
+          "section": "Miscellaneous Chores",
+          "hidden": true
+        },
+        {
+          "type": "refactor",
+          "section": "Code Refactoring"
+        },
+        {
+          "type": "test",
+          "section": "Tests"
+        },
+        {
+          "type": "build",
+          "section": "Build System"
+        },
+        {
+          "type": "ci",
+          "section": "Continuous Integration"
+        }
+      ]
+    }
   }
 }

package/dist/src/bunyan-pretty-stream.d.ts

@@ -1,10 +0,0 @@
-/// <reference types="node" />
-/// <reference types="node" />
-import { Transform, TransformCallback } from 'stream';
-import { Options } from './options';
-declare class PrettyStream extends Transform {
-    private _formatter;
-    constructor(options?: Options);
-    _transform(chunk: any, encoding: BufferEncoding, done: TransformCallback): void;
-}
-export { PrettyStream };

package/dist/src/bunyan-pretty-stream.js

@@ -1,32 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PrettyStream = void 0;
-const stream_1 = require("stream");
-const bunyan_record_1 = require("./bunyan-record");
-const formatter_1 = require("./formatter");
-const is_1 = __importDefault(require("@sindresorhus/is"));
-class PrettyStream extends stream_1.Transform {
-    constructor(options = {}) {
-        super({ objectMode: true });
-        this._formatter = new formatter_1.Formatter(options);
-    }
-    _transform(
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/explicit-module-boundary-types
-    chunk, encoding, done) {
-        if (is_1.default.string(chunk)) {
-            this.push(this._formatter.format((0, bunyan_record_1.fromString)(chunk)));
-            done();
-        }
-        else if ((0, bunyan_record_1.isBunyanRecord)(chunk)) {
-            this.push(this._formatter.format(chunk));
-            done();
-        }
-        else {
-            done(new Error('data MUST be a valid bunyan record'));
-        }
-    }
-}
-exports.PrettyStream = PrettyStream;

package/dist/src/bunyan-record.d.ts

@@ -1,19 +0,0 @@
-interface BunyanCoreRecord {
-    v: number;
-    level: number;
-    name: string;
-    hostname: string;
-    pid: number;
-    time: Date;
-    msg: string;
-    src?: {
-        file: string;
-        line: number;
-        func?: string;
-    };
-}
-type BunyanRecord = BunyanCoreRecord & Record<string, unknown>;
-declare function coreFields(): string[];
-declare function isBunyanRecord(value: unknown): value is BunyanRecord;
-declare function fromString(json: string): BunyanRecord;
-export { BunyanRecord, coreFields, fromString, isBunyanRecord };

package/dist/src/bunyan-record.js

@@ -1,55 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isBunyanRecord = exports.fromString = exports.coreFields = void 0;
-const is_1 = __importDefault(require("@sindresorhus/is"));
-function coreFields() {
-    const record = {
-        v: 0,
-        level: 0,
-        name: '',
-        hostname: '',
-        pid: 0,
-        time: new Date(0),
-        msg: '',
-        src: {
-            file: '',
-            line: 0,
-            func: '',
-        },
-    };
-    return Object.keys(record);
-}
-exports.coreFields = coreFields;
-function isBunyanRecord(value) {
-    return (is_1.default.plainObject(value) &&
-        is_1.default.number(value.v) &&
-        is_1.default.number(value.level) &&
-        is_1.default.string(value.name) &&
-        is_1.default.string(value.hostname) &&
-        is_1.default.number(value.pid) &&
-        is_1.default.date(value.time) &&
-        is_1.default.string(value.msg) &&
-        (is_1.default.undefined(value.src) ||
-            (is_1.default.plainObject(value.src) &&
-                is_1.default.number(value.src.line) &&
-                (is_1.default.undefined(value.src.func) || is_1.default.string(value.src.func)))));
-}
-exports.isBunyanRecord = isBunyanRecord;
-function fromString(json) {
-    const record = JSON.parse(json, (key, value) => {
-        if (key === 'time' &&
-            is_1.default.string(value) &&
-            /^((\+-)\d{2})?\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}Z$/.test(value)) {
-            return new Date(value);
-        }
-        return value;
-    });
-    if (!isBunyanRecord(record)) {
-        throw new Error('string MUST be parsable to a valid Bunyan record');
-    }
-    return record;
-}
-exports.fromString = fromString;

package/dist/src/formatter/extras.d.ts

@@ -1,34 +0,0 @@
-import { ParsedOptions } from '../options';
-declare class Extras {
-    readonly options: {
-        readonly keyValueSeparator: "=";
-        readonly separator: ", ";
-        readonly start: "(";
-        readonly end: ")";
-    };
-    private readonly _maxLength;
-    private _extras;
-    private _length;
-    constructor(maxLength: ParsedOptions['extras']['maxLength']);
-    get length(): number;
-    get extras(): string[];
-    /**
-     * Parse a key-value pair and add to the extras if it is a valid extra.
-     *
-     * @param key
-     * @param value
-     * @returns `true` if the key-value was valid and is added, false otherwise.
-     */
-    parseAndAdd(key: string, value: unknown): boolean;
-    format(): string;
-    formatExtra(key: string, value: unknown): {
-        formatted: string;
-        key: string;
-        value: string;
-    };
-    private lengthAfterAdding;
-    private add;
-    private stringify;
-    private containsWhitespace;
-}
-export { Extras };

package/dist/src/formatter/extras.js

@@ -1,94 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Extras = void 0;
-class Extras {
-    constructor(maxLength) {
-        this.options = {
-            keyValueSeparator: '=',
-            separator: ', ',
-            start: '(',
-            end: ')',
-        };
-        this._maxLength = maxLength;
-        this._length = 0;
-        this._extras = [];
-    }
-    get length() {
-        return this._length;
-    }
-    get extras() {
-        return this._extras;
-    }
-    /**
-     * Parse a key-value pair and add to the extras if it is a valid extra.
-     *
-     * @param key
-     * @param value
-     * @returns `true` if the key-value was valid and is added, false otherwise.
-     */
-    parseAndAdd(key, value) {
-        if ((typeof value === 'object' && value !== null) ||
-            typeof value === 'function') {
-            return false;
-        }
-        const extra = this.formatExtra(key, value);
-        if (extra.key.length > this._maxLength.key ||
-            extra.value.length > this._maxLength.value ||
-            this.lengthAfterAdding(extra.formatted) > this._maxLength.total) {
-            return false;
-        }
-        this.add(extra.formatted);
-        return true;
-    }
-    format() {
-        if (this._extras.length === 0) {
-            return '';
-        }
-        return [
-            this.options.start,
-            this._extras.join(this.options.separator),
-            this.options.end,
-        ].join('');
-    }
-    formatExtra(key, value) {
-        const stringifiedKey = this.stringify(key);
-        const stringifiedValue = this.stringify(value);
-        const formatted = [
-            stringifiedKey,
-            this.options.keyValueSeparator,
-            stringifiedValue,
-        ].join('');
-        return {
-            formatted,
-            key: stringifiedKey,
-            value: stringifiedValue,
-        };
-    }
-    lengthAfterAdding(formattedExtra) {
-        let length = this._length + formattedExtra.length;
-        if (this._length === 0) {
-            length += this.options.start.length + this.options.end.length;
-        }
-        else if (this._extras.length >= 1) {
-            length += this.options.separator.length;
-        }
-        return length;
-    }
-    add(formattedExtra) {
-        this._extras.push(formattedExtra);
-        this._length = this.lengthAfterAdding(formattedExtra);
-    }
-    stringify(value) {
-        if (typeof value === 'string' &&
-            value.length > 0 &&
-            !this.containsWhitespace(value) &&
-            !value.includes(this.options.keyValueSeparator)) {
-            return value;
-        }
-        return JSON.stringify(value);
-    }
-    containsWhitespace(value) {
-        return /\s/.test(value);
-    }
-}
-exports.Extras = Extras;

package/dist/src/formatter/formatter.d.ts

@@ -1,34 +0,0 @@
-import { BunyanRecord } from '../bunyan-record';
-import { Options } from '../options';
-import { Extras } from './extras';
-import moment from 'moment';
-interface ParsedRecord extends Pick<BunyanRecord, 'level' | 'name' | 'hostname' | 'pid'> {
-    version: BunyanRecord['v'];
-    time: moment.Moment;
-    message: BunyanRecord['msg'];
-    source: BunyanRecord['src'];
-    extras: Extras;
-    details: Record<string, unknown>;
-}
-declare class Formatter {
-    private readonly _options;
-    private readonly _regex;
-    private readonly _internalOptions;
-    private readonly _levels;
-    constructor(options: Options);
-    parse(record: BunyanRecord): ParsedRecord;
-    format(record: BunyanRecord): string;
-    formatTime(time: ParsedRecord['time']): string;
-    formatLevel(level: ParsedRecord['level']): string;
-    formatName(name: ParsedRecord['name']): string;
-    formatPid(pid: ParsedRecord['pid']): string;
-    formatHostname(hostname: ParsedRecord['hostname']): string;
-    formatSource(source: ParsedRecord['source']): string;
-    formatMessage(message: ParsedRecord['message']): string;
-    formatExtras(extras: ParsedRecord['extras']): string;
-    formatDetails(message: ParsedRecord['message'], details: ParsedRecord['details']): string;
-    isSingleLine(string: string): boolean;
-    containsWhitespace(string: string): boolean;
-    indent(input: string, leading?: boolean): string;
-}
-export { ParsedRecord, Formatter };