#header #tool #cli #license #config-file #rust

app rust-license

rust tool to check, remove or apply license header to rust files

1 unstable release

0.1.0 May 23, 2024

#1399 in Command line utilities

Apache-2.0

17KB
368 lines

rust-license

rust-license is a tool inspired by https://github.com/palantir/go-license.
This tool ensures that a license header is applied to a list of files.

Usage

Create a yaml config file rust-license.yaml containing the headers you want to apply in your project

headers: |
  // Copyright (c) 2024 najeal, All rights reserved.
  // See the file LICENSE for licensing terms.

Apply headers

using the tool you can apply this license to your files (with --apply flag):
rust-license license-header --config rust-license.yaml --apply your-first-file.txt your-second-file.rust

Check headers

you can check the license is in your files (with --check flag), the tool will print the paths of files not containing the header:
rust-license license-header --config rust-license.yaml --check your-first-file.txt your-second-file.rust

Remove headers

you can delete the license from your files (with --remove flag):
rust-license license-header --config rust-license.yaml --remove your-first-file.txt your-second-file.rust

Dependencies

~5.5–7.5MB
~134K SLoC