Toolkit

LintCommands extends AbstractCommands
in package

Commands to lint the source code and interact with ESLint.

Table of Contents

Methods

getConfigurationFile()  : mixed
Path to YAML configuration file containing command defaults.
getJson()  : array<string|int, mixed>
Returns the JSON parsed content.
getWorkingDir()  : string
Returns the current working directory.
isWebsiteInstalled()  : bool
Check if the website is installed.
toolkitLintBehat()  : mixed
Run lint Behat.
toolkitLintCsPell()  : mixed
Run lint CSpell.
toolkitLintCss()  : mixed
Run lint CSS.
toolkitLintJs()  : mixed
Run lint JS.
toolkitLintPhp()  : mixed
Run lint PHP.
toolkitLintYaml()  : mixed
Run lint YAML.
toolkitSetupEslint()  : mixed
Setup the ESLint configurations and dependencies.
getBin()  : string
Validate and return the path to given bin.
getBinPath()  : string
Return the path to given bin.
getConfigValue()  : mixed
{@inheritdoc}
getNodeBin()  : string
Validate and return the path to given bin from node packages.
getNodeBinPath()  : string
Return the path to given bin from node packages.
isJunit()  : bool
Check whether Junit option is being used, or env var is set.
isSimulating()  : bool
Check if current command is being executed with option simulate.
taskExecute()  : mixed
Execute a command.
taskProcess()  : mixed
Process the file.
taskReplaceBlock()  : mixed
Replace block in a file.
generateEslintConfigurations()  : mixed
Generate configurations for ESLint.
toolkitRunEsLint()  : mixed
Execute the eslint.

Methods

getConfigurationFile()

Path to YAML configuration file containing command defaults.

public getConfigurationFile() : mixed

getJson()

Returns the JSON parsed content.

public getJson(string $filename[, mixed $throwException = true ]) : array<string|int, mixed>
Parameters
$filename : string
$throwException : mixed = true
Return values
array<string|int, mixed>

getWorkingDir()

Returns the current working directory.

public getWorkingDir() : string
Return values
string —

The current working directory.

isWebsiteInstalled()

Check if the website is installed.

public isWebsiteInstalled() : bool
Return values
bool

toolkitLintBehat()

Run lint Behat.

public toolkitLintBehat([array<string|int, mixed> $options = ['config' => InputOption::VALUE_REQUIRED, 'files' => InputOption::VALUE_REQUIRED] ]) : mixed
Parameters
$options : array<string|int, mixed> = ['config' => InputOption::VALUE_REQUIRED, 'files' => InputOption::VALUE_REQUIRED]
Tags
command

toolkit:lint-behat

option

config The path to the config file.

option

files The files to check.

option

junit Whether to export results as junit.

aliases

tk-lbehat

usage

--files='tests/features' --config='gherkinlint.json'

SuppressWarnings

(PHPMD.CyclomaticComplexity)

toolkitLintCsPell()

Run lint CSpell.

public toolkitLintCsPell([array<string|int, mixed> $options = ['config' => InputOption::VALUE_REQUIRED, 'files' => InputOption::VALUE_REQUIRED, 'options' => InputOption::VALUE_OPTIONAL] ]) : mixed
Parameters
$options : array<string|int, mixed> = ['config' => InputOption::VALUE_REQUIRED, 'files' => InputOption::VALUE_REQUIRED, 'options' => InputOption::VALUE_OPTIONAL]
Tags
command

toolkit:lint-cspell

option

config The path to the config file.

option

files The files to check.

option

options Extra options for the command.

option

junit Whether to export results as junit.

aliases

tk-cspell

usage

--files='lib' --config='web/core/.cspell.json' --options='--gitignore'

toolkitLintCss()

Run lint CSS.

public toolkitLintCss([array<string|int, mixed> $options = ['config' => InputOption::VALUE_REQUIRED, 'files' => InputOption::VALUE_REQUIRED] ]) : mixed
Parameters
$options : array<string|int, mixed> = ['config' => InputOption::VALUE_REQUIRED, 'files' => InputOption::VALUE_REQUIRED]
Tags
command

toolkit:lint-css

option

exclude The stylelint config file.

option

files The files to check.

option

junit Whether to export results as junit.

aliases

tk-css

toolkitLintJs()

Run lint JS.

public toolkitLintJs([array<string|int, mixed> $options = ['config' => InputOption::VALUE_REQUIRED, 'extensions' => InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY, 'options' => InputOption::VALUE_OPTIONAL] ]) : mixed
Parameters
$options : array<string|int, mixed> = ['config' => InputOption::VALUE_REQUIRED, 'extensions' => InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY, 'options' => InputOption::VALUE_OPTIONAL]
Tags
command

toolkit:lint-js

option

config The eslint config file.

option

extensions The extensions to check.

option

