Chris@0
|
1 <?php
|
Chris@0
|
2
|
Chris@0
|
3 /**
|
Chris@17
|
4 * \DrupalPractice\Sniffs\InfoFiles\NamespacedDependencySniff.
|
Chris@0
|
5 *
|
Chris@0
|
6 * @category PHP
|
Chris@0
|
7 * @package PHP_CodeSniffer
|
Chris@0
|
8 * @link http://pear.php.net/package/PHP_CodeSniffer
|
Chris@0
|
9 */
|
Chris@0
|
10
|
Chris@17
|
11 namespace DrupalPractice\Sniffs\InfoFiles;
|
Chris@17
|
12
|
Chris@17
|
13 use PHP_CodeSniffer\Files\File;
|
Chris@17
|
14 use PHP_CodeSniffer\Sniffs\Sniff;
|
Chris@17
|
15
|
Chris@0
|
16 /**
|
Chris@0
|
17 * Checks that all declared dependencies are namespaced.
|
Chris@0
|
18 *
|
Chris@0
|
19 * @category PHP
|
Chris@0
|
20 * @package PHP_CodeSniffer
|
Chris@0
|
21 * @link http://pear.php.net/package/PHP_CodeSniffer
|
Chris@0
|
22 */
|
Chris@17
|
23 class NamespacedDependencySniff implements Sniff
|
Chris@0
|
24 {
|
Chris@0
|
25
|
Chris@0
|
26
|
Chris@0
|
27 /**
|
Chris@0
|
28 * Returns an array of tokens this test wants to listen for.
|
Chris@0
|
29 *
|
Chris@0
|
30 * @return array
|
Chris@0
|
31 */
|
Chris@0
|
32 public function register()
|
Chris@0
|
33 {
|
Chris@0
|
34 return array(T_INLINE_HTML);
|
Chris@0
|
35
|
Chris@0
|
36 }//end register()
|
Chris@0
|
37
|
Chris@0
|
38
|
Chris@0
|
39 /**
|
Chris@0
|
40 * Processes this test, when one of its tokens is encountered.
|
Chris@0
|
41 *
|
Chris@17
|
42 * @param \PHP_CodeSniffer\Files\File $phpcsFile The current file being processed.
|
Chris@17
|
43 * @param int $stackPtr The position of the current token
|
Chris@17
|
44 * in the stack passed in $tokens.
|
Chris@0
|
45 *
|
Chris@0
|
46 * @return int
|
Chris@0
|
47 */
|
Chris@17
|
48 public function process(File $phpcsFile, $stackPtr)
|
Chris@0
|
49 {
|
Chris@0
|
50 $tokens = $phpcsFile->getTokens();
|
Chris@0
|
51
|
Chris@0
|
52 $fileExtension = strtolower(substr($phpcsFile->getFilename(), -9));
|
Chris@0
|
53 if ($fileExtension !== '.info.yml') {
|
Chris@0
|
54 return ($phpcsFile->numTokens + 1);
|
Chris@0
|
55 }
|
Chris@0
|
56
|
Chris@0
|
57 if (preg_match('/^dependencies:/', $tokens[$stackPtr]['content']) === 0) {
|
Chris@0
|
58 return;
|
Chris@0
|
59 }
|
Chris@0
|
60
|
Chris@0
|
61 $nextLine = ($stackPtr + 1);
|
Chris@0
|
62
|
Chris@0
|
63 while (isset($tokens[$nextLine]) === true) {
|
Chris@0
|
64 // Dependency line without namespace.
|
Chris@0
|
65 if (preg_match('/^[\s]+- [^:]+[\s]*$/', $tokens[$nextLine]['content']) === 1) {
|
Chris@0
|
66 $error = 'All dependencies must be prefixed with the project name, for example "drupal:"';
|
Chris@0
|
67 $phpcsFile->addWarning($error, $nextLine, 'NonNamespaced');
|
Chris@0
|
68 } else if (preg_match('/^[\s]+- [^:]+:[^:]+[\s]*$/', $tokens[$nextLine]['content']) === 0
|
Chris@0
|
69 && preg_match('/^[\s]*#.*$/', $tokens[$nextLine]['content']) === 0
|
Chris@0
|
70 ) {
|
Chris@0
|
71 // Not a dependency line with namespace or comment - stop.
|
Chris@0
|
72 return $nextLine;
|
Chris@0
|
73 }
|
Chris@0
|
74
|
Chris@0
|
75 $nextLine++;
|
Chris@0
|
76 }
|
Chris@0
|
77
|
Chris@0
|
78 }//end process()
|
Chris@0
|
79
|
Chris@0
|
80
|
Chris@0
|
81 }//end class
|