CommentLevelsSniff Class Reference

Inheritance diagram for CommentLevelsSniff:

Public Member Functions
	register ()
	process (File $phpcsFile, $stackPtr)

Data Fields
const	COMMENT_STRING = '//'
const	FIRST_LEVEL_COMMENT = '_____________________________________________'
const	SECOND_LEVEL_COMMENT = '--'
	$supportedTokenizers = [TokenizerSymbolsInterface::TOKENIZER_CSS]

Protected Attributes
	$levelComments

Detailed Description

Class CommentLevelsSniff

First and second level comments must be surrounded by empty lines. First, second and third level comments should have two spaces after "//". Inline comments should have one space after "//".

http://devdocs.magento.com/guides/v2.0/coding-standards/code-standard-less.html#comments

Definition at line 21 of file CommentLevelsSniff.php.

Member Function Documentation

process()

process	(	File	$phpcsFile,
			$stackPtr
	)

{}

Definition at line 55 of file CommentLevelsSniff.php.

    {
        $tokens = $phpcsFile->getTokens();

        if ((T_STRING !== $tokens[$stackPtr]['code'])
            || (self::COMMENT_STRING !== $tokens[$stackPtr]['content'])
            || (1 === $tokens[$stackPtr]['line'])
        ) {
            return;
        }

        $textInSameLine = $phpcsFile->findPrevious([T_STRING, T_STYLE], $stackPtr - 1);

        // is inline comment
        if ((false !== $textInSameLine)
            && ($tokens[$textInSameLine]['line'] === $tokens[$stackPtr]['line'])
        ) {
            $this->validateInlineComment($phpcsFile, $stackPtr, $tokens);
            return;
        }

        // validation of levels comments
        if (!in_array($tokens[$stackPtr + 1]['content'], [
                TokenizerSymbolsInterface::DOUBLE_WHITESPACE,
                TokenizerSymbolsInterface::NEW_LINE,
            ])
        ) {
            $phpcsFile->addError('Level\'s comment does not have 2 spaces after "//"', $stackPtr, 'SpacesMissed');
        }

        if (!$this->isNthLevelComment($phpcsFile, $stackPtr, $tokens)) {
            return;
        }

        if (!$this->checkNthLevelComment($phpcsFile, $stackPtr, $tokens)) {
            $phpcsFile->addError(
                'First and second level comments must be surrounded by empty lines',
                $stackPtr,
                'SpaceMissed'
            );
        }
    }

register()

register

(

)

{}

Definition at line 47 of file CommentLevelsSniff.php.

    {
        return [T_STRING];
    }

Field Documentation

$levelComments

$levelComments

protected

Initial value:

= [
        self::FIRST_LEVEL_COMMENT   => T_STRING,
        self::SECOND_LEVEL_COMMENT  => T_DEC,
    ]

Definition at line 32 of file CommentLevelsSniff.php.

$supportedTokenizers

$supportedTokenizers = [TokenizerSymbolsInterface::TOKENIZER_CSS]

Definition at line 42 of file CommentLevelsSniff.php.

COMMENT_STRING

const COMMENT_STRING = '//'

Definition at line 23 of file CommentLevelsSniff.php.

FIRST_LEVEL_COMMENT

const FIRST_LEVEL_COMMENT = '_____________________________________________'

Definition at line 25 of file CommentLevelsSniff.php.

SECOND_LEVEL_COMMENT

const SECOND_LEVEL_COMMENT = '--'

Definition at line 27 of file CommentLevelsSniff.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/magento2-base/dev/tests/static/framework/Magento/Sniffs/Less/CommentLevelsSniff.php