Skip to content

Latest commit

 

History

History
187 lines (116 loc) · 8.19 KB

README.md

File metadata and controls

187 lines (116 loc) · 8.19 KB
Raw

Editorconfig Checker for CLI

Code Checks

EditorConfigCLI (binary called ec) is a free command-line-interface tool (written in PHP) to validate and auto-fix text files based on given .editorconfig declarations.

This allows you to automatically ensure .editorconfig declarations during your CI and development processes.

armin/editorconfig-cli is released under MIT license.

Written by Armin Vieweg <https://v.ieweg.de>

Requirements

  • PHP 8.2 or 8.3
  • Enabled PHP extensions: iconv, json

If you are looking for older PHP version support, you can check out and use those tags:

Installation

To install the EditorConfigCLI tool you need to download a handy PHAR executable, or use Composer like this:

$ composer req --dev armin/editorconfig-cli

Tip: You can also install packages globally with Composer (using the composer global command).

To download the PHAR executables, check out the releases section here.

What is EditorConfig?

EditorConfig logo

EditorConfig helps maintain consistent coding styles for multiple developers working on the same project across various editors and IDEs.

Which coding styles should get applied, are configured in the .editorconfig file.

You'll find more info about syntax and features of EditorConfig on https://editorconfig.org

Screenshots

This screenshot shows the help page you get when calling ec --help:

Screenshot of Help page

Here you see two example runs:

Demo run animation

Features

  • Parsing .editorconfig file
  • Validating files against corresponding .editorconfig declarations
  • Several modes to iterate through your project files
  • Tool to fix issues automatically
  • The following EditorConfig declarations (also called "rules") are being processed:
    • EndOfLine
    • InsertFinalNewLine
    • TrimTrailingWhitespace
    • Indention
      • Style (tab/spaces)
      • Size (width)
    • Charset (check only)
    • MaxLineLength (check only)
  • Optional strict mode (--strict) to force defined indent size of spaces (may conflict with other code linters)
  • Allow skipping certain rules (e.g. --skip charset,eol)
  • List files, currently uncovered by given .editorconfig declarations (--uncovered)

Usage

Composer style:

$ vendor/bin/ec [options] [--] [<names>...]

PHAR style:

$ php ec-2.0.0.phar [options] [--] [<names>...]

Scanning

When you do not enter any options, the scan starts immediately when calling ec PHP binary.

EditorConfigCLI supports three different modes to find files to check for:

  1. By CLI arguments and options, which configures and utilizes a symfony/finder instance (used by default).

    Note: No dotted files and directories are getting scanned (e.g. .ddev/ or .htaccess). Also, files covered by root .gitignore file, will be automatically excluded from scan.

  2. Using local Git binary, to get all files known Git. CLI args and options are ignored, then. (--git-only)

  3. Using a custom finder instance, which you can provide via a separate PHP file (--finder-config).

Fixing

To apply automatic fixes after scan append the --fix (or -f) option.

Currently, two rules do not support auto-fixing:

  • Charset
  • MaxLineLength

You get a notice for this in result output, when such issues occur.

CLI

Argument

Name(s) of file names to get checked. Wildcards allowed. Default: ['*']

With this you can only scan certain file types, e.g.

$ vendor/bin/ec *.css *.js *.html

Options

The ec binary supports the following options:

Option Shortcut Description
--dir -d Define the directory to scan. By default, the current working directory is used.
--exclude -e Directories to exclude from scan. Multiple values are allowed.
--disable-auto-exclude -a Disables exclusion of files ignored by root .gitignore file (when given).
--git-only -g Ignores all excludes and scans for all files known to Git. Requires git binary to be present.
--git-only-cmd Allows you to modify the git command (incl. binary) to get file list. Default: git ls-files
--finder-config Allows to define a PHP file providing a custom Finder instance. Read more
--skip -s Disables rules by name. Multiple and comma-separated values are allowed. See rules list below.
--strict When set, given indention size is forced during scan and fixing. This might conflict with more detailed indention rules, checked by other linters and style-fixers in your project.
--compact -c Only shows only files with issues, not the issues itself.
--uncovered -u Lists all files which are not covered by .editorconfig.
--verbose -v Shows additional informations, like detailed info about internal time tracking and which binary files have been skipped.
--no-interaction -n Do not ask for confirmation, if more than 500 files found and continue scanning. Always returns error code 3, when not confirming.
--no-error-on-exit By default ec returns code 2 when issues or code 1 when warnings occurred. With this option set return code is always 0.

Tip: The "usage" section on ec's help page shows some examples.

Rules list

The following rules are being executed by default and could get disabled using the --skip (-s) option:

  • charset
  • end_of_line
  • indent_size
  • indent_style
  • tab_width
  • insert_final_newline
  • max_line_length
  • trim_trailing_whitespace

Support and Contribution

Do you have questions, issues or feature requests? Checkout the issue tracker on Github.

If you like this project, you are invited to donate some help to support further development. Thank you!

In case you want to contribute code, checkout the Contribution guide for developers.

Changelog

See here