commit | cbb27a78d402a206ea85a672c4db6b8921ba7ba3 | [log] [tgz] |
---|---|---|
author | Hoshea <fgksgf@gmail.com> | Mon Nov 23 20:23:33 2020 +0800 |
committer | Hoshea <fgksgf@gmail.com> | Mon Nov 23 20:23:33 2020 +0800 |
tree | 7fa7e50f1b42f09a091d0bcc2609d1630312a768 | |
parent | cbb2a6a7d17adae2a3ec23696990da9bf74b92bb [diff] |
Update doc
A CLI tool for checking license headers, which theoretically supports checking all types of files.
git clone https://github.com/fgksgf/license-checker.git cd license-checker make
Usage: license-checker [flags] license-checker walks the specified path recursively and checks if the specified files have the license header in the config file. Usage: license-checker [flags] Flags: -c, --config string the config file (default ".licenserc.json") -h, --help help for license-checker -l, --loose loose mode -p, --path string the path to check (default ".") -v, --verbose verbose mode
{ // What to check in strict mode, the order of strings can NOT be changed arbitrarily "licenseStrict": [ "Licensed to the Apache Software Foundation (ASF) under one or more", "contributor license agreements. See the NOTICE file distributed with", "..." ], // What to check in loose mode, the order of strings can NOT be changed arbitrarily "licenseLoose": [ "Apache License, Version 2.0" ], // license-checker will check *.java and *.go "targetFiles": [ "java", "go" ], "exclude": { // license-checker will NOT check these files "files": [ ".gitignore", "NOTICE", "LICENSE" ], // license-checker will NOT check files whose names with these extensions "extensions": [ "md", "xml", "json" ], // license-checker will NOT check these directories "directories": [ "bin", ".github" ] } }
bin/license-checker -p test -c test/.licenserc_for_test.json [No Specified License]: test/include_test/without_license/testcase.go [No Specified License]: test/include_test/without_license/testcase.graphql [No Specified License]: test/include_test/without_license/testcase.java [No Specified License]: test/include_test/without_license/testcase.py [No Specified License]: test/include_test/without_license/testcase.sh [No Specified License]: test/include_test/without_license/testcase.yaml [No Specified License]: test/include_test/without_license/testcase.yml Total check 14 files, success: 7, failure: 7