-
-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #33 from PHPCSStandards/develop
Release version 1.0.0
- Loading branch information
Showing
19 changed files
with
1,436 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,6 @@ | ||
| vendor/ | ||
| composer.lock | ||
| .phpcs.xml | ||
| phpcs.xml | ||
| phpunit.xml | ||
| .phpunit.result.cache |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| # Change Log for the PHPCSDevTools standard for PHP Codesniffer | ||
|
|
||
| All notable changes to this project will be documented in this file. | ||
|
|
||
| This projects adheres to [Keep a CHANGELOG](http://keepachangelog.com/) and uses [Semantic Versioning](http://semver.org/). | ||
|
|
||
|
|
||
| ## [Unreleased] | ||
|
|
||
| _Nothing yet._ | ||
|
|
||
|
|
||
| ## 1.0.0 - 2020-02-12 | ||
|
|
||
| Initial release containing: | ||
| * Feature completeness checking tool for PHPCS sniffs. | ||
| * A `PHPCSDebug` standard to help debugging sniffs. | ||
|
|
||
|
|
||
| [Unreleased]: https://github.com/PHPCSStandards/PHPCSDevTools/compare/1.0.0...HEAD | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| <documentation title="Token List"> | ||
| <standard> | ||
| <![CDATA[ | ||
| Lists how PHPCS tokenizes code. | ||
| This sniff will not throw any warnings or errors, but is solely intended as a tool for sniff developers. | ||
| ]]> | ||
| </standard> | ||
| </documentation> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,131 @@ | ||
| <?php | ||
| /** | ||
| * PHPCSDevTools, tools for PHP_CodeSniffer sniff developers. | ||
| * | ||
| * @package PHPCSDevTools | ||
| * @copyright 2019 PHPCSDevTools Contributors | ||
| * @license https://opensource.org/licenses/LGPL-3.0 LGPL3 | ||
| * @link https://github.com/PHPCSStandards/PHPCSDevTools | ||
| */ | ||
|
|
||
| namespace PHPCSDebug\Sniffs\Debug; | ||
|
|
||
| use PHP_CodeSniffer\Sniffs\Sniff; | ||
| use PHP_CodeSniffer\Files\File; | ||
|
|
||
| /** | ||
| * Lists how PHPCS tokenizes code. | ||
| * | ||
| * This sniff will not throw any warnings or errors, but is solely intended | ||
| * as a tool for sniff developers. | ||
| * | ||
| * @since 1.0.0 | ||
| */ | ||
| class TokenListSniff implements Sniff | ||
| { | ||
|
|
||
| /** | ||
| * A list of tokenizers this sniff supports. | ||
| * | ||
| * @var array | ||
| */ | ||
| public $supportedTokenizers = [ | ||
| 'PHP', | ||
| 'JS', | ||
| 'CSS', | ||
| ]; | ||
|
|
||
| /** | ||
| * Default values for the token indexes accessed. | ||
| * | ||
| * This prevents issues with "undefined index" notices in case of rare tokenizer issues. | ||
| * | ||
| * @var array | ||
| */ | ||
| private $tokenDefaults = [ | ||
| 'type' => '?', | ||
| 'code' => '?', | ||
| 'content' => '', | ||
| 'line' => '?', | ||
| 'column' => '?', | ||
| 'level' => 0, | ||
| 'conditions' => [], | ||
| ]; | ||
|
|
||
| /** | ||
| * Returns an array of tokens this test wants to listen for. | ||
| * | ||
| * @return array | ||
| */ | ||
| public function register() | ||
| { | ||
| return [ | ||
| \T_OPEN_TAG, | ||
| \T_OPEN_TAG_WITH_ECHO, | ||
| ]; | ||
| } | ||
|
|
||
| /** | ||
| * Processes this test, when one of its tokens is encountered. | ||
| * | ||
| * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned. | ||
| * @param int $stackPtr The position of the current | ||
| * token in the stack. | ||
| * | ||
| * @return void | ||
| */ | ||
| public function process(File $phpcsFile, $stackPtr) | ||
| { | ||
| $tokens = $phpcsFile->getTokens(); | ||
| $last = ($phpcsFile->numTokens - 1); | ||
|
|
||
| $ptrPadding = \max(3, \strlen($last)); | ||
| $linePadding = \strlen($tokens[$last]['line']); | ||
|
|
||
| echo \PHP_EOL; | ||
| echo \str_pad('Ptr', $ptrPadding, ' ', \STR_PAD_BOTH), | ||
| ' :: ', \str_pad('Ln', ($linePadding + 1), ' ', \STR_PAD_BOTH), | ||
| ' :: ', \str_pad('Col', 4, ' ', \STR_PAD_BOTH), | ||
| ' :: ', 'Cond', | ||
| ' :: ', \str_pad('Token Type', 26), // Longest token type name is 26 chars. | ||
| ' :: [len]: Content', \PHP_EOL; | ||
|
|
||
| echo \str_repeat('-', ($ptrPadding + $linePadding + 35 + 16 + 18)), \PHP_EOL; | ||
|
|
||
| foreach ($tokens as $ptr => $token) { | ||
| $token += $this->tokenDefaults; | ||
| $content = $token['content']; | ||
|
|
||
| if (isset($token['length']) === false) { | ||
| $token['length'] = 0; | ||
| if (isset($token['content'])) { | ||
| $token['length'] = \strlen($content); | ||
| } | ||
| } | ||
|
|
||
| if ($token['code'] === \T_WHITESPACE | ||
| || (\defined('T_DOC_COMMENT_WHITESPACE') | ||
| && $token['code'] === \T_DOC_COMMENT_WHITESPACE) | ||
| ) { | ||
| if (\strpos($content, "\t") !== false) { | ||
| $content = \str_replace("\t", '\t', $content); | ||
| } | ||
| if (isset($token['orig_content'])) { | ||
| $content .= ' :: Orig: ' . \str_replace("\t", '\t', $token['orig_content']); | ||
| } | ||
| } | ||
|
|
||
| $conditionCount = \count($token['conditions']); | ||
|
|
||
| echo \str_pad($ptr, $ptrPadding, ' ', \STR_PAD_LEFT), | ||
| ' :: L', \str_pad($token['line'], $linePadding, '0', \STR_PAD_LEFT), | ||
| ' :: C', \str_pad($token['column'], 3, ' ', \STR_PAD_LEFT), | ||
| ' :: CC', \str_pad($conditionCount, 2, ' ', \STR_PAD_LEFT), | ||
| ' :: ', \str_pad($token['type'], 26), // Longest token type name is 26 chars. | ||
| ' :: [', $token['length'], ']: ', $content, \PHP_EOL; | ||
| } | ||
|
|
||
| // Only do this once per file. | ||
| return ($phpcsFile->numTokens + 1); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| <?php | ||
|
|
||
| function |
Oops, something went wrong.