Skip to content

A program which ensures source code files have copyright license headers by scanning directory patterns recursively

Notifications You must be signed in to change notification settings

marmotedu/addlicense

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

授权头检查和添加工具

安装

$ go get -u github.com/marmotedu/addlicense

帮助信息为:

$ addlicense -h
Usage: addlicense [flags] pattern [pattern ...]

The program ensures source code files have copyright license headers
by scanning directory patterns recursively.

It modifies all source files in place and avoids adding a license header
to any file that already has one.

The pattern argument can be provided multiple times, and may also refer
to single files.

Flags:

      --check                check only mode: verify presence of license headers and exit with non-zero code if missing
  -h, --help                 show this help message
  -c, --holder string        copyright holder (default "Google LLC")
  -l, --license string       license type: apache, bsd, mit, mpl (default "apache")
  -f, --licensef string      custom license file (no default)
      --skip-dirs strings    regexps of directories to skip
      --skip-files strings   regexps of files to skip
  -v, --verbose              verbose mode: print the name of the files that are modified
  -y, --year string          copyright year(s) (default "2021")

参数说明:

  • --check 只检查
  • -f, --licensef 指定版权头文件
  • -v 打印被更改的文件
  • --skip-dirs 跳过指定的文件夹

使用方法

  1. 创建版权头文件
$ cat ./boilerplate.txt
Copyright 2020 Lingfei Kong <colin404@foxmail.com>. All rights reserved.
Use of this source code is governed by a MIT style
license that can be found in the LICENSE file.
  1. 检查文件中是否都有该版权头
$ addlicense --check -f ./boilerplate.txt . --skip-dirs=third_party
  1. 给缺失版权头的文件添加版权头
$ addlicense -v -f ./boilerplate.txt . --skip-dirs=third_party

About

A program which ensures source code files have copyright license headers by scanning directory patterns recursively

Resources

Stars

Watchers

Forks

Packages

No packages published