Comments Remover

A powerful command-line tool for removing comments from Dart files in your Flutter projects. Whether you need a cleaner codebase for production, code reviews, or learning purposes, Comments Remover helps you strip out single-line (//) and multi-line (/* */) comments effortlessly.

Why Use Comments Remover?

Comments are invaluable during development for documentation and debugging, but there are cases where removing them is useful:

  • Minification: Reduce file size for production builds, improving performance and readability.
  • Code Review: Focus on logic and structure without distractions from comments.
  • Learning: Clean up example project (e.g., Flutter counter app).
  • Obfuscation: Remove sensitive or unnecessary annotations before sharing code or submitting assignments.

Installation

Add Comments Remover to your pubspec.yaml in the dev_dependencies section:

dev_dependencies:
  comments_remover: ^1.0.2

Or run this command:

flutter pub add -d comments_remover

Usage

Remove Comments from Dart Files By default, comments_remover processes all Dart files in the lib/ directory.

flutter pub run comments_remover

Command Options

Option Description
--path Specify a target file or directory (defaults to lib/).
--single-line Remove only single-line comments (//).
--multi-line Remove only multi-line comments (/* */).

Examples

  1. Remove all comments from a specific file:
flutter pub run comments_remover --path lib/main.dart
  1. Remove only single-line comments from all Dart files in lib/:
flutter pub run comments_remover --single-line
  1. Remove only multi-line comments from a specific directory:
flutter pub run comments_remover --path lib/src --multi-line

Example Output

Input File (Before):

// This is a single-line comment
void main() {
  /* This is a multi-line
     comment */
  print("Hello"); // Inline comment
}

Output File (After):

void main() {
  print("Hello");
}

Contributing

We welcome contributions! Here's how you can help:

  1. Fork the repository.
  2. Create a new branch for your feature or fix.
  3. Commit your changes with clear commit messages.
  4. Push to your fork and submit a Pull Request.

Feel free to open issues for bug reports, feature requests, or suggestions.

License

This project is licensed under the MIT License. See the LICENSE file for more details.

Libraries

comments_remover
main