@visulima/pail 1.0.0

package/dist/types.d-RNxsa9NR.d.ts

@@ -0,0 +1,155 @@
+import { AnsiColors } from '@visulima/colorize';
+import { LiteralUnion, Primitive, UnknownArray, UnknownRecord } from 'type-fest';
+
+declare class InteractiveStreamHook {
+    #private;
+    static readonly DRAIN = true;
+    constructor(stream: NodeJS.WriteStream);
+    active(): void;
+    erase(count: number): void;
+    inactive(separateHistory?: boolean): void;
+    renew(): void;
+    write(message: string): void;
+}
+
+type StreamType = "stderr" | "stdout";
+declare class InteractiveManager {
+    #private;
+    constructor(stdout: InteractiveStreamHook, stderr: InteractiveStreamHook);
+    get lastLength(): number;
+    get outside(): number;
+    get isHooked(): boolean;
+    get isSuspended(): boolean;
+    erase(stream: StreamType, count?: number): void;
+    hook(): boolean;
+    resume(stream: StreamType, eraseRowCount?: number): void;
+    suspend(stream: StreamType, erase?: boolean): void;
+    unhook(separateHistory?: boolean): boolean;
+    update(stream: StreamType, rows: string[], from?: number): void;
+    private _clear;
+}
+
+/**
+ *  * This is a special exported interface for other packages/app to declare additional metadata for the logger.
+ */
+declare global {
+    namespace VisulimaPail {
+        // eslint-disable-next-line @typescript-eslint/no-empty-interface,@typescript-eslint/no-unused-vars
+        interface CustomMeta<L> {}
+    }
+}
+
+interface Meta<L> extends VisulimaPail.CustomMeta<L> {
+    badge: string | undefined;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    context: any[] | undefined;
+    date: Date | string;
+    error: Error | undefined;
+    groups: string[];
+    label: string | undefined;
+    message: Primitive | UnknownArray | UnknownRecord;
+    prefix: string | undefined;
+    repeated?: number | undefined;
+    scope: string[] | undefined;
+    suffix: string | undefined;
+    traceError: Error | undefined; // for internal use
+    type: {
+        level: ExtendedRfc5424LogLevels | L;
+        name: string;
+    };
+}
+
+type ExtendedRfc5424LogLevels = "alert" | "critical" | "debug" | "emergency" | "error" | "informational" | "notice" | "trace" | "warning";
+
+type DefaultLogTypes =
+    | "alert"
+    | "await"
+    | "complete"
+    | "critical"
+    | "debug"
+    | "emergency"
+    | "error"
+    | "info"
+    | "log"
+    | "notice"
+    | "pending"
+    | "start"
+    | "stop"
+    | "success"
+    | "trace"
+    | "wait"
+    | "warn"
+    | "watch";
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+type LoggerFunction = (...message: any[]) => void;
+// alias for backward-compatibility
+interface LoggerConfiguration<L extends string = never> {
+    badge?: string;
+    color?: AnsiColors | undefined;
+    label: string;
+    logLevel: LiteralUnion<ExtendedRfc5424LogLevels, L>;
+}
+
+type LoggerTypesConfig<T extends string, L extends string = never> = Record<T, Partial<LoggerConfiguration<L>>>;
+type DefaultLoggerTypes<L extends string = never> = Record<DefaultLogTypes, LoggerConfiguration<L>>;
+
+type ReadonlyMeta<L extends string = never> = Readonly<Meta<L>>;
+
+interface Reporter<L extends string = never> {
+    log: (meta: ReadonlyMeta<L>) => void;
+}
+
+interface StreamAwareReporter<L extends string = never> extends Reporter<L> {
+    setStderr: (stderr: NodeJS.WriteStream) => void;
+    setStdout: (stdout: NodeJS.WriteStream) => void;
+}
+
+interface LoggerTypesAwareReporter<T extends string = never, L extends string = never> extends Reporter<L> {
+    setLoggerTypes: (types: LoggerTypesConfig<T, L> & Partial<LoggerTypesConfig<DefaultLogTypes, L>>) => void;
+}
+
+interface StringifyAwareReporter<L extends string = never> extends Reporter<L> {
+    setStringify: (stringify: typeof JSON.stringify) => void;
+}
+
+interface InteractiveStreamReporter<L extends string = never> extends StreamAwareReporter<L> {
+    setInteractiveManager: (manager?: InteractiveManager) => void;
+    setIsInteractive: (interactive: boolean) => void;
+}
+
+interface Processor<L extends string = never> {
+    process: (meta: Meta<L>) => Meta<L>;
+}
+
+interface StringifyAwareProcessor<L extends string = never> extends Processor<L> {
+    setStringify: (stringify: typeof JSON.stringify) => void;
+}
+
+interface ConstructorOptions<T extends string = never, L extends string = never> {
+    disabled?: boolean;
+    logLevel?: LiteralUnion<ExtendedRfc5424LogLevels, L>;
+    logLevels?: Partial<Record<ExtendedRfc5424LogLevels, number>> & Record<L, number>;
+    messages?: {
+        timerEnd?: string;
+        timerStart?: string;
+    };
+    processors?: Processor<L>[];
+    rawReporter?: Reporter<L>;
+    reporters?: Reporter<L>[];
+    scope?: string[] | string;
+    throttle?: number;
+    throttleMin?: number;
+    // we can't negate DefaultLogTypes from string
+    // see https://github.com/microsoft/TypeScript/pull/29317 (not merged as for 31 march 2021)
+    // so we can't distinguish logger configuration between default log types and passed one
+    types?: LoggerTypesConfig<T, L> & Partial<LoggerTypesConfig<DefaultLogTypes, L>>;
+}
+
+interface ServerConstructorOptions<T extends string = never, L extends string = never> extends ConstructorOptions<T, L> {
+    interactive?: boolean;
+    stderr?: NodeJS.WriteStream;
+    stdout?: NodeJS.WriteStream;
+}
+
+export { type ConstructorOptions as C, type DefaultLoggerTypes as D, type ExtendedRfc5424LogLevels as E, InteractiveManager as I, type LoggerConfiguration as L, type Meta as M, type Processor as P, type Reporter as R, type StreamAwareReporter as S, type DefaultLogTypes as a, type LoggerFunction as b, type LoggerTypesAwareReporter as c, type LoggerTypesConfig as d, type ServerConstructorOptions as e, type ReadonlyMeta as f, type StringifyAwareReporter as g, type InteractiveStreamReporter as h, type StringifyAwareProcessor as i };

package/package.json

@@ -0,0 +1,256 @@
+{
+    "name": "@visulima/pail",
+    "version": "1.0.0",
+    "description": "Find a file or directory by walking up parent directories.",
+    "keywords": [
+        "anolilab",
+        "box",
+        "boxen",
+        "browser",
+        "browser-logger",
+        "callsite",
+        "callsites",
+        "cli",
+        "color",
+        "colorful",
+        "colorize",
+        "consola",
+        "console",
+        "console-logger",
+        "debug",
+        "error-logging",
+        "file-logger",
+        "file-logging",
+        "filesystem-logger",
+        "filter",
+        "fs-logger",
+        "handling exceptions",
+        "json",
+        "json-logger",
+        "json-logging",
+        "log level",
+        "log",
+        "log-cleaner",
+        "log-rotation",
+        "log4j",
+        "log4js",
+        "log4ts",
+        "logger",
+        "logging",
+        "node",
+        "node-logger",
+        "pail",
+        "pino",
+        "pretty-error",
+        "pretty-log",
+        "print",
+        "progress",
+        "redact",
+        "rotating-log",
+        "show error",
+        "timer",
+        "visulima",
+        "warning-logging",
+        "winston"
+    ],
+    "homepage": "https://www.visulima.com/docs/package/pail",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/visulima/visulima.git",
+        "directory": "packages/pail"
+    },
+    "funding": [
+        {
+            "type": "github",
+            "url": "https://github.com/sponsors/prisis"
+        },
+        {
+            "type": "consulting",
+            "url": "https://anolilab.com/support"
+        }
+    ],
+    "license": "MIT",
+    "author": {
+        "name": "Daniel Bannert",
+        "email": "d.bannert@anolilab.de",
+        "url": "https://danielbannert.com"
+    },
+    "sideEffects": false,
+    "type": "module",
+    "exports": {
+        ".": {
+            "browser": "./dist/index.browser.js",
+            "require": {
+                "types": "./dist/index.server.d.cts",
+                "default": "./dist/index.server.cjs"
+            },
+            "import": {
+                "types": "./dist/index.server.d.ts",
+                "default": "./dist/index.server.js"
+            }
+        },
+        "./browser": {
+            "require": {
+                "types": "./dist/index.browser.d.cts",
+                "default": "./dist/index.browser.cjs"
+            },
+            "import": {
+                "types": "./dist/index.browser.d.ts",
+                "default": "./dist/index.browser.js"
+            }
+        },
+        "./server": {
+            "require": {
+                "types": "./dist/index.server.d.cts",
+                "default": "./dist/index.server.cjs"
+            },
+            "import": {
+                "types": "./dist/index.server.d.ts",
+                "default": "./dist/index.server.js"
+            }
+        },
+        "./reporter": {
+            "browser": "./dist/reporter.browser.js",
+            "require": {
+                "types": "./dist/reporter.server.d.cts",
+                "default": "./dist/reporter.server.cjs"
+            },
+            "import": {
+                "types": "./dist/reporter.server.d.ts",
+                "default": "./dist/reporter.server.js"
+            }
+        },
+        "./browser/reporter": {
+            "require": {
+                "types": "./dist/reporter.browser.d.cts",
+                "default": "./dist/reporter.browser.cjs"
+            },
+            "import": {
+                "types": "./dist/reporter.browser.d.ts",
+                "default": "./dist/reporter.browser.js"
+            }
+        },
+        "./server/reporter": {
+            "browser": "./dist/reporter.browser.js",
+            "require": {
+                "types": "./dist/reporter.server.d.cts",
+                "default": "./dist/reporter.server.cjs"
+            },
+            "import": {
+                "types": "./dist/reporter.server.d.ts",
+                "default": "./dist/reporter.server.js"
+            }
+        },
+        "./processor": {
+            "browser": "./dist/processor.browser.js",
+            "require": {
+                "types": "./dist/processor.server.d.cts",
+                "default": "./dist/processor.server.cjs"
+            },
+            "import": {
+                "types": "./dist/processor.server.d.ts",
+                "default": "./dist/processor.server.js"
+            }
+        },
+        "./package.json": "./package.json"
+    },
+    "main": "dist/index.server.cjs",
+    "module": "dist/index.server.js",
+    "browser": "dist/index.browser.js",
+    "types": "dist/index.server.d.ts",
+    "files": [
+        "dist/**",
+        "README.md",
+        "CHANGELOG.md",
+        "LICENSE.md"
+    ],
+    "scripts": {
+        "build": "cross-env NODE_ENV=development tsup",
+        "build:prod": "cross-env NODE_ENV=production tsup",
+        "clean": "rimraf node_modules dist .eslintcache",
+        "dev": "pnpm run build --watch",
+        "lint:eslint": "eslint . --ext js,cjs,mjs,jsx,ts,tsx,json,yaml,yml,md,mdx --max-warnings=0 --config .eslintrc.cjs",
+        "lint:eslint:fix": "eslint . --ext js,cjs,mjs,jsx,ts,tsx,json,yaml,yml,md,mdx --max-warnings=0 --config .eslintrc.cjs --fix",
+        "lint:packagejson": "publint --strict",
+        "lint:prettier": "prettier --config=.prettierrc.cjs --check .",
+        "lint:prettier:fix": "prettier --config=.prettierrc.cjs --write .",
+        "lint:types": "tsc --noEmit || exit 0",
+        "test": "vitest run",
+        "test:coverage": "vitest run --coverage",
+        "test:ui": "vitest --ui --coverage.enabled=true",
+        "test:watch": "vitest"
+    },
+    "dependencies": {
+        "@visulima/colorize": "1.2.2",
+        "@visulima/fmt": "1.1.2",
+        "safe-stable-stringify": "^2.4.3",
+        "string-length": "^6.0.0",
+        "terminal-size": "^4.0.0",
+        "wrap-ansi": "^9.0.0"
+    },
+    "devDependencies": {
+        "@anolilab/eslint-config": "^15.0.3",
+        "@anolilab/prettier-config": "^5.0.14",
+        "@anolilab/semantic-release-preset": "^8.0.3",
+        "@babel/core": "^7.23.9",
+        "@rushstack/eslint-plugin-security": "^0.8.1",
+        "@secretlint/secretlint-rule-preset-recommend": "^8.1.2",
+        "@total-typescript/ts-reset": "^0.5.1",
+        "@types/node": "18.18.8",
+        "@vitest/coverage-v8": "^1.3.1",
+        "@vitest/ui": "^1.3.1",
+        "cross-env": "^7.0.3",
+        "eslint": "^8.57.0",
+        "eslint-plugin-deprecation": "^2.0.0",
+        "eslint-plugin-etc": "^2.0.3",
+        "eslint-plugin-import": "npm:eslint-plugin-i@^2.29.1",
+        "eslint-plugin-mdx": "^3.1.5",
+        "eslint-plugin-vitest": "^0.3.22",
+        "eslint-plugin-vitest-globals": "^1.4.0",
+        "prettier": "^3.2.5",
+        "rimraf": "^5.0.5",
+        "rotating-file-stream": "^3.2.1",
+        "secretlint": "8.1.2",
+        "semantic-release": "^23.0.2",
+        "sort-package-json": "^2.8.0",
+        "tsup": "^8.0.2",
+        "type-fest": "^4.10.3",
+        "typescript": "^5.3.3",
+        "vitest": "^1.3.1"
+    },
+    "peerDependencies": {
+        "rotating-file-stream": "^3.1.1"
+    },
+    "peerDependenciesMeta": {
+        "rotating-file-stream": {
+            "optional": true
+        }
+    },
+    "engines": {
+        "node": ">=18.* <=21.*"
+    },
+    "publishConfig": {
+        "access": "public",
+        "provenance": true
+    },
+    "anolilab": {
+        "eslint-config": {
+            "plugin": {
+                "tsdoc": false
+            },
+            "warn_on_unsupported_typescript_version": false,
+            "info_on_disabling_jsx_react_rule": false,
+            "info_on_disabling_prettier_conflict_rule": false,
+            "info_on_disabling_jsonc_sort_keys_rule": false,
+            "info_on_disabling_etc_no_deprecated": false
+        }
+    },
+    "sources": [
+        "src/index.browser.ts",
+        "src/index.server.ts",
+        "src/processor.browser.ts",
+        "src/processor.server.ts",
+        "src/reporter.browser.ts",
+        "src/reporter.server.ts"
+    ]
+}