Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/belguinan/pretty-js-log
A light logging package for Node.js and Bun applications. Features file logging and beautiful console output.
https://github.com/belguinan/pretty-js-log
ansi-colors bun-js cli-tools console-log debug-tools developer-tools file-logger javascript log-management logging monitoring node-logger nodejs npm terminal-colors
Last synced: about 1 month ago
JSON representation
A light logging package for Node.js and Bun applications. Features file logging and beautiful console output.
- Host: GitHub
- URL: https://github.com/belguinan/pretty-js-log
- Owner: belguinan
- License: mit
- Created: 2024-10-28T18:31:19.000Z (about 2 months ago)
- Default Branch: master
- Last Pushed: 2024-11-06T19:02:29.000Z (about 2 months ago)
- Last Synced: 2024-11-14T15:59:06.828Z (about 1 month ago)
- Topics: ansi-colors, bun-js, cli-tools, console-log, debug-tools, developer-tools, file-logger, javascript, log-management, logging, monitoring, node-logger, nodejs, npm, terminal-colors
- Language: JavaScript
- Homepage:
- Size: 60.5 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Pretty-js-log 📝
[](https://github.com/belguinan/pretty-js-log/actions/workflows/node.js.yml)
[](https://www.npmjs.com/package/pretty-js-log)
[](https://www.npmjs.com/package/pretty-js-log)
[](LICENSE)
[](https://bundlephobia.com/package/[email protected])
[](https://bundlephobia.com/package/[email protected])
A lightweight and colorful logging package for Node.js and Bun applications. Makes your console output beautiful and saves logs to files!
## Features
- Colorful console output
- File logging support
- Multiple log levels (info, warn, error, debug)
- Support for both Node.js and Bun
- JSON object / Array formatting
- Custom IDs for tracking (like process ID)
- Timezone-aware timestamps
## Installation 🚀
```bash
# Using npm
npm install pretty-js-log
```
```bash
# Using bun
bun install pretty-js-log
```
## Quick Start 🎯
```javascript
const { logFactory } = require('pretty-js-log');
// Create a basic logger
const logger = logFactory({});
// Log some messages
logger('Hello World');
logger.info('This is an info message');
logger.warn('Warning! Something needs attention');
logger.error('Oops! Something went wrong');
logger.debug('Debug information');
```
## Output 🎑
## Advanced Usage 🔧
### Save Logs to File
```javascript
const logger = logFactory({
path: './logs/app.log', // Logs will be saved here
id: process.pid // Add process ID to logs
});
logger('This will be saved to the file too!');
```
### Logging Objects
```javascript
const data = {
user: 'john',
age: 25
};
logger('User data:', data); // Objects are automatically formatted
```
### Disable Console Output
If you want to write logs only to file without console output, use the `toStdout` option:
```javascript
const logger = logFactory({
path: './logs/app.log',
toStdout: false // Logs will only be written to file
});
logger('This will only appear in the log file');
logger.info('Silent logging to file');
````
## Output Examples 🎨
When you run your logs, they'll look something like this in the console:
```
[2024-03-15 10:30:45] - [id:1234] - Hello World
[2024-03-15 10:30:46] - [id:1234] - This is an info message
[2024-03-15 10:30:47] - [id:1234] - Warning! Something needs attention
```
## Contributing 🤝
Feel free to open issues and submit PRs! This is an open-source project and we welcome contributions.
## License 📄
MIT License - feel free to use this in your projects!
## Todo 📋
- [ ] File logging rotation based on file size or on dates.
- [ ] Add support for external logging API's endpoints.
## Author 👨💻
Belguinan Noureddine
GitHub: https://github.com/belguinan