editorconfig-checker

editorconfig-checker is a language-agnostic tool that validates files against EditorConfig definitions to ensure consistent formatting across your entire codebase. Unlike language-specific linters, it works for every file type and programming language.

Key Features:

• Universal Validation: Works with any file type including code, configuration files, plain text, XML, and more
• EditorConfig Compliance: Enforces indentation, line endings, character encoding, and whitespace rules from .editorconfig
• Multi-Platform Support: Available as native binaries, npm package, PHP composer package, Python pip package, and Docker image
• Configurable Rules: Fine-tune validation with .ecrc configuration files and command-line flags
• Comprehensive Checks: Validates indent style, insert final newline, trim trailing whitespace, and end-of-line characters
• Flexible Exclusions: Exclude specific files, directories, or content types from validation

editorconfig-checker documentation

• Version in MegaLinter: 3.7.0
• Visit Official Web Site
• See How to configure editorconfig-checker rules
• See How to disable editorconfig-checker rules in files

Configuration in MegaLinter

• 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_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 name Use LINTER_DEFAULT to let the linter find it	.editorconfig-checker.json
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 Flavors

This linter is available in the following flavors

	Flavor	Description	Embedded linters	Info
	all	Default MegaLinter Flavor	136
	c_cpp	Optimized for pure C/C++ projects	59
	cupcake	MegaLinter for the most commonly used languages	92
	documentation	MegaLinter for documentation projects	52
	dotnet	Optimized for C, C++, C# or VB based projects	67
	dotnetweb	Optimized for C, C++, C# or VB based projects with JS/TS	76
	go	Optimized for GO based projects	54
	java	Optimized for JAVA based projects	57
	javascript	Optimized for JAVASCRIPT or TYPESCRIPT based projects	62
	php	Optimized for PHP based projects	57
	python	Optimized for PYTHON based projects	69
	ruby	Optimized for RUBY based projects	53
	rust	Optimized for RUST based projects	53
	salesforce	Optimized for Salesforce based projects	59
	swift	Optimized for SWIFT based projects	53
	terraform	Optimized for TERRAFORM based projects	56

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:
  editorconfig-checker [OPTIONS] [FILE...]

With no FILE arguments, all files tracked by git are checked. When one or
more FILE arguments are given, only those files are checked (the configured
exclude patterns still apply).

OPTIONS:
  -color
      enables printing color
  -config string
      config
  -cpuprofile string
      write cpu profile to file
  -debug
      print debugging information
  -disable-charset
      disables only the charset check
  -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. Combine patterns with | (pipe): -exclude "vendor|testdata"
  -f value
      specify the output format: default, codeclimate, gcc, github-actions (default default)
  -format value
      specify the output format: default, codeclimate, gcc, github-actions (default default)
  -h  print the help
  -help
      print the help
  -ignore-defaults
      ignore default excludes
  -init
      creates an initial configuration
  -no-color
      disables printing color
  -v  print debugging information
  -verbose
      print debugging information
  -version
      print the version number

Installation on mega-linter Docker image

• Dockerfile commands :

# renovate: datasource=docker depName=mstruebing/editorconfig-checker
ARG EDITORCONFIG_EDITORCONFIG_CHECKER_VERSION=v3.7.0
FROM mstruebing/editorconfig-checker:${EDITORCONFIG_EDITORCONFIG_CHECKER_VERSION} AS editorconfig-checker
COPY --link --from=editorconfig-checker /usr/bin/ec /usr/bin/editorconfig-checker