editorconfig-checker

editorconfig-checker documentation

Version in Mega-Linter: 2.3.5
Visit Official Web Site
See How to configure editorconfig-checker rules
See How to disable editorconfig-checker rules in files

Configuration in Mega-Linter

Enable editorconfig-checker by adding EDITORCONFIG_EDITORCONFIG_CHECKER in ENABLE_LINTERS variable
Disable editorconfig-checker by adding EDITORCONFIG_EDITORCONFIG_CHECKER in DISABLE_LINTERS variable

Variable	Description	Default value
EDITORCONFIG_EDITORCONFIG_CHECKER_ARGUMENTS	User custom arguments to add in linter CLI call Ex: `-s --foo "bar"`
EDITORCONFIG_EDITORCONFIG_CHECKER_FILTER_REGEX_INCLUDE	Custom regex including filter Ex: `(src\\|lib)`	Include every file
EDITORCONFIG_EDITORCONFIG_CHECKER_FILTER_REGEX_EXCLUDE	Custom regex excluding filter Ex: `(test\\|examples)`	Exclude no file
EDITORCONFIG_EDITORCONFIG_CHECKER_CLI_LINT_MODE	Override default CLI lint mode - `file`: Calls the linter for each file - `list_of_files`: Call the linter with the list of files as argument - `project`: Call the linter from the root of the project	`{linter.cli_lint_mode}`
EDITORCONFIG_EDITORCONFIG_CHECKER_FILE_EXTENSIONS	Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files Ex: `[".py", ""]`	`["*"]`
EDITORCONFIG_EDITORCONFIG_CHECKER_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
EDITORCONFIG_EDITORCONFIG_CHECKER_PRE_COMMANDS	List of bash commands to run before the linter	None
EDITORCONFIG_EDITORCONFIG_CHECKER_POST_COMMANDS	List of bash commands to run after the linter	None
EDITORCONFIG_EDITORCONFIG_CHECKER_CONFIG_FILE	editorconfig-checker configuration file name Use `LINTER_DEFAULT` to let the linter find it	`.ecrc`
EDITORCONFIG_EDITORCONFIG_CHECKER_RULES_PATH	Path where to find linter configuration file	Workspace folder, then Mega-Linter default rules
EDITORCONFIG_EDITORCONFIG_CHECKER_DISABLE_ERRORS	Run linter but consider errors as warnings	`false`
EDITORCONFIG_EDITORCONFIG_CHECKER_DISABLE_ERRORS_IF_LESS_THAN	Maximum number of errors allowed	`0`

Mega-Linter Flavours

This linter is available in the following flavours

Flavor	Description	Embedded linters
all	Default Mega-Linter Flavor	94
dart	Optimized for DART based projects	41
documentation	Mega-Linter for documentation projects	40
dotnet	Optimized for C, C++, C# or VB based projects	47
go	Optimized for GO based projects	42
java	Optimized for JAVA based projects	42
javascript	Optimized for JAVASCRIPT or TYPESCRIPT based projects	49
php	Optimized for PHP based projects	44
python	Optimized for PYTHON based projects	49
ruby	Optimized for RUBY based projects	41
rust	Optimized for RUST based projects	41
salesforce	Optimized for Salesforce based projects	43
scala	Optimized for SCALA based projects	41
swift	Optimized for SWIFT based projects	41
terraform	Optimized for TERRAFORM based projects	45

Behind the scenes

How are identified applicable files

Activated only if one of these files is found: .editorconfig
File extensions: *

How the linting is performed

editorconfig-checker is called once with the list of files as arguments

Example calls

editorconfig-checker myfile.js

Help content

USAGE:

  -config string
      config
  -debug
      print debugging information
  -disable-end-of-line
      disables the trailing whitespace check
  -disable-indent-size
      disables only the indent-size check
  -disable-indentation
      disables the indentation check
  -disable-insert-final-newline
      disables the final newline check
  -disable-max-line-length
      disables only the max-line-length check
  -disable-trim-trailing-whitespace
      disables the trailing whitespace check
  -dry-run
      show which files would be checked
  -exclude string
      a regex which files should be excluded from checking - needs to be a valid regular expression
  -h  print the help
  -help
      print the help
  -ignore-defaults
      ignore default excludes
  -init
      creates an initial configuration
  -no-color
      dont print colors
  -v  print debugging information
  -verbose
      print debugging information
  -version
      print the version number

Installation on mega-linter Docker image

NPM packages (node.js):
- editorconfig-checker

Example success log

Results of editorconfig-checker linter (version 0.0.0)
See documentation on https://megalinter.github.io/descriptors/editorconfig_editorconfig_checker/
-----------------------------------------------

[SUCCESS] .automation/test/editorconfig-checker/editorconfig-checker_good_1.ext

Example error log

Results of editorconfig-checker linter (version 0.0.0)
See documentation on https://megalinter.github.io/descriptors/editorconfig_editorconfig_checker/
-----------------------------------------------

[ERROR] .automation/test/editorconfig-checker/editorconfig-checker_bad_1.ext
    .automation/test/editorconfig-checker/editorconfig-checker_bad_1.ext:
        1: Wrong amount of left-padding spaces(want multiple of 4)
        2: Wrong amount of left-padding spaces(want multiple of 4)
        3: Wrong amount of left-padding spaces(want multiple of 4)

    3 errors found