@ad-execute-manager/logger 2.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +181 -0
- package/dist/Logger.d.ts +35 -0
- package/dist/index.cjs +1 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.js +1 -0
- package/package.json +66 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 singcl
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,181 @@
|
|
|
1
|
+
# @ad-execute-manager/logger
|
|
2
|
+
|
|
3
|
+
A flexible logging utility for JavaScript applications with multiple log levels and customizable prefixes.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @ad-execute-manager/logger
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Features
|
|
12
|
+
|
|
13
|
+
- **Multiple Log Levels**: Support for error, warn, info, log, and debug levels
|
|
14
|
+
- **Customizable Prefix**: Add a prefix to identify the source of logs
|
|
15
|
+
- **Log Level Control**: Set minimum log level to filter out less important messages
|
|
16
|
+
- **Enable/Disable**: Toggle logging on and off as needed
|
|
17
|
+
- **TypeScript Support**: Includes TypeScript type definitions
|
|
18
|
+
|
|
19
|
+
## Usage
|
|
20
|
+
|
|
21
|
+
### Basic Usage
|
|
22
|
+
|
|
23
|
+
```javascript
|
|
24
|
+
import { Logger } from '@ad-execute-manager/logger';
|
|
25
|
+
|
|
26
|
+
// Create a logger instance
|
|
27
|
+
const logger = new Logger({
|
|
28
|
+
prefix: 'MyApp',
|
|
29
|
+
level: 'info',
|
|
30
|
+
enabled: true
|
|
31
|
+
});
|
|
32
|
+
|
|
33
|
+
// Log messages at different levels
|
|
34
|
+
logger.error('Something went wrong');
|
|
35
|
+
logger.warn('This is a warning');
|
|
36
|
+
logger.info('Application started');
|
|
37
|
+
logger.log('Regular message');
|
|
38
|
+
logger.debug('Debug information');
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
### Log Level Control
|
|
42
|
+
|
|
43
|
+
```javascript
|
|
44
|
+
import { Logger } from '@ad-execute-manager/logger';
|
|
45
|
+
|
|
46
|
+
// Create logger with different levels
|
|
47
|
+
const productionLogger = new Logger({
|
|
48
|
+
prefix: 'App',
|
|
49
|
+
level: 'warn' // Only show warn and error messages
|
|
50
|
+
});
|
|
51
|
+
|
|
52
|
+
const developmentLogger = new Logger({
|
|
53
|
+
prefix: 'App',
|
|
54
|
+
level: 'debug' // Show all messages
|
|
55
|
+
});
|
|
56
|
+
|
|
57
|
+
// Change level dynamically
|
|
58
|
+
productionLogger.setLevel('info');
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
### Enable/Disable Logging
|
|
62
|
+
|
|
63
|
+
```javascript
|
|
64
|
+
import { Logger } from '@ad-execute-manager/logger';
|
|
65
|
+
|
|
66
|
+
const logger = new Logger({ prefix: 'MyApp' });
|
|
67
|
+
|
|
68
|
+
// Disable logging
|
|
69
|
+
logger.disable();
|
|
70
|
+
logger.info('This won\'t be logged');
|
|
71
|
+
|
|
72
|
+
// Enable logging
|
|
73
|
+
logger.enable();
|
|
74
|
+
logger.info('This will be logged');
|
|
75
|
+
|
|
76
|
+
// Check if logging is enabled
|
|
77
|
+
if (logger.isEnabled()) {
|
|
78
|
+
logger.log('Logging is enabled');
|
|
79
|
+
}
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
### Real-world Examples
|
|
83
|
+
|
|
84
|
+
#### 1. Application Logging
|
|
85
|
+
|
|
86
|
+
```javascript
|
|
87
|
+
import { Logger } from '@ad-execute-manager/logger';
|
|
88
|
+
|
|
89
|
+
// Create logger based on environment
|
|
90
|
+
const logger = new Logger({
|
|
91
|
+
prefix: 'MyApp',
|
|
92
|
+
level: process.env.NODE_ENV === 'production' ? 'info' : 'debug'
|
|
93
|
+
});
|
|
94
|
+
|
|
95
|
+
// Log application startup
|
|
96
|
+
logger.info('Application started');
|
|
97
|
+
|
|
98
|
+
// Log errors
|
|
99
|
+
function handleError(error) {
|
|
100
|
+
logger.error('Error occurred:', error);
|
|
101
|
+
// Error handling logic
|
|
102
|
+
}
|
|
103
|
+
|
|
104
|
+
// Log debug information
|
|
105
|
+
function processData(data) {
|
|
106
|
+
logger.debug('Processing data:', data);
|
|
107
|
+
// Processing logic
|
|
108
|
+
logger.info('Data processed successfully');
|
|
109
|
+
}
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
#### 2. Module-specific Logging
|
|
113
|
+
|
|
114
|
+
```javascript
|
|
115
|
+
import { Logger } from '@ad-execute-manager/logger';
|
|
116
|
+
|
|
117
|
+
// Create logger for different modules
|
|
118
|
+
const authLogger = new Logger({ prefix: 'AuthModule' });
|
|
119
|
+
const apiLogger = new Logger({ prefix: 'APIModule' });
|
|
120
|
+
const dbLogger = new Logger({ prefix: 'DBModule' });
|
|
121
|
+
|
|
122
|
+
// Use in different modules
|
|
123
|
+
function login(user) {
|
|
124
|
+
authLogger.info('User login attempt:', user.username);
|
|
125
|
+
// Login logic
|
|
126
|
+
}
|
|
127
|
+
|
|
128
|
+
function fetchData() {
|
|
129
|
+
apiLogger.debug('Fetching data from API');
|
|
130
|
+
// API call
|
|
131
|
+
apiLogger.info('Data fetched successfully');
|
|
132
|
+
}
|
|
133
|
+
|
|
134
|
+
function saveData(data) {
|
|
135
|
+
dbLogger.debug('Saving data to database');
|
|
136
|
+
// Database operation
|
|
137
|
+
dbLogger.info('Data saved successfully');
|
|
138
|
+
}
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
## API
|
|
142
|
+
|
|
143
|
+
### Constructor
|
|
144
|
+
|
|
145
|
+
```javascript
|
|
146
|
+
new Logger(options)
|
|
147
|
+
```
|
|
148
|
+
|
|
149
|
+
- **options** (Object): Configuration options
|
|
150
|
+
- **prefix** (String): Log prefix, defaults to 'Logger'
|
|
151
|
+
- **level** (String): Log level, options: 'error', 'warn', 'info', 'log', 'debug', defaults to 'log'
|
|
152
|
+
- **enabled** (Boolean): Whether logging is enabled, defaults to true
|
|
153
|
+
|
|
154
|
+
### Methods
|
|
155
|
+
|
|
156
|
+
- **enable()**: Enable logging
|
|
157
|
+
- **disable()**: Disable logging
|
|
158
|
+
- **isEnabled()**: Return whether logging is enabled
|
|
159
|
+
- **setLevel(level)**: Set log level
|
|
160
|
+
- **level** (String): Log level
|
|
161
|
+
- **error(message, ...args)**: Output error log
|
|
162
|
+
- **warn(message, ...args)**: Output warning log
|
|
163
|
+
- **info(message, ...args)**: Output info log
|
|
164
|
+
- **log(message, ...args)**: Output regular log
|
|
165
|
+
- **debug(message, ...args)**: Output debug log
|
|
166
|
+
|
|
167
|
+
### Log Levels
|
|
168
|
+
|
|
169
|
+
| Level | Description | Methods |
|
|
170
|
+
|---------|------------------------------|--------------------|
|
|
171
|
+
| error | Error messages | logger.error() |
|
|
172
|
+
| warn | Warning messages | logger.warn() |
|
|
173
|
+
| info | Information messages | logger.info() |
|
|
174
|
+
| log | Regular messages | logger.log() |
|
|
175
|
+
| debug | Debug information | logger.debug() |
|
|
176
|
+
|
|
177
|
+
The log level is hierarchical, meaning if you set the level to 'info', it will show info, warn, and error messages, but not log or debug messages.
|
|
178
|
+
|
|
179
|
+
## License
|
|
180
|
+
|
|
181
|
+
MIT
|
package/dist/Logger.d.ts
ADDED
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
export class Logger {
|
|
2
|
+
/**
|
|
3
|
+
*
|
|
4
|
+
* @param {object} [options]
|
|
5
|
+
* @param {string} [options.prefix] - 日志前缀
|
|
6
|
+
* @param {'error'|'warn'|'info'|'log'|'debug'} [options.level] - 日志级别
|
|
7
|
+
* @param {boolean} [options.enabled] - 是否启用日志
|
|
8
|
+
*/
|
|
9
|
+
constructor(options?: {
|
|
10
|
+
prefix?: string;
|
|
11
|
+
level?: "error" | "warn" | "info" | "log" | "debug";
|
|
12
|
+
enabled?: boolean;
|
|
13
|
+
});
|
|
14
|
+
prefix: string;
|
|
15
|
+
enabled: boolean;
|
|
16
|
+
levels: {
|
|
17
|
+
error: number;
|
|
18
|
+
warn: number;
|
|
19
|
+
info: number;
|
|
20
|
+
log: number;
|
|
21
|
+
debug: number;
|
|
22
|
+
};
|
|
23
|
+
currentLevel: number;
|
|
24
|
+
enable(): void;
|
|
25
|
+
disable(): void;
|
|
26
|
+
isEnabled(): boolean;
|
|
27
|
+
setLevel(level: any): void;
|
|
28
|
+
formatMessage(level: any, message: any): string;
|
|
29
|
+
_log(level: any, message: any, ...args: any[]): void;
|
|
30
|
+
error(message: any, ...args: any[]): void;
|
|
31
|
+
warn(message: any, ...args: any[]): void;
|
|
32
|
+
info(message: any, ...args: any[]): void;
|
|
33
|
+
log(message: any, ...args: any[]): void;
|
|
34
|
+
debug(message: any, ...args: any[]): void;
|
|
35
|
+
}
|
package/dist/index.cjs
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
"use strict";const __rslib_import_meta_url__="u"<typeof document?new(require("url".replace("",""))).URL("file:"+__filename).href:document.currentScript&&document.currentScript.src||new URL("main.js",document.baseURI).href;var __webpack_require__={};__webpack_require__.d=(e,r)=>{for(var _ in r)__webpack_require__.o(r,_)&&!__webpack_require__.o(e,_)&&Object.defineProperty(e,_,{enumerable:!0,get:r[_]})},__webpack_require__.o=(e,r)=>Object.prototype.hasOwnProperty.call(e,r),__webpack_require__.r=e=>{"u">typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})};var __webpack_exports__={};__webpack_require__.r(__webpack_exports__),__webpack_require__.d(__webpack_exports__,{Logger:()=>Logger});class Logger{constructor(e={}){const{prefix:r="Logger",level:_="log",enabled:t=!0}=e;this.prefix=r,this.enabled=t,this.levels={error:0,warn:1,info:2,log:3,debug:4},this.currentLevel=this.levels[_]||this.levels.log}enable(){this.enabled=!0}disable(){this.enabled=!1}isEnabled(){return this.enabled}setLevel(e){Object.prototype.hasOwnProperty.call(this.levels,e)&&(this.currentLevel=this.levels[e])}formatMessage(e,r){let _=new Date,t=`${_.getFullYear()}/${_.getMonth()+1}/${_.getDate()} ${_.getHours()}:${_.getMinutes()}:${_.getSeconds()}`;return`[${t}] [${e.toUpperCase()}] [${this.prefix}] ${r}`}_log(e,r,..._){if(!this.enabled)return;let t=this.levels[e];if(void 0!==t&&this.currentLevel>=t){let t=this.formatMessage(e,r);switch(e){case"error":console.error(t,..._);break;case"warn":console.warn(t,..._);break;case"info":console.info(t,..._);break;case"log":default:console.log(t,..._);break;case"debug":console.debug(t,..._)}}}error(e,...r){this._log("error",e,...r)}warn(e,...r){this._log("warn",e,...r)}info(e,...r){this._log("info",e,...r)}log(e,...r){this._log("log",e,...r)}debug(e,...r){this._log("debug",e,...r)}}for(var __rspack_i in exports.Logger=__webpack_exports__.Logger,__webpack_exports__)-1===["Logger"].indexOf(__rspack_i)&&(exports[__rspack_i]=__webpack_exports__[__rspack_i]);Object.defineProperty(exports,"__esModule",{value:!0});
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export { Logger } from "./Logger.js";
|
package/dist/index.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
class e{constructor(e={}){let{prefix:t="Logger",level:s="log",enabled:l=!0}=e;this.prefix=t,this.enabled=l,this.levels={error:0,warn:1,info:2,log:3,debug:4},this.currentLevel=this.levels[s]||this.levels.log}enable(){this.enabled=!0}disable(){this.enabled=!1}isEnabled(){return this.enabled}setLevel(e){Object.prototype.hasOwnProperty.call(this.levels,e)&&(this.currentLevel=this.levels[e])}formatMessage(e,t){let s=new Date,l=`${s.getFullYear()}/${s.getMonth()+1}/${s.getDate()} ${s.getHours()}:${s.getMinutes()}:${s.getSeconds()}`;return`[${l}] [${e.toUpperCase()}] [${this.prefix}] ${t}`}_log(e,t,...s){if(!this.enabled)return;let l=this.levels[e];if(void 0!==l&&this.currentLevel>=l){let l=this.formatMessage(e,t);switch(e){case"error":console.error(l,...s);break;case"warn":console.warn(l,...s);break;case"info":console.info(l,...s);break;case"log":default:console.log(l,...s);break;case"debug":console.debug(l,...s)}}}error(e,...t){this._log("error",e,...t)}warn(e,...t){this._log("warn",e,...t)}info(e,...t){this._log("info",e,...t)}log(e,...t){this._log("log",e,...t)}debug(e,...t){this._log("debug",e,...t)}}export{e as Logger};
|
package/package.json
ADDED
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@ad-execute-manager/logger",
|
|
3
|
+
"version": "2.0.1",
|
|
4
|
+
"description": "A flexible logging utility for JavaScript applications with multiple log levels and customizable prefixes.",
|
|
5
|
+
"type": "module",
|
|
6
|
+
"exports": {
|
|
7
|
+
".": {
|
|
8
|
+
"import": "./dist/index.js",
|
|
9
|
+
"require": "./dist/index.cjs",
|
|
10
|
+
"types": "./dist/index.d.ts"
|
|
11
|
+
}
|
|
12
|
+
},
|
|
13
|
+
"main": "./dist/index.cjs",
|
|
14
|
+
"types": "./dist/index.d.ts",
|
|
15
|
+
"files": [
|
|
16
|
+
"dist"
|
|
17
|
+
],
|
|
18
|
+
"author": {
|
|
19
|
+
"name": "singcl",
|
|
20
|
+
"email": "iambabyer@gmail.com",
|
|
21
|
+
"url": "https://github.com/singcl"
|
|
22
|
+
},
|
|
23
|
+
"license": "MIT",
|
|
24
|
+
"homepage": "https://npmjs.com/package/@ad-execute-manager/logger",
|
|
25
|
+
"repository": {
|
|
26
|
+
"type": "git",
|
|
27
|
+
"url": "git+https://github.com/singcl/ad-execute-manager.git",
|
|
28
|
+
"directory": "packages/logger"
|
|
29
|
+
},
|
|
30
|
+
"bugs": {
|
|
31
|
+
"url": "https://github.com/singcl/ad-execute-manager/issues"
|
|
32
|
+
},
|
|
33
|
+
"engines": {
|
|
34
|
+
"node": ">=14.0.0"
|
|
35
|
+
},
|
|
36
|
+
"keywords": [
|
|
37
|
+
"logger",
|
|
38
|
+
"logging",
|
|
39
|
+
"utility",
|
|
40
|
+
"javascript",
|
|
41
|
+
"nodejs",
|
|
42
|
+
"typescript",
|
|
43
|
+
"log-levels",
|
|
44
|
+
"debug"
|
|
45
|
+
],
|
|
46
|
+
"scripts": {
|
|
47
|
+
"build": "rslib build && tsc",
|
|
48
|
+
"dev": "rslib build --watch",
|
|
49
|
+
"format": "prettier --write .",
|
|
50
|
+
"lint": "eslint .",
|
|
51
|
+
"test": "rstest",
|
|
52
|
+
"prepublishOnly": "npm run build"
|
|
53
|
+
},
|
|
54
|
+
"devDependencies": {
|
|
55
|
+
"@babel/eslint-parser": "^7.28.5",
|
|
56
|
+
"@babel/preset-env": "^7.28.5",
|
|
57
|
+
"@eslint/js": "^9.39.1",
|
|
58
|
+
"@rslib/core": "^0.18.5",
|
|
59
|
+
"@rstest/core": "^0.7.2",
|
|
60
|
+
"eslint": "^9.39.2",
|
|
61
|
+
"eslint-plugin-import": "^2.32.0",
|
|
62
|
+
"globals": "^16.5.0",
|
|
63
|
+
"prettier": "^3.7.3",
|
|
64
|
+
"typescript": "^5.9.3"
|
|
65
|
+
}
|
|
66
|
+
}
|