3 unstable releases

0.2.1 Mar 16, 2024
0.2.0 Mar 16, 2024
0.1.0 Mar 15, 2024

#1210 in Command line utilities

MPL-2.0 license

31KB
150 lines

add-notice

License Crates.io Minimum Supported Rust Version CI

A cli tool to add headers notices to files

Usage: add-notice [OPTIONS]

Options:
  -n, --notice <NOTICE>
          path to the notice file [default: ./NOTICE]
      --dir <DIR>
          directory to apply the notice [default: .]
  -e, --extensions <EXTENSIONS>
          select files by extension, e.g. rs,js,kt [default: rs]
  -c, --comment-style <COMMENT_STYLE>
          comment style [default: //]
  -r, --remove
          remove notice in files
      --replace-with-string <REPLACE_WITH_STRING>
          replace notice with string
      --replace-with-file <REPLACE_WITH_FILE>
          replace notice with file content
  -h, --help
          Print help
  -V, --version
          Print version

Installation

Cargo install

Compile the crate yourself with:

cargo install add-notice

Cargo binstall

Install a binary version:

cargo binstall add-notice

Purpose

Makes the process of adding header notices to files easier.

Like those requested by licenses such as MPL2.0:

This Source Code Form is subject to the terms of the Mozilla Public
License, v. 2.0. If a copy of the MPL was not distributed with this
file, You can obtain one at https://mozilla.org/MPL/2.0/.

Dependencies

~5–13MB
~154K SLoC