Skip to content

Validate, add and update copyright headers automatically, based on the git history.

License

Notifications You must be signed in to change notification settings

shybyte/copyright-header

Repository files navigation

Copyright-Header

npm Build Status Maintainability Test Coverage codecov dependencies Status

Validate, add and update copyright headers automatically, based on the git history.

Installation

NPM

Global:

npm i -g copyright-header

As local devDependency:

npm i -D copyright-header

Usage Hints

  • Use it inside of a git repo.
  • It will only affect files tracked by git.

Usage Examples (assuming global installation)

Validation:

copyright-header --copyrightHolder "Darth Fader" --include "src" --exclude "src/cli.ts"

Fixing:

copyright-header --fix --copyrightHolder "Darth Fader" --include "src" --exclude "src/cli.ts"

Options

Usage: copyright-header [options]

Options:

  --copyrightHolder <name>        Copyright Holder
  --fix                           adds or updates copyright header to files
  --templateId <id>               minimal | apache | gplv3 (default: minimal)
  -i, --include <paths>           include regexp file filter (default: )
  -e, --exclude <paths>           exclude regexp file filter (default: )
  --forceModificationYear <year>  number | "present"
  --excludeCommits <pattern>      ignores commits which message match this pattern
  -V, --version                   output the version number
  -h, --help                      output usage information

License

MIT

Copyright

Copyright (c) 2019 Marco Stahl

About

Validate, add and update copyright headers automatically, based on the git history.

Resources

License

Stars

Watchers

Forks

Packages

No packages published