A command-line tool written in Rust for replacing or adding a comment header to source files. This tool is particularly useful for managing and standardizing license headers across multiple files in a codebase.

• Replace or Add Headers: Automatically replaces existing headers or adds a new header to source files.
• Supports Multiple Languages: Compatible with programming languages that utilize /* and */ for multi-line comments, including Rust, Swift, C#, C, C++, TypeScript, and others.
• Customizable Headers: Use a custom header read from a file and replace placeholders with dynamic content such as the repository URL.

To build and run this tool, you'll need to have Rust installed. You can install Rust from rustup.rs.

cargo install comment-header-rs

The tool is invoked from the command line and takes the following arguments:

comment-header-rs --path <DIRECTORY> --license <FILE>

• --path <DIRECTORY>: The root directory to recursively scan for source files.
• --license <FILE>: Path to the file containing the new header.
• --extensions <EXTENSIONS>: Comma-separated list of file extensions. (default: rs,cs).

You can include specific variables in your license file that will be automatically replaced with relevant values when the header is added to your source files. This allows for dynamic content, making your headers more informative and tailored to your project.

• $origin. This variable will be replaced with the Git URL of the origin remote repository. It provides a direct link to the repository where the source code is hosted, which can be useful for reference and compliance.

Assuming you have a header file header.txt and want to apply it recursively to all .rs and .cs files in the src directory:

Create a header file, header.txt, with the desired content, eg:

/*
 * Copyright (c) Your Name. All rights reserved.
 * Licensed under the MIT License.
 */

Run the tool:

comment-header-rs --path src --license header.txt

This will replace or add the header to all Rust and C# files in the src directory.

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