options Extra options for the command without -- (only options with no value).

option

junit Whether to export results as junit.

aliases

tk-js, tljs

usage

--extensions='.js' --options='fix no-eslintrc'

toolkitLintPhp()

Run lint PHP.

public toolkitLintPhp([array<string|int, mixed> $options = ['extensions' => InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY, 'exclude' => InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY, 'options' => InputOption::VALUE_OPTIONAL] ]) : mixed
Parameters
$options : array<string|int, mixed> = ['extensions' => InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY, 'exclude' => InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY, 'options' => InputOption::VALUE_OPTIONAL]
Tags
command

toolkit:lint-php

option

exclude The eslint config file.

option

extensions The extensions to check.

option

options Extra options for the command without -- (only options with no value).

option

junit Whether to export results as junit.

aliases

tk-php, tlp

SuppressWarnings

(PHPMD.CyclomaticComplexity)

toolkitLintYaml()

Run lint YAML.

public toolkitLintYaml([array<string|int, mixed> $options = ['config' => InputOption::VALUE_REQUIRED, 'extensions' => InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY, 'options' => InputOption::VALUE_OPTIONAL] ]) : mixed
Parameters
$options : array<string|int, mixed> = ['config' => InputOption::VALUE_REQUIRED, 'extensions' => InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY, 'options' => InputOption::VALUE_OPTIONAL]
Tags
command

toolkit:lint-yaml

option

config The eslint config file.

option

extensions The extensions to check.

option

options Extra options for the command without -- (only options with no value).

option

junit Whether to export results as junit.

aliases

tk-yaml, tly

usage

--extensions='.yml' --options='fix no-eslintrc'

toolkitSetupEslint()

Setup the ESLint configurations and dependencies.

public toolkitSetupEslint([array<string|int, mixed> $options = ['config' => InputOption::VALUE_REQUIRED, 'ignores' => InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY, 'drupal-root' => InputOption::VALUE_REQUIRED, 'packages' => InputOption::VALUE_REQUIRED, 'force' => false] ]) : mixed
Parameters
$options : array<string|int, mixed> = ['config' => InputOption::VALUE_REQUIRED, 'ignores' => InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY, 'drupal-root' => InputOption::VALUE_REQUIRED, 'packages' => InputOption::VALUE_REQUIRED, 'force' => false]
Tags
command

toolkit:setup-eslint

option

config The eslint config file.

option

ignores The patterns to ignore.

option

drupal-root The drupal root.

option

packages The npm packages to install.

option

force If true, the config file will be deleted.

getBin()

Validate and return the path to given bin.

protected getBin(string $name) : string
Parameters
$name : string

The bin to look for.

Tags
throws
TaskException
Return values
string —

The bin path.

getBinPath()

Return the path to given bin.

protected getBinPath(string $name) : string
Parameters
$name : string
Return values
string —

The path to given binary.

getConfigValue()

{@inheritdoc}

protected getConfigValue(mixed $key[, mixed $default = null ]) : mixed
Parameters
$key : mixed
$default : mixed = null

getNodeBin()

Validate and return the path to given bin from node packages.

protected getNodeBin(string $name) : string
Parameters
$name : string

The bin to look for.

Tags
throws
TaskException
Return values
string —

The bin path.

getNodeBinPath()

Return the path to given bin from node packages.

protected getNodeBinPath(string $name) : string
Parameters
$name : string
Return values
string —

The path to given binary.

isJunit()

Check whether Junit option is being used, or env var is set.

protected isJunit() : bool
Return values
bool

isSimulating()

Check if current command is being executed with option simulate.

protected isSimulating() : bool
Return values
bool —

True if using --simulate, false otherwise.

taskExecute()

Execute a command.

protected taskExecute(array<string|int, mixed> $tasks) : mixed
Parameters
$tasks : array<string|int, mixed>

An array with tasks to execute.

taskProcess()

Process the file.

protected taskProcess(string $source[, string $destination = '' ]) : mixed
Parameters
$source : string

The source file to process.

$destination : string = ''

The destination file.

taskReplaceBlock()

Replace block in a file.

protected taskReplaceBlock([string $filename = '' ]) : mixed
Parameters
$filename : string = ''

The file to process.

generateEslintConfigurations()

Generate configurations for ESLint.

private generateEslintConfigurations(string $config, array<string|int, mixed> $options) : mixed
Parameters
$config : string

The path for the configuration file.

$options : array<string|int, mixed>

The options passed to the command.

toolkitRunEsLint()

Execute the eslint.

private toolkitRunEsLint(string $config, array<string|int, mixed> $extensions, string $options) : mixed
Parameters
$config : string

The eslint config file.

$extensions : array<string|int, mixed>

The extensions to check.

$options : string

Extra options for the command.

Tags
see
toolkitLintYaml()
see
toolkitLintJs() 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results