editorconfig-checker / editorconfig-checker
A tool to verify that your files follow the rules of your .editorconfig
Installs: 214 909
Dependents: 24
Suggesters: 1
Security: 0
Stars: 51
Watchers: 4
Forks: 13
Open Issues: 2
Requires
- php: ^7.2 || ^8.0
Requires (Dev)
- php-coveralls/php-coveralls: ^2.1
- phpstan/phpstan: ^1.4
- phpunit/phpunit: ^8.5.23
- squizlabs/php_codesniffer: ^3.6
- dev-master
- 10.4.0
- 10.3.0
- 10.2.4
- 10.2.3
- 10.2.2
- 10.2.1
- 10.2.0
- 10.1.0
- 10.0.4
- 10.0.3
- 10.0.2
- 10.0.1
- 10.0.0
- 9.2.0
- 9.1.1
- 9.1.0
- 9.0.1
- 9.0.0
- 8.0.0
- 7.x-dev
- v7.1.0
- 7.0.6
- 7.0.5
- 7.0.4
- 7.0.3
- 7.0.2
- 7.0.1
- 7.0.0
- 6.0.0
- 5.1.1
- 5.0.1
- 5.0.0
- 4.1.0
- 4.0.2
- 4.0.1
- 4.0.0
- 3.0.2
- 3.0.1
- 3.0.0
- 2.3.7
- 2.2.6
- 2.2.5
- 2.2.4
- 1.2.3
- 1.1.3
- 1.1.2
- 1.1.0
- 1.0.0
- dev-dependabot/composer/phpstan/phpstan-1.10.16
- dev-dependabot-weekly
- dev-lowest-deps--fix
- dev-ci-php-82
This package is auto-updated.
Last update: 2023-06-06 07:10:10 UTC
README
This is a command-line tool to check if given files implement your .editorconfig rules.
What?
This is a tool to check if your files consider your .editorconfig. Most tools - like linters for example - only test one filetype and need an extra configuration. This tool only needs your editorconfig to check all files.
Important
This is only a wrapper for the core editorconfig-checker. You should have a look at this repository to know how this tool can be used and what possibilities/caveats are there. This version can be used in the same way as the core as every argument is simply passed down to it.
Installation
Installation via composer is recommended:
composer require --dev editorconfig-checker/editorconfig-checker
./vendor/bin/ec
# or in a composer-script just
ec
Otherwise you could clone the repository and execute the script manually.
git clone git@github.com:editorconfig-checker/editorconfig-checker.php.git
./editorconfig-checker.php/bin/ec
Usage
There is an alias from editorconfig-checker
to ec
so you can exchange every occurrence of editorconfig-checker
with ec
.
If you installed it via composer you have a binary in your composer-bin-dir folder called editorconfig-checker
.
Then you could create a script in your composer.json
like this:
"scripts": { "lint:editorconfig": "editorconfig-checker" }
Usage output:
USAGE:
-config string
config
-debug
print debugging information
-disable-end-of-line
disables the trailing whitespace check
-disable-indentation
disables the indentation check
-disable-insert-final-newline
disables the final newline 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
Support
If you have any questions or just want to chat join #editorconfig-checker on freenode(IRC). If you don't have an IRC-client set up you can use the freenode webchat.