TanTan
e311ca3275
Build NapCat Artifacts / Windows Loader Test (push) Canceled after 0s
Build NapCat Artifacts / Type Check & Test (push) Canceled after 0s
Build NapCat Artifacts / Build NapCat.Framework (push) Canceled after 0s
Build NapCat Artifacts / Build NapCat.Shell (push) Canceled after 0s
70 lines
1.7 KiB
Plaintext
70 lines
1.7 KiB
Plaintext
# blf-debug-appender
|
|
|
|
[](https://www.npmjs.com/package/blf-debug-appender)
|
|
|
|
[](https://npmjs.org/package/blf-debug-appender)
|
|
[](https://npmjs.org/package/blf-debug-appender)
|
|
[](LICENSE)
|
|
[](https://www.typescriptlang.org/)
|
|
|
|
> 🚀 A DebugAppender 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-debug-appender
|
|
```
|
|
|
|
### 2. Basic Usage
|
|
```typescript
|
|
// factory.ts
|
|
import { LogFactory } from 'base-log-factory';
|
|
import { DebugAppender } from 'blf-debug-appender';
|
|
|
|
export default new LogFactory({
|
|
appenders: [new DebugAppender()]
|
|
});
|
|
|
|
// 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)
|