Skip to content

editorconfig-checker

GitHub stars GitHub release (latest SemVer) GitHub last commit GitHub commit activity GitHub contributors

editorconfig-checker documentation

editorconfig-checker - GitHub

Configuration in MegaLinter

Variable Description Default value
EDITORCONFIG_EDITORCONFIG_CHECKER_ARGUMENTS User custom arguments to add in linter CLI call
Ex: -s --foo "bar"
EDITORCONFIG_EDITORCONFIG_CHECKER_COMMAND_REMOVE_ARGUMENTS User custom arguments to remove from command line before calling the linter
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
list_of_files
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_UNSECURED_ENV_VARIABLES List of env variables explicitly not filtered before calling EDITORCONFIG_EDITORCONFIG_CHECKER and its pre/post commands None
EDITORCONFIG_EDITORCONFIG_CHECKER_CONFIG_FILE editorconfig-checker configuration file nameUse LINTER_DEFAULT to let the linter find it .ecrc
EDITORCONFIG_EDITORCONFIG_CHECKER_RULES_PATH Path where to find linter configuration file Workspace folder, then MegaLinter 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
EDITORCONFIG_EDITORCONFIG_CHECKER_CLI_EXECUTABLE Override CLI executable ['editorconfig-checker']

MegaLinter Flavours

This linter is available in the following flavours

Flavor Description Embedded linters Info
all Default MegaLinter Flavor 123 Docker Image Size (tag) Docker Pulls
c_cpp Optimized for pure C/C++ projects 54 Docker Image Size (tag) Docker Pulls
cupcake MegaLinter for the most commonly used languages 82 Docker Image Size (tag) Docker Pulls
documentation MegaLinter for documentation projects 50 Docker Image Size (tag) Docker Pulls
dotnet Optimized for C, C++, C# or VB based projects 62 Docker Image Size (tag) Docker Pulls
dotnetweb Optimized for C, C++, C# or VB based projects with JS/TS 71 Docker Image Size (tag) Docker Pulls
go Optimized for GO based projects 52 Docker Image Size (tag) Docker Pulls
java Optimized for JAVA based projects 53 Docker Image Size (tag) Docker Pulls
javascript Optimized for JAVASCRIPT or TYPESCRIPT based projects 60 Docker Image Size (tag) Docker Pulls
php Optimized for PHP based projects 54 Docker Image Size (tag) Docker Pulls
python Optimized for PYTHON based projects 63 Docker Image Size (tag) Docker Pulls
ruby Optimized for RUBY based projects 51 Docker Image Size (tag) Docker Pulls
rust Optimized for RUST based projects 51 Docker Image Size (tag) Docker Pulls
salesforce Optimized for Salesforce based projects 55 Docker Image Size (tag) Docker Pulls
swift Optimized for SWIFT based projects 51 Docker Image Size (tag) Docker Pulls
terraform Optimized for TERRAFORM based projects 55 Docker Image Size (tag) Docker Pulls

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 (list_of_files CLI lint mode)

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
  -f string
      specify the output format: default, gcc (default "default")
  -format string
      specify the output format: default, gcc (default "default")
  -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

  • Dockerfile commands :
ARG VERSION_EDITORCONFIG_CHECKER=latest
FROM mstruebing/editorconfig-checker:$VERSION_EDITORCONFIG_CHECKER as editorconfig-checker
COPY --link --from=editorconfig-checker /usr/bin/ec /usr/bin/editorconfig-checker