awesome-logging
Version:
Advanced logging messages, interactive prompts, loading animations and more in TypeScript
131 lines (89 loc) ā¢ 4.92 kB
Markdown
[](https://www.npmjs.com/package/awesome-logging)
[](https://github.com/LoaderB0T/awesome-logging/actions/workflows/build.yml)
[](https://sonarcloud.io/summary/new_code?id=LoaderB0T_awesome-logging)
[](https://bundlephobia.com/package/awesome-logging)
# awesome-logging
An awesome set of logging and prompting utilities for Node.js.
## Motivation š„
**awesome-logging** is a collection of fancy text outputs and inputs for CLI tools written in NodeJS.
No matter what you want to log to the terminal or what information you need from the user, **awesome-logging** will help you do so.
- You want to show the progress of a certain task while also logging messages to the terminal while keeping everything nice and formatted? No problem.
- You want the user to select one or multiple options of a given list? Sure thing!
- You want to log messages in the background while showing a fancy animation or a prompt to the user? Go for it!
## Features š„
ā
Written in TypeScript (Strongly typed)
ā
Live-update logging messages in a reliable way
ā
ESM syntax
ā
Multi-line logging
ā
Flicker-free output, even on Windows
ā
Loading animations and progress bars
ā
Interactive prompts to get user input
ā
Interrupt currently playing animations with regular log entries
ā
Extendable design (add your own loggers / prompts)
One example of a multiline logger with many different logger types: (Not particularly pretty, but shows the idea)
## Built With š§
- [TypeScript](https://www.typescriptlang.org/)
## Installation š¦
```console
pnpm i awesome-logging
// or
yarn add awesome-logging
// or
npm i awesome-logging
```
## Docs š
Find a bit of documentation [here](https://github.com/LoaderB0T/awesome-logging/blob/main/DOCS.md).
## Usage Example š
```typescript
import { AwesomeLogger } from 'awesome-logging';
```
```typescript
// Example: Simple text logging
AwesomeLogger.log('Welcome to awesome-logging!');
const logControl = AwesomeLogger.log('Is this a logging library?');
setTimeout(() => logControl.setText('This is an awesome-logging library!'), 1500);
setTimeout(() => logControl.setText('Cool!'), 3000);
```
```typescript
// Example: Simple text logging (with line breaks)
const textA = 'One line of text...';
const textB = 'Multiple\nLines\nof Text!';
let state = true;
const logControl = AwesomeLogger.log(textA);
setInterval(() => {
state = !state;
logControl.setText(state ? textA : textB);
}, 1000);
```
```typescript
// Example: Progress Bar
const logProgressControl = AwesomeLogger.log('progress', {
totalProgress: 100,
text: 'Very important progress:'
});
let i = 0;
const interval = setInterval(() => {
logProgressControl.setProgress(i++);
if (i === 100) {
clearInterval(interval);
}
}, 500);
```
## Contributing š§š»āš»
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## License š
Distributed under the MIT License. See `LICENSE.txt` for more information.
## Contact š§
Janik Schumacher - [@LoaderB0T](https://twitter.com/LoaderB0T) - [linkedin](https://www.linkedin.com/in/janikschumacher/)
Project Link: [https://github.com/LoaderB0T/awesome-logging](https://github.com/LoaderB0T/awesome-logging)