|
| 1 | +/** |
| 2 | + * Options for creating a webpack logger. |
| 3 | + */ |
| 4 | +interface WebpackLogOptions { |
| 5 | + /** |
| 6 | + * Log level. Default: 'info'. |
| 7 | + */ |
| 8 | + level?: "trace" | "debug" | "info" | "warn" | "error" | "silent"; |
| 9 | + |
| 10 | + /** |
| 11 | + * Name of the logger. Default: '<webpack-log>'. |
| 12 | + */ |
| 13 | + name?: string; |
| 14 | + |
| 15 | + /** |
| 16 | + * Whether to include timestamp in output. Default: false. |
| 17 | + */ |
| 18 | + timestamp?: boolean; |
| 19 | + |
| 20 | + /** |
| 21 | + * Whether to generate unique logger ID. Default: true. |
| 22 | + */ |
| 23 | + unique?: boolean; |
| 24 | +} |
| 25 | + |
| 26 | +/** |
| 27 | + * Logger instance returned by webpack-log. |
| 28 | + */ |
| 29 | +interface WebpackLogger { |
| 30 | + /** |
| 31 | + * Log at trace level. |
| 32 | + */ |
| 33 | + trace(...args: unknown[]): void; |
| 34 | + |
| 35 | + /** |
| 36 | + * Log at debug level. |
| 37 | + */ |
| 38 | + debug(...args: unknown[]): void; |
| 39 | + |
| 40 | + /** |
| 41 | + * Log at info level. |
| 42 | + */ |
| 43 | + info(...args: unknown[]): void; |
| 44 | + |
| 45 | + /** |
| 46 | + * Log at warn level. |
| 47 | + */ |
| 48 | + warn(...args: unknown[]): void; |
| 49 | + |
| 50 | + /** |
| 51 | + * Log at error level. |
| 52 | + */ |
| 53 | + error(...args: unknown[]): void; |
| 54 | +} |
| 55 | + |
| 56 | +/** |
| 57 | + * Creates a logger for the Webpack ecosystem. |
| 58 | + * |
| 59 | + * @param options - Logger configuration options |
| 60 | + * @returns A logger instance with trace, debug, info, warn, and error methods |
| 61 | + * |
| 62 | + * @example |
| 63 | + * ```javascript |
| 64 | + * const getLogger = require('webpack-log'); |
| 65 | + * |
| 66 | + * const log = getLogger({ name: 'my-plugin' }); |
| 67 | + * log.info('Starting plugin'); |
| 68 | + * log.error('Something went wrong'); |
| 69 | + * ``` |
| 70 | + */ |
| 71 | +declare function getLogger(options?: WebpackLogOptions): WebpackLogger; |
| 72 | + |
| 73 | +declare namespace getLogger { |
| 74 | + export { WebpackLogger, WebpackLogOptions }; |
| 75 | +} |
| 76 | + |
| 77 | +export = getLogger; |
0 commit comments