1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465 |
- <?php
- /**
- * Copyright © Magento, Inc. All rights reserved.
- * See COPYING.txt for license details.
- */
- namespace Magento\Sniffs\Less;
- use PHP_CodeSniffer\Sniffs\Sniff;
- use PHP_CodeSniffer\Files\File;
- /**
- * Class ColourDefinitionSniff
- *
- * Ensure that hexadecimal values are used for variables not for properties
- *
- * @link https://devdocs.magento.com/guides/v2.0/coding-standards/code-standard-less.html#hexadecimal-notation
- */
- class ColourDefinitionSniff implements Sniff
- {
- /**
- * A list of tokenizers this sniff supports.
- *
- * @var array
- */
- public $supportedTokenizers = [TokenizerSymbolsInterface::TOKENIZER_CSS];
- /**
- * @inheritdoc
- */
- public function register()
- {
- return [T_COLOUR];
- }
- /**
- * @inheritdoc
- */
- public function process(File $phpcsFile, $stackPtr)
- {
- $tokens = $phpcsFile->getTokens();
- $colour = $tokens[$stackPtr]['content'];
- $variablePtr = $phpcsFile->findPrevious(T_ASPERAND, $stackPtr);
- if ((false === $variablePtr) || ($tokens[$stackPtr]['line'] !== $tokens[$variablePtr]['line'])) {
- $phpcsFile->addError('Hexadecimal value should be used for variable', $stackPtr, 'NotInVariable');
- }
- $expected = strtolower($colour);
- if ($colour !== $expected) {
- $error = 'CSS colours must be defined in lowercase; expected %s but found %s';
- $phpcsFile->addError($error, $stackPtr, 'NotLower', [$expected, $colour]);
- }
- // Now check if shorthand can be used.
- if (strlen($colour) !== 7) {
- return;
- }
- if ($colour[1] === $colour[2] && $colour[3] === $colour[4] && $colour[5] === $colour[6]) {
- $expected = '#' . $colour[1] . $colour[3] . $colour[5];
- $error = 'CSS colours must use shorthand if available; expected %s but found %s';
- $phpcsFile->addError($error, $stackPtr, 'Shorthand', [$expected, $colour]);
- }
- }
- }
|