prod-log

中文 | English

Console output for production environments.

[!WARNING] In principle, it is recommended to remove logs directly during the compilation process.

Project Background

There is a need for conditional output in the console of production environments, solely for development assistance in troubleshooting.

By default, logs are not output; only under certain conditions are some logs output.

Installation

  pnpm add prod-log

System Features

• Log Classification: Console messages are categorized with different prefixes to distinguish log sources;
• Conditional Output: In production environments, output is conditional, defaulting to no output;
• Remove Native: In production environments, prevents native console log output;
• Native Types: Corresponds to console's original classifications: log, warn, and error;
• Stack Information: All logs include call stack information;

Initialization

createPl({
    productEnv: import.meta.env.PROD,
    productLog: () => false,
    logIcon: true
})

Configuration Description

| Parameter | Description | Type | Default Value | |------------|---------------------------------|----------|---------------------------------------------------------------------| | productEnv | Whether it is a production environment | boolean | false | | productLog | Whether to output logs in production environment | function | () => new URL(location.href).searchParams.get("debug") === "true" | | logIcon | Whether to output log icons | boolean | true |

Examples

1. Development environment log: Pl.dev('dev')
2. Production environment log: Pl.prod('prod',obj)
3. User behavior: Pl.user('Select list',obj)
4. System output: Pl.sys('Login successful',{obj})
5. API response: Pl.res('API return',{obj})
6. System version: Pl.version('System version','0.0.1')

Syntax

Pl.user(info, obj, logLevel)

Parameter Description

| Parameter | Description | Type | |-----------|------------------------------------------|----------| | info | Log title | string | | obj | Message object to be output | object | | logLevel | Log level ('info','warn','error') | boolean |

Log Level LogLevel

1. Normal: Pl.res('Normal log')
2. Warning: Pl.res('404',{data},'warn')
3. Error: Pl.res('Network exception',{data},'error')

Log Stack

Each log output will carry call stack information

Log Output Conditions

1. In the development environment, all categories and levels of logs are output.
2. Logs with log levels (LogLevel) of warn and error are output in all environments.
3. dev type logs are only output in the development environment.
4. prod type logs are output in any environment.
5. version type logs are output in any environment.
6. user type logs, in the production environment, are not output by default. They are only output when the URL carries debug=true.
7. res type logs, in the production environment, are not output by default. They are only output when the URL carries debug=true.
8. sys type logs, in the production environment, are not output by default. They are only output when the URL carries debug=prod.