friendly-logger v0.2.0

Important Note

As of version < 1, Friendly Logger is still in the early stages of development and may not be stable. We recommend caution when integrating it into production environments. Your feedback and contributions are highly encouraged to help improve the library.

Friendly Logger

Friendly Logger is a user-friendly logging utility for Node.js applications that offers a clear and intuitive approach to handling log messages. With its simple API and robust features, it's designed to make your debugging process smoother and more efficient.

Key Features

• Easy-to-use API: A straightforward interface allows you to quickly integrate logging into your projects.
• Clear Message Display: Utilizes console colors to differentiate between log levels, ensuring critical messages stand out.
• Configurable Output: Customize how logs are displayed or stored, whether it's in the console, a file, or any other destination.
• Current format style(s):

[TIMESTAMP] - LEVEL: MESSAGE

comment: <> (Extensible Architecture: The modular design enables adding new transports and formatters without hassle.)

Getting Started

Install Friendly Logger:

npm install friendly-logger

Then, import and initialize the logger in your Node.js application:

import FriendlyLogger from "friendly-logger";

const logger = FriendlyLogger({
  logLevels: {
    alert: "gray",
    info: "seagreen",
    critical: "lightpink",
  },
});

logger.alert("System memory usage is high!");
logger.info("Application has started successfully.");
const simulatedError = new Error("Database connection failed.");
logger.critical("Critical system failure encountered.", simulatedError);

Configuration

Along with providing log colors for levels, you can specify a file path for log storage.

const logFile = fs.createWriteStream("application.log", { flags: "a" });

const logger = FriendlyLogger({
  logLevels: {
    alert: "gray",
    info: "seagreen",
    critical: "lightpink",
  },
  output: logFile,
});

comment: <> (Extending Friendly Logger) comment: <> (The library is designed to be extended. You can create custom transports or formatters to tailor the logging functionality to your specific requirements.)

Contributing

We appreciate contributions. If you find a bug or have an idea for a feature, please open an issue or submit a pull request.

License

Friendly Logger is released under the MIT License. See the LICENSE file for details.