npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

chalk-scripts

v1.2.8

Published

Advanced logging in style

Downloads

5,761

Readme

Given your updated context, I'll revise the README to reflect the installation process through npm and clarify the dependency management, including whether users need to install chalk separately. If chalk is a dependency of chalk-scripts and is properly listed in its package.json, users typically won't need to install it separately. It will be installed automatically with your package.


Node Scripts Logging Utility

Node Scripts Logging Utility is a comprehensive logging module for Node.js applications, providing advanced functionalities to capture, format, and save log data effectively.

Features

  • Customizable Logging: Supports various log types, including reports, details, alerts, and errors.
  • Configurable Log and Save Order: Customize the order of properties in log output and saved files.
  • Dynamic Log Formatting: Utilizes chalk for enhanced, colored console outputs.
  • Persistent File Logging: Option to save logs to structured JSON files.
  • Elapsed Time Calculation: Automatically tracks and displays elapsed time for log entries.

Installation

Install the package via npm:

npm install chalk-scripts

This will also install necessary dependencies, including chalk.

Usage

Importing the Module

Import the scripts module in your project:

import { scripts } from 'chalk-scripts';

Configuration

Create a script.config.json file in your project's root directory to customize default settings:

{
  "root": "my/custom/log/path",
  "logOrder": ["id", "elapsed", "stack", "func"],
  "saveOrder": ["id", "created", "elapsed", "func", "stack"]
}

Basic Logging

Example of logging various messages:

scripts.start({ func: 'myFunction' })
  .report('Starting the process')
  .detail('Detailed information')
  .alerts('An alert message')
  .errors('Error encountered')
  .log();

Saving Logs

To save logs to a file:

scripts.save('optionalDirectoryName');

Advanced Usage

Refer to the extensive documentation provided with the package for advanced features and detailed usage instructions.

Contributing

We welcome contributions! Please submit pull requests for improvements or bug fixes to the chalk-scripts package. Follow the existing code structure and document new features for clarity.


Note: Make sure to adjust any specific instructions or package details based on how chalk-scripts is actually used and configured. The README should accurately reflect your package's capabilities and requirements.