TanTan
2a69b23b47
Dev Build / cleanup (push) Canceled after 0s
Dev Build / typecheck (push) Canceled after 0s
Dev Build / build (linux-arm64, ubuntu-24.04-arm, linux-arm64) (push) Canceled after 0s
Dev Build / build (linux-x64, ubuntu-latest, linux-x64) (push) Canceled after 0s
Dev Build / build (win-x64, windows-latest, win32-x64) (push) Canceled after 0s
Dev Build / dispatch-dev-docker (push) Skipped
70 lines
1.7 KiB
Plaintext
70 lines
1.7 KiB
Plaintext
# blf-colorful-appender
|
|
|
|
[](https://www.npmjs.com/package/blf-colorful-appender)
|
|
|
|
[](https://npmjs.org/package/blf-colorful-appender)
|
|
[](https://npmjs.org/package/blf-colorful-appender)
|
|
[](LICENSE)
|
|
[](https://www.typescriptlang.org/)
|
|
|
|
> 🚀 A ColorfulAppender for `base-log-factory`.
|
|
|
|
---
|
|
|
|
## 📅 Documentation
|
|
|
|
For detailed usage instructions and API references, please visit the official documentation:
|
|
|
|
👉 [View Full Documentation](https://fengxinming.github.io/base-log-factory/)
|
|
|
|
---
|
|
|
|
## 🚀 Quick Start
|
|
|
|
### 1. Installation
|
|
```bash
|
|
npm install base-log-factory blf-colorful-appender
|
|
```
|
|
|
|
### 2. Basic Usage
|
|
```typescript
|
|
// factory.ts
|
|
import { LogFactory } from 'base-log-factory';
|
|
import { ColorfulAppender } from 'blf-colorful-appender';
|
|
|
|
export default new LogFactory({
|
|
appenders: [new ColorfulAppender()]
|
|
});
|
|
|
|
// main.ts
|
|
import logFactory from './factory';
|
|
|
|
const logger = logFactory.getLogger('app');
|
|
logger.info('Server started successfully');
|
|
```
|
|
|
|
---
|
|
|
|
## 📝 Contribution Guide
|
|
|
|
1. **Development Setup**
|
|
```bash
|
|
npm install
|
|
```
|
|
|
|
2. **Testing**
|
|
```bash
|
|
npm test # Run unit tests
|
|
```
|
|
|
|
3. **Before Submitting PRs**
|
|
- Ensure ESLint is configured (VSCode plugin recommended)
|
|
- Add test cases for new features
|
|
- Update documentation
|
|
|
|
---
|
|
|
|
## 📄 License
|
|
|
|
[MIT License](../../LICENSE)
|