frozzare/wp-cli-lint

WP-CLI command for linting your code

Installs: 12

Dependents: 0

Suggesters: 0

Security: 0

Stars: 20

Watchers: 3

Forks: 2

Open Issues: 0

Type:wp-cli-package

dev-master 2019-12-02 14:22 UTC

This package is auto-updated.

Last update: 2022-07-29 01:22:59 UTC


README

Build Status No Maintenance Intended

Lint your WordPress code using WP CLI.

Installation

If you're using WP-CLI v0.23.0 or later, you can install this package with:

wp package install frozzare/wp-cli-lint

Alternatively, you can require this file in your global config file or add it to your project.

Example of ~/.wp-cli/config.yml:

require:
  - /path/to/wp-cli-lint/src/class-lint-command.php

For other methods, please refer to WP-CLI's Community Packages wiki.

Usage

Running the command without any options will lint your code in the current directory with WordPress-Core standard. The lint command will try to find a ruleset in the same directory you are linting or in the ABSPATH or in Bedrocks base directory.

Example:

wp lint
wp lint path/to/code

Config

You can add the path to the phpcs bin to use in WP CLI's config file and/or the standard that should be used.

Example of ~/.wp-cli/config.yml:

lint:
  phpcs: /path/to/phpcs
  standard: WordPress-Extra

Options

[<directory>]

The directory to lint code in. Default: 'Current directory'

[--standard=<standard>]

The standard to use when running phpcs. Default: 'WordPress-Core'

Examples

wp lint
wp lint path/to/code --standard=WordPress-Extra