remove-console-logs

Overview

remove-console-logs is a CLI tool to easily remove all console statements (e.g., console.log, console.error, console.warn) from JavaScript and TypeScript files in a specified directory. This tool is helpful for cleaning up your codebase before production deployment or for any project that requires the removal of console statements for any other reason.

Prerequisites

• Node.js: v14.0.0 or higher
• npm: v6.0.0 or higher

Make sure that you have Node.js and npm installed on your machine before installing this package. You can check your versions by running:

node -v
npm -v

If you need to install Node.js and npm, you can download and install it from nodejs.org.

Installation

Using npm

npm install -g remove-console-logs

Using yarn

yarn global add remove-console-logs

Usage

Navigate to the root of your project directory and run:

remove-console-logs

This will remove all console statements from the supported files in the current directory and its subdirectories.

Options

• --target=all: Removes all console statements (e.g., console.log, console.error, etc.).
• --no-save: Displays the changes that would be made without actually modifying the files.

Examples

• Remove all console.log statements (default behavior):

  remove-console-logs

• Remove all console statements (log, error, warn, etc.):

  remove-console-logs --target=all

• Preview changes without saving:

  remove-console-logs --no-save

Platform-Specific Instructions

Linux / Unix-like (MacOS, FreeBSD)

1. Open your terminal.
2. Install the package globally using npm or yarn (see installation steps above).
3. Navigate to your project directory.
4. Run remove-console-logs with the desired options.

Windows

1. Open your Command Prompt (cmd) or PowerShell as an Administrator.
2. Install the package globally using npm or yarn (see installation steps above).
3. Navigate to your project directory.
4. Run remove-console-logs with the desired options.

Contributing

Contributions, issues, and feature requests are welcome! Feel free to check out the issues page.

Author

Ganesh Sawant

License

This project is licensed under the MIT License - see the LICENSE file for details.