goodcheck

goodcheck documentation

• Visit Official Web Site
• See How to configure goodcheck rules
  • If custom goodcheck.yml config file is not found, goodcheck.yml will be used
• See Index of problems detected by goodcheck

Configuration in MegaLinter

• Enable goodcheck by adding REPOSITORY_GOODCHECK in ENABLE_LINTERS variable
• Disable goodcheck by adding REPOSITORY_GOODCHECK in DISABLE_LINTERS variable

Variable	Description	Default value
REPOSITORY_GOODCHECK_ARGUMENTS	User custom arguments to add in linter CLI call Ex: -s --foo "bar"
REPOSITORY_GOODCHECK_FILE_EXTENSIONS	Allowed file extensions. "*" matches any extension, "" matches empty extension. Empty list excludes all files Ex: [".py", ""]	Exclude every file
REPOSITORY_GOODCHECK_FILE_NAMES_REGEX	File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files Ex: ["Dockerfile(-.+)?", "Jenkinsfile"]	Include every file
REPOSITORY_GOODCHECK_PRE_COMMANDS	List of bash commands to run before the linter	None
REPOSITORY_GOODCHECK_POST_COMMANDS	List of bash commands to run after the linter	None
REPOSITORY_GOODCHECK_CONFIG_FILE	goodcheck configuration file name Use LINTER_DEFAULT to let the linter find it	goodcheck.yml
REPOSITORY_GOODCHECK_RULES_PATH	Path where to find linter configuration file	Workspace folder, then MegaLinter default rules
REPOSITORY_GOODCHECK_DISABLE_ERRORS	Run linter but consider errors as warnings	false
REPOSITORY_GOODCHECK_DISABLE_ERRORS_IF_LESS_THAN	Maximum number of errors allowed	0

MegaLinter Flavours

This linter is available in the following flavours

	Flavor	Description	Embedded linters	Info
	all	Default MegaLinter Flavor	101
	ci_light	Optimized for CI items (Dockerfile, Jenkinsfile, JSON/YAML schemas,XML	18
	documentation	MegaLinter for documentation projects	42
	dotnet	Optimized for C, C++, C# or VB based projects	50
	go	Optimized for GO based projects	44
	java	Optimized for JAVA based projects	44
	javascript	Optimized for JAVASCRIPT or TYPESCRIPT based projects	51
	php	Optimized for PHP based projects	46
	python	Optimized for PYTHON based projects	50
	ruby	Optimized for RUBY based projects	43
	rust	Optimized for RUST based projects	43
	salesforce	Optimized for Salesforce based projects	45
	swift	Optimized for SWIFT based projects	43
	terraform	Optimized for TERRAFORM based projects	48

Behind the scenes

How are identified applicable files

• Activated only if one of these files is found: goodcheck.yml
• If this linter is active, all files will always be linted

How the linting is performed

goodcheck is called once on the whole project directory

• filtering can not be done using MegaLinter configuration variables,it must be done using goodcheck configuration or ignore file (if existing)
• VALIDATE_ALL_CODEBASE: false does not make goodcheck analyze only updated files

Example calls

goodcheck check

goodcheck check -c goodcheck.yml

Help content

Usage: goodcheck <command> [options] [args...]

Commands:
  goodcheck init  Generate a sample configuration file
  goodcheck check  Run check with a configuration
  goodcheck test  Test your configuration
  goodcheck pattern  Print regexp for rules
  goodcheck version  Print version
  goodcheck help  Show help and quit

Installation on mega-linter Docker image

• GEM packages (Ruby) :
  • goodcheck