CodeSniffer - Revision history

Devdocsbot: Protected "CodeSniffer": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

2022-05-06T07:26:56Z

Protected "CodeSniffer": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

← Older revision		Revision as of 07:26, 6 May 2022
(No difference)

Andrewnicols: Note migration to new docs

2022-04-19T14:12:43Z

Note migration to new docs

← Older revision		Revision as of 14:12, 19 April 2022
Line 1:		Line 1:
			{{Template:Migrated\|newDocId=/general/development/tools/phpcs}}
	{{Moodle 2.0}}		{{Moodle 2.0}}

Moodlebot: Text replacement - "`" to ""`


2021-08-11T14:54:45Z
Text replacement - "<code>" to "<syntaxhighlight lang="php">"

				
				
				
				
				
				← Older revision
				Revision as of 14:54, 11 August 2021
				
Line 53:
Line 53:



4.  If they are installed properly, moodle and PHPCompatibility will show up in the output of `phpcs -i`. Here is a typical example: 4.  If they are installed properly, moodle and PHPCompatibility will show up in the output of `phpcs -i`. Here is a typical example:
<code> <syntaxhighlight lang="php">
The installed coding standards are MySource, PHPCompatibility, Squiz, PSR2, moodle, PEAR, PSR1, PSR12 and Zend The installed coding standards are MySource, PHPCompatibility, Squiz, PSR2, moodle, PEAR, PSR1, PSR12 and Zend
</syntaxhighlight> </syntaxhighlight>



5. Optionally, you can set the default standard in a configuration file: 5. Optionally, you can set the default standard in a configuration file:
<code> <syntaxhighlight lang="php">
     phpcs --config-set default_standard moodle      phpcs --config-set default_standard moodle
</syntaxhighlight> </syntaxhighlight>
Line 65:
Line 65:



1. Run the following in your terminal from your moodle folder: 1. Run the following in your terminal from your moodle folder:
<code> <syntaxhighlight lang="php">
composer global require "squizlabs/php_codesniffer=3.*" composer global require "squizlabs/php_codesniffer=3.*"
</syntaxhighlight> </syntaxhighlight>
Line 75:
Line 75:



3. Tell phpcs about where to find the Moodle code checker 3. Tell phpcs about where to find the Moodle code checker
<code> <syntaxhighlight lang="php">
phpcs  --config-set  installed_paths /path/to/moodle-local_codechecker # adds moodle's standard to phpcs phpcs  --config-set  installed_paths /path/to/moodle-local_codechecker # adds moodle's standard to phpcs
</syntaxhighlight> </syntaxhighlight>



4.  If they are installed properly, moodle and PHPCompatibility will show up in the output of `phpcs -i`. Here is a typical example: 4.  If they are installed properly, moodle and PHPCompatibility will show up in the output of `phpcs -i`. Here is a typical example:
<code> <syntaxhighlight lang="php">
The installed coding standards are MySource, PHPCompatibility, Squiz, PSR2, moodle, PEAR, PSR1, PSR12 and Zend The installed coding standards are MySource, PHPCompatibility, Squiz, PSR2, moodle, PEAR, PSR1, PSR12 and Zend
</syntaxhighlight> </syntaxhighlight>



5. Optionally, you can set the default standard in a configuration file: 5. Optionally, you can set the default standard in a configuration file:
<code> <syntaxhighlight lang="php">
     phpcs --config-set default_standard moodle      phpcs --config-set default_standard moodle
</syntaxhighlight> </syntaxhighlight>
Line 162:
Line 162:
The script is located in lib/pear/PHP and is called runsniffer. To check the syntax of a given file (e.g. index.php), run: The script is located in lib/pear/PHP and is called runsniffer. To check the syntax of a given file (e.g. index.php), run:



<code> <syntaxhighlight lang="php">
lib/pear/PHP/runsniffer index.php lib/pear/PHP/runsniffer index.php
</syntaxhighlight> </syntaxhighlight>
Line 168:
Line 168:
You will get a report that looks like this: You will get a report that looks like this:



<code> <syntaxhighlight lang="php">
   --------------------------------------------------------------------------------    --------------------------------------------------------------------------------
   FOUND 139 ERROR(S) AND 24 WARNING(S) AFFECTING 130 LINE(S)    FOUND 139 ERROR(S) AND 24 WARNING(S) AFFECTING 130 LINE(S)
Line 188:
Line 188:
You can run the CodeSniffer with the -n flag to ignore warnings: You can run the CodeSniffer with the -n flag to ignore warnings:



<code> <syntaxhighlight lang="php">
lib/pear/PHP/runsniffer -n index.php lib/pear/PHP/runsniffer -n index.php
</syntaxhighlight> </syntaxhighlight>



Resulting output: Resulting output:
<code> <syntaxhighlight lang="php">
   --------------------------------------------------------------------------------    --------------------------------------------------------------------------------
   FOUND 139 ERROR(S) AFFECTING 125 LINE(S)    FOUND 139 ERROR(S) AFFECTING 125 LINE(S)
Line 205:
Line 205:
If you give the name of a folder instead of a file, it will search, analyse and report on all PHP files found in this folder and all its subfolders. This will produce a full report for each PHP file. Since this is likely to be too much information, you may want to print only a summary report, by using the following syntax (search the files/ folder as an example): If you give the name of a folder instead of a file, it will search, analyse and report on all PHP files found in this folder and all its subfolders. This will produce a full report for each PHP file. Since this is likely to be too much information, you may want to print only a summary report, by using the following syntax (search the files/ folder as an example):



<code> <syntaxhighlight lang="php">
lib/pear/PHP/runsniffer --report=summary files lib/pear/PHP/runsniffer --report=summary files
</syntaxhighlight> </syntaxhighlight>



Report: Report:
<code> <syntaxhighlight lang="php">
   PHP CODE SNIFFER REPORT SUMMARY    PHP CODE SNIFFER REPORT SUMMARY
   --------------------------------------------------------------------------------    --------------------------------------------------------------------------------
Line 227:
Line 227:
If you want to search all files under a folder, but not recurse through the subfolders, you can use the -l flag (local files only): If you want to search all files under a folder, but not recurse through the subfolders, you can use the -l flag (local files only):



<code> <syntaxhighlight lang="php">
lib/pear/PHP/runsniffer --report=summary -l grade lib/pear/PHP/runsniffer --report=summary -l grade

`Moodlebot: Text replacement - "`" to ""

2021-08-11T14:54:16Z

Text replacement - "</code>" to "</syntaxhighlight>"

← Older revision		Revision as of 14:54, 11 August 2021
Line 55:		Line 55:
	<code>		<code>
	The installed coding standards are MySource, PHPCompatibility, Squiz, PSR2, moodle, PEAR, PSR1, PSR12 and Zend		The installed coding standards are MySource, PHPCompatibility, Squiz, PSR2, moodle, PEAR, PSR1, PSR12 and Zend
	</~~code~~>		</syntaxhighlight>

	5. Optionally, you can set the default standard in a configuration file:		5. Optionally, you can set the default standard in a configuration file:
	<code>		<code>
	phpcs --config-set default_standard moodle		phpcs --config-set default_standard moodle
	</~~code~~>		</syntaxhighlight>

	'''Install using composer'''		'''Install using composer'''
Line 67:		Line 67:
	<code>		<code>
	composer global require "squizlabs/php_codesniffer=3.*"		composer global require "squizlabs/php_codesniffer=3.*"
	</~~code~~>		</syntaxhighlight>

	2. Download the standard: PHPCompatibility and moodle directories from https://github.com/moodlehq/moodle-local_codechecker		2. Download the standard: PHPCompatibility and moodle directories from https://github.com/moodlehq/moodle-local_codechecker
Line 77:		Line 77:
	<code>		<code>
	phpcs --config-set installed_paths /path/to/moodle-local_codechecker # adds moodle's standard to phpcs		phpcs --config-set installed_paths /path/to/moodle-local_codechecker # adds moodle's standard to phpcs
	</~~code~~>		</syntaxhighlight>

	4. If they are installed properly, moodle and PHPCompatibility will show up in the output of `phpcs -i`. Here is a typical example:		4. If they are installed properly, moodle and PHPCompatibility will show up in the output of `phpcs -i`. Here is a typical example:
	<code>		<code>
	The installed coding standards are MySource, PHPCompatibility, Squiz, PSR2, moodle, PEAR, PSR1, PSR12 and Zend		The installed coding standards are MySource, PHPCompatibility, Squiz, PSR2, moodle, PEAR, PSR1, PSR12 and Zend
	</~~code~~>		</syntaxhighlight>

	5. Optionally, you can set the default standard in a configuration file:		5. Optionally, you can set the default standard in a configuration file:
	<code>		<code>
	phpcs --config-set default_standard moodle		phpcs --config-set default_standard moodle
	</~~code~~>		</syntaxhighlight>

	===Codechecker output===		===Codechecker output===
Line 164:		Line 164:
	<code>		<code>
	lib/pear/PHP/runsniffer index.php		lib/pear/PHP/runsniffer index.php
	</~~code~~>		</syntaxhighlight>

	You will get a report that looks like this:		You will get a report that looks like this:
Line 178:		Line 178:
	55 \| ERROR \| line indented incorrectly; expected 0 spaces, found 4		55 \| ERROR \| line indented incorrectly; expected 0 spaces, found 4
	....		....
	</~~code~~>		</syntaxhighlight>

	The first column shows the line at which the ERROR or WARNING was found. The CodeSniffer uses a set of rules which are still being defined, so that what is currently defined as ERROR or WARNING is likely to change in the near future.		The first column shows the line at which the ERROR or WARNING was found. The CodeSniffer uses a set of rules which are still being defined, so that what is currently defined as ERROR or WARNING is likely to change in the near future.
Line 190:		Line 190:
	<code>		<code>
	lib/pear/PHP/runsniffer -n index.php		lib/pear/PHP/runsniffer -n index.php
	</~~code~~>		</syntaxhighlight>

	Resulting output:		Resulting output:
Line 200:		Line 200:
	50 \| ERROR \| line indented incorrectly; expected 0 spaces, found 4		50 \| ERROR \| line indented incorrectly; expected 0 spaces, found 4
	...		...
	</~~code~~>		</syntaxhighlight>

	====Recursive analysis====		====Recursive analysis====
Line 207:		Line 207:
	<code>		<code>
	lib/pear/PHP/runsniffer --report=summary files		lib/pear/PHP/runsniffer --report=summary files
	</~~code~~>		</syntaxhighlight>

	Report:		Report:
Line 220:		Line 220:
	A TOTAL OF 17 ERROR(S) AND 80 WARNING(S) WERE FOUND IN 2 FILE(S)		A TOTAL OF 17 ERROR(S) AND 80 WARNING(S) WERE FOUND IN 2 FILE(S)
	--------------------------------------------------------------------------------		--------------------------------------------------------------------------------
	</~~code~~>		</syntaxhighlight>

	You can also use the -n flag to ignore warnings.		You can also use the -n flag to ignore warnings.
Line 240:		Line 240:
	A TOTAL OF 11 ERROR(S) AND 251 WARNING(S) WERE FOUND IN 3 FILE(S)		A TOTAL OF 11 ERROR(S) AND 251 WARNING(S) WERE FOUND IN 3 FILE(S)
	--------------------------------------------------------------------------------		--------------------------------------------------------------------------------
	</~~code~~>		</syntaxhighlight>

	You can pass as many files and folders to the script as you want, the analysis and flags will apply to all of them.		You can pass as many files and folders to the script as you want, the analysis and flags will apply to all of them.

Mudrd8mz: Reverted edits by Mudrd8mz (talk) to last revision by Msharp.chi

2021-08-09T13:11:14Z

Reverted edits by Mudrd8mz (talk) to last revision by Mark Sharp

← Older revision		Revision as of 13:11, 9 August 2021
Line 53:		Line 53:

	4. If they are installed properly, moodle and PHPCompatibility will show up in the output of `phpcs -i`. Here is a typical example:		4. If they are installed properly, moodle and PHPCompatibility will show up in the output of `phpcs -i`. Here is a typical example:
	<~~syntaxhighlight lang="php"~~>		<code>
	The installed coding standards are MySource, PHPCompatibility, Squiz, PSR2, moodle, PEAR, PSR1, PSR12 and Zend		The installed coding standards are MySource, PHPCompatibility, Squiz, PSR2, moodle, PEAR, PSR1, PSR12 and Zend
	</~~syntaxhighlight~~>		</code>

	5. Optionally, you can set the default standard in a configuration file:		5. Optionally, you can set the default standard in a configuration file:
	<~~syntaxhighlight lang="php"~~>		<code>
	phpcs --config-set default_standard moodle		phpcs --config-set default_standard moodle
	</~~syntaxhighlight~~>		</code>

	'''Install using composer'''		'''Install using composer'''

	1. Run the following in your terminal from your moodle folder:		1. Run the following in your terminal from your moodle folder:
	<~~syntaxhighlight lang="php"~~>		<code>
	composer global require "squizlabs/php_codesniffer=3.*"		composer global require "squizlabs/php_codesniffer=3.*"
	</~~syntaxhighlight~~>		</code>

	2. Download the standard: PHPCompatibility and moodle directories from https://github.com/moodlehq/moodle-local_codechecker		2. Download the standard: PHPCompatibility and moodle directories from https://github.com/moodlehq/moodle-local_codechecker
Line 75:		Line 75:

	3. Tell phpcs about where to find the Moodle code checker		3. Tell phpcs about where to find the Moodle code checker
	<~~syntaxhighlight lang="php"~~>		<code>
	phpcs --config-set installed_paths /path/to/moodle-local_codechecker # adds moodle's standard to phpcs		phpcs --config-set installed_paths /path/to/moodle-local_codechecker # adds moodle's standard to phpcs
	</~~syntaxhighlight~~>		</code>

	4. If they are installed properly, moodle and PHPCompatibility will show up in the output of `phpcs -i`. Here is a typical example:		4. If they are installed properly, moodle and PHPCompatibility will show up in the output of `phpcs -i`. Here is a typical example:
	<~~syntaxhighlight lang="php"~~>		<code>
	The installed coding standards are MySource, PHPCompatibility, Squiz, PSR2, moodle, PEAR, PSR1, PSR12 and Zend		The installed coding standards are MySource, PHPCompatibility, Squiz, PSR2, moodle, PEAR, PSR1, PSR12 and Zend
	</~~syntaxhighlight~~>		</code>

	5. Optionally, you can set the default standard in a configuration file:		5. Optionally, you can set the default standard in a configuration file:
	<~~syntaxhighlight lang="php"~~>		<code>
	phpcs --config-set default_standard moodle		phpcs --config-set default_standard moodle
	</~~syntaxhighlight~~>		</code>

	===Codechecker output===		===Codechecker output===
Line 162:		Line 162:
	The script is located in lib/pear/PHP and is called runsniffer. To check the syntax of a given file (e.g. index.php), run:		The script is located in lib/pear/PHP and is called runsniffer. To check the syntax of a given file (e.g. index.php), run:

	<~~syntaxhighlight lang="php"~~>		<code>
	lib/pear/PHP/runsniffer index.php		lib/pear/PHP/runsniffer index.php
	</~~syntaxhighlight~~>		</code>

	You will get a report that looks like this:		You will get a report that looks like this:

	<~~syntaxhighlight lang="php"~~>		<code>
	--------------------------------------------------------------------------------		--------------------------------------------------------------------------------
	FOUND 139 ERROR(S) AND 24 WARNING(S) AFFECTING 130 LINE(S)		FOUND 139 ERROR(S) AND 24 WARNING(S) AFFECTING 130 LINE(S)
Line 178:		Line 178:
	55 \| ERROR \| line indented incorrectly; expected 0 spaces, found 4		55 \| ERROR \| line indented incorrectly; expected 0 spaces, found 4
	....		....
	</~~syntaxhighlight~~>		</code>

	The first column shows the line at which the ERROR or WARNING was found. The CodeSniffer uses a set of rules which are still being defined, so that what is currently defined as ERROR or WARNING is likely to change in the near future.		The first column shows the line at which the ERROR or WARNING was found. The CodeSniffer uses a set of rules which are still being defined, so that what is currently defined as ERROR or WARNING is likely to change in the near future.

	You should fix all ERRORs, but may safely ignore the WARNINGs. ~~tableing~~ warnings will help your code be even more readable and consistent with other code that follow this standard.		You should fix all ERRORs, but may safely ignore the WARNINGs. Fixing warnings will help your code be even more readable and consistent with other code that follow this standard.

	===Advanced Usage===		===Advanced Usage===
Line 188:		Line 188:
	You can run the CodeSniffer with the -n flag to ignore warnings:		You can run the CodeSniffer with the -n flag to ignore warnings:

	<~~syntaxhighlight lang="php"~~>		<code>
	lib/pear/PHP/runsniffer -n index.php		lib/pear/PHP/runsniffer -n index.php
	</~~syntaxhighlight~~>		</code>

	Resulting output:		Resulting output:
	<~~syntaxhighlight lang="php"~~>		<code>
	--------------------------------------------------------------------------------		--------------------------------------------------------------------------------
	FOUND 139 ERROR(S) AFFECTING 125 LINE(S)		FOUND 139 ERROR(S) AFFECTING 125 LINE(S)
Line 200:		Line 200:
	50 \| ERROR \| line indented incorrectly; expected 0 spaces, found 4		50 \| ERROR \| line indented incorrectly; expected 0 spaces, found 4
	...		...
	</~~syntaxhighlight~~>		</code>

	====Recursive analysis====		====Recursive analysis====
	If you give the name of a folder instead of a file, it will search, analyse and report on all PHP files found in this folder and all its subfolders. This will produce a full report for each PHP file. Since this is likely to be too much information, you may want to print only a summary report, by using the following syntax (search the files/ folder as an example):		If you give the name of a folder instead of a file, it will search, analyse and report on all PHP files found in this folder and all its subfolders. This will produce a full report for each PHP file. Since this is likely to be too much information, you may want to print only a summary report, by using the following syntax (search the files/ folder as an example):

	<~~syntaxhighlight lang="php"~~>		<code>
	lib/pear/PHP/runsniffer --report=summary files		lib/pear/PHP/runsniffer --report=summary files
	</~~syntaxhighlight~~>		</code>

	Report:		Report:
	<~~syntaxhighlight lang="php"~~>		<code>
	PHP CODE SNIFFER REPORT SUMMARY		PHP CODE SNIFFER REPORT SUMMARY
	--------------------------------------------------------------------------------		--------------------------------------------------------------------------------
Line 220:		Line 220:
	A TOTAL OF 17 ERROR(S) AND 80 WARNING(S) WERE FOUND IN 2 FILE(S)		A TOTAL OF 17 ERROR(S) AND 80 WARNING(S) WERE FOUND IN 2 FILE(S)
	--------------------------------------------------------------------------------		--------------------------------------------------------------------------------
	</~~syntaxhighlight~~>		</code>

	You can also use the -n flag to ignore warnings.		You can also use the -n flag to ignore warnings.
Line 227:		Line 227:
	If you want to search all files under a folder, but not recurse through the subfolders, you can use the -l flag (local files only):		If you want to search all files under a folder, but not recurse through the subfolders, you can use the -l flag (local files only):

	<~~syntaxhighlight lang="php"~~>		<code>
	lib/pear/PHP/runsniffer --report=summary -l grade		lib/pear/PHP/runsniffer --report=summary -l grade

Line 240:		Line 240:
	A TOTAL OF 11 ERROR(S) AND 251 WARNING(S) WERE FOUND IN 3 FILE(S)		A TOTAL OF 11 ERROR(S) AND 251 WARNING(S) WERE FOUND IN 3 FILE(S)
	--------------------------------------------------------------------------------		--------------------------------------------------------------------------------
	</~~syntaxhighlight~~>		</code>

	You can pass as many files and folders to the script as you want, the analysis and flags will apply to all of them.		You can pass as many files and folders to the script as you want, the analysis and flags will apply to all of them.

Mudrd8mz: MDLSITE-6551

2021-08-09T13:05:59Z

MDLSITE-6551

← Older revision		Revision as of 13:05, 9 August 2021
Line 182:		Line 182:
	The first column shows the line at which the ERROR or WARNING was found. The CodeSniffer uses a set of rules which are still being defined, so that what is currently defined as ERROR or WARNING is likely to change in the near future.		The first column shows the line at which the ERROR or WARNING was found. The CodeSniffer uses a set of rules which are still being defined, so that what is currently defined as ERROR or WARNING is likely to change in the near future.

	You should fix all ERRORs, but may safely ignore the WARNINGs. ~~Fixing~~ warnings will help your code be even more readable and consistent with other code that follow this standard.		You should fix all ERRORs, but may safely ignore the WARNINGs. tableing warnings will help your code be even more readable and consistent with other code that follow this standard.

	===Advanced Usage===		===Advanced Usage===

Mudrd8mz: Text replacement - "`" to ""`


2021-07-14T13:03:59Z
Text replacement - "<code>" to "<syntaxhighlight lang="php">"

				
				
				
				
				
				← Older revision
				Revision as of 13:03, 14 July 2021
				
Line 53:
Line 53:



4.  If they are installed properly, moodle and PHPCompatibility will show up in the output of `phpcs -i`. Here is a typical example: 4.  If they are installed properly, moodle and PHPCompatibility will show up in the output of `phpcs -i`. Here is a typical example:
<code> <syntaxhighlight lang="php">
The installed coding standards are MySource, PHPCompatibility, Squiz, PSR2, moodle, PEAR, PSR1, PSR12 and Zend The installed coding standards are MySource, PHPCompatibility, Squiz, PSR2, moodle, PEAR, PSR1, PSR12 and Zend
</syntaxhighlight> </syntaxhighlight>



5. Optionally, you can set the default standard in a configuration file: 5. Optionally, you can set the default standard in a configuration file:
<code> <syntaxhighlight lang="php">
     phpcs --config-set default_standard moodle      phpcs --config-set default_standard moodle
</syntaxhighlight> </syntaxhighlight>
Line 65:
Line 65:



1. Run the following in your terminal from your moodle folder: 1. Run the following in your terminal from your moodle folder:
<code> <syntaxhighlight lang="php">
composer global require "squizlabs/php_codesniffer=3.*" composer global require "squizlabs/php_codesniffer=3.*"
</syntaxhighlight> </syntaxhighlight>
Line 75:
Line 75:



3. Tell phpcs about where to find the Moodle code checker 3. Tell phpcs about where to find the Moodle code checker
<code> <syntaxhighlight lang="php">
phpcs  --config-set  installed_paths /path/to/moodle-local_codechecker # adds moodle's standard to phpcs phpcs  --config-set  installed_paths /path/to/moodle-local_codechecker # adds moodle's standard to phpcs
</syntaxhighlight> </syntaxhighlight>



4.  If they are installed properly, moodle and PHPCompatibility will show up in the output of `phpcs -i`. Here is a typical example: 4.  If they are installed properly, moodle and PHPCompatibility will show up in the output of `phpcs -i`. Here is a typical example:
<code> <syntaxhighlight lang="php">
The installed coding standards are MySource, PHPCompatibility, Squiz, PSR2, moodle, PEAR, PSR1, PSR12 and Zend The installed coding standards are MySource, PHPCompatibility, Squiz, PSR2, moodle, PEAR, PSR1, PSR12 and Zend
</syntaxhighlight> </syntaxhighlight>



5. Optionally, you can set the default standard in a configuration file: 5. Optionally, you can set the default standard in a configuration file:
<code> <syntaxhighlight lang="php">
     phpcs --config-set default_standard moodle      phpcs --config-set default_standard moodle
</syntaxhighlight> </syntaxhighlight>
Line 162:
Line 162:
The script is located in lib/pear/PHP and is called runsniffer. To check the syntax of a given file (e.g. index.php), run: The script is located in lib/pear/PHP and is called runsniffer. To check the syntax of a given file (e.g. index.php), run:



<code> <syntaxhighlight lang="php">
lib/pear/PHP/runsniffer index.php lib/pear/PHP/runsniffer index.php
</syntaxhighlight> </syntaxhighlight>
Line 168:
Line 168:
You will get a report that looks like this: You will get a report that looks like this:



<code> <syntaxhighlight lang="php">
   --------------------------------------------------------------------------------    --------------------------------------------------------------------------------
   FOUND 139 ERROR(S) AND 24 WARNING(S) AFFECTING 130 LINE(S)    FOUND 139 ERROR(S) AND 24 WARNING(S) AFFECTING 130 LINE(S)
Line 188:
Line 188:
You can run the CodeSniffer with the -n flag to ignore warnings: You can run the CodeSniffer with the -n flag to ignore warnings:



<code> <syntaxhighlight lang="php">
lib/pear/PHP/runsniffer -n index.php lib/pear/PHP/runsniffer -n index.php
</syntaxhighlight> </syntaxhighlight>



Resulting output: Resulting output:
<code> <syntaxhighlight lang="php">
   --------------------------------------------------------------------------------    --------------------------------------------------------------------------------
   FOUND 139 ERROR(S) AFFECTING 125 LINE(S)    FOUND 139 ERROR(S) AFFECTING 125 LINE(S)
Line 205:
Line 205:
If you give the name of a folder instead of a file, it will search, analyse and report on all PHP files found in this folder and all its subfolders. This will produce a full report for each PHP file. Since this is likely to be too much information, you may want to print only a summary report, by using the following syntax (search the files/ folder as an example): If you give the name of a folder instead of a file, it will search, analyse and report on all PHP files found in this folder and all its subfolders. This will produce a full report for each PHP file. Since this is likely to be too much information, you may want to print only a summary report, by using the following syntax (search the files/ folder as an example):



<code> <syntaxhighlight lang="php">
lib/pear/PHP/runsniffer --report=summary files lib/pear/PHP/runsniffer --report=summary files
</syntaxhighlight> </syntaxhighlight>



Report: Report:
<code> <syntaxhighlight lang="php">
   PHP CODE SNIFFER REPORT SUMMARY    PHP CODE SNIFFER REPORT SUMMARY
   --------------------------------------------------------------------------------    --------------------------------------------------------------------------------
Line 227:
Line 227:
If you want to search all files under a folder, but not recurse through the subfolders, you can use the -l flag (local files only): If you want to search all files under a folder, but not recurse through the subfolders, you can use the -l flag (local files only):



<code> <syntaxhighlight lang="php">
lib/pear/PHP/runsniffer --report=summary -l grade lib/pear/PHP/runsniffer --report=summary -l grade

`Mudrd8mz: Text replacement - "`" to ""

2021-07-14T13:02:24Z

Text replacement - "</code>" to "</syntaxhighlight>"

← Older revision		Revision as of 13:02, 14 July 2021
Line 55:		Line 55:
	<code>		<code>
	The installed coding standards are MySource, PHPCompatibility, Squiz, PSR2, moodle, PEAR, PSR1, PSR12 and Zend		The installed coding standards are MySource, PHPCompatibility, Squiz, PSR2, moodle, PEAR, PSR1, PSR12 and Zend
	</~~code~~>		</syntaxhighlight>

	5. Optionally, you can set the default standard in a configuration file:		5. Optionally, you can set the default standard in a configuration file:
	<code>		<code>
	phpcs --config-set default_standard moodle		phpcs --config-set default_standard moodle
	</~~code~~>		</syntaxhighlight>

	'''Install using composer'''		'''Install using composer'''
Line 67:		Line 67:
	<code>		<code>
	composer global require "squizlabs/php_codesniffer=3.*"		composer global require "squizlabs/php_codesniffer=3.*"
	</~~code~~>		</syntaxhighlight>

	2. Download the standard: PHPCompatibility and moodle directories from https://github.com/moodlehq/moodle-local_codechecker		2. Download the standard: PHPCompatibility and moodle directories from https://github.com/moodlehq/moodle-local_codechecker
Line 77:		Line 77:
	<code>		<code>
	phpcs --config-set installed_paths /path/to/moodle-local_codechecker # adds moodle's standard to phpcs		phpcs --config-set installed_paths /path/to/moodle-local_codechecker # adds moodle's standard to phpcs
	</~~code~~>		</syntaxhighlight>

	4. If they are installed properly, moodle and PHPCompatibility will show up in the output of `phpcs -i`. Here is a typical example:		4. If they are installed properly, moodle and PHPCompatibility will show up in the output of `phpcs -i`. Here is a typical example:
	<code>		<code>
	The installed coding standards are MySource, PHPCompatibility, Squiz, PSR2, moodle, PEAR, PSR1, PSR12 and Zend		The installed coding standards are MySource, PHPCompatibility, Squiz, PSR2, moodle, PEAR, PSR1, PSR12 and Zend
	</~~code~~>		</syntaxhighlight>

	5. Optionally, you can set the default standard in a configuration file:		5. Optionally, you can set the default standard in a configuration file:
	<code>		<code>
	phpcs --config-set default_standard moodle		phpcs --config-set default_standard moodle
	</~~code~~>		</syntaxhighlight>

	===Codechecker output===		===Codechecker output===
Line 164:		Line 164:
	<code>		<code>
	lib/pear/PHP/runsniffer index.php		lib/pear/PHP/runsniffer index.php
	</~~code~~>		</syntaxhighlight>

	You will get a report that looks like this:		You will get a report that looks like this:
Line 178:		Line 178:
	55 \| ERROR \| line indented incorrectly; expected 0 spaces, found 4		55 \| ERROR \| line indented incorrectly; expected 0 spaces, found 4
	....		....
	</~~code~~>		</syntaxhighlight>

	The first column shows the line at which the ERROR or WARNING was found. The CodeSniffer uses a set of rules which are still being defined, so that what is currently defined as ERROR or WARNING is likely to change in the near future.		The first column shows the line at which the ERROR or WARNING was found. The CodeSniffer uses a set of rules which are still being defined, so that what is currently defined as ERROR or WARNING is likely to change in the near future.
Line 190:		Line 190:
	<code>		<code>
	lib/pear/PHP/runsniffer -n index.php		lib/pear/PHP/runsniffer -n index.php
	</~~code~~>		</syntaxhighlight>

	Resulting output:		Resulting output:
Line 200:		Line 200:
	50 \| ERROR \| line indented incorrectly; expected 0 spaces, found 4		50 \| ERROR \| line indented incorrectly; expected 0 spaces, found 4
	...		...
	</~~code~~>		</syntaxhighlight>

	====Recursive analysis====		====Recursive analysis====
Line 207:		Line 207:
	<code>		<code>
	lib/pear/PHP/runsniffer --report=summary files		lib/pear/PHP/runsniffer --report=summary files
	</~~code~~>		</syntaxhighlight>

	Report:		Report:
Line 220:		Line 220:
	A TOTAL OF 17 ERROR(S) AND 80 WARNING(S) WERE FOUND IN 2 FILE(S)		A TOTAL OF 17 ERROR(S) AND 80 WARNING(S) WERE FOUND IN 2 FILE(S)
	--------------------------------------------------------------------------------		--------------------------------------------------------------------------------
	</~~code~~>		</syntaxhighlight>

	You can also use the -n flag to ignore warnings.		You can also use the -n flag to ignore warnings.
Line 240:		Line 240:
	A TOTAL OF 11 ERROR(S) AND 251 WARNING(S) WERE FOUND IN 3 FILE(S)		A TOTAL OF 11 ERROR(S) AND 251 WARNING(S) WERE FOUND IN 3 FILE(S)
	--------------------------------------------------------------------------------		--------------------------------------------------------------------------------
	</~~code~~>		</syntaxhighlight>

	You can pass as many files and folders to the script as you want, the analysis and flags will apply to all of them.		You can pass as many files and folders to the script as you want, the analysis and flags will apply to all of them.

Msharp.chi: /* Installing PHP CS */

2021-05-24T10:32:51Z

Installing PHP CS

← Older revision		Revision as of 10:32, 24 May 2021
Line 67:		Line 67:
	<code>		<code>
	composer global require "squizlabs/php_codesniffer=3.*"		composer global require "squizlabs/php_codesniffer=3.*"
	~~composer require --dev "blackboard-open-source/moodle-coding-standard" # installs moodle's coding standard~~
	~~phpcs --config-set installed_paths vendor/blackboard-open-source/moodle-coding-standard # adds moodle's standard to phpcs~~
	</code>		</code>

	2. If they are installed properly, moodle and PHPCompatibility will show up in the output of `phpcs -i`. Here is a typical example:		2. Download the standard: PHPCompatibility and moodle directories from https://github.com/moodlehq/moodle-local_codechecker
			to an accessible location on your computer - it doesn't have to be your project folder.

			Note: "blackboard-open-source/moodle-coding-standard" is no longer being maintained.

			3. Tell phpcs about where to find the Moodle code checker
			<code>
			phpcs --config-set installed_paths /path/to/moodle-local_codechecker # adds moodle's standard to phpcs
			</code>

			4. If they are installed properly, moodle and PHPCompatibility will show up in the output of `phpcs -i`. Here is a typical example:
	<code>		<code>
	The installed coding standards are MySource, PHPCompatibility, Squiz, PSR2, moodle, PEAR, PSR1, PSR12 and Zend		The installed coding standards are MySource, PHPCompatibility, Squiz, PSR2, moodle, PEAR, PSR1, PSR12 and Zend
	</code>		</code>

	3. Optionally, you can set the default standard in a configuration file:		5. Optionally, you can set the default standard in a configuration file:
	<code>		<code>
	phpcs --config-set default_standard moodle		phpcs --config-set default_standard moodle

Sarjona: Installing using composer

2021-02-19T15:53:53Z

Installing using composer

@@ Line 58: / Line 58: @@
 . Optionally, you can set the default standard in a configuration file:
 <code>
      phpcs --config-set default_standard moodle

← Older revision		Revision as of 13:03, 14 July 2021
Line 53:		Line 53:

	4. If they are installed properly, moodle and PHPCompatibility will show up in the output of `phpcs -i`. Here is a typical example:		4. If they are installed properly, moodle and PHPCompatibility will show up in the output of `phpcs -i`. Here is a typical example:
	<~~code~~>		<syntaxhighlight lang="php">
	The installed coding standards are MySource, PHPCompatibility, Squiz, PSR2, moodle, PEAR, PSR1, PSR12 and Zend		The installed coding standards are MySource, PHPCompatibility, Squiz, PSR2, moodle, PEAR, PSR1, PSR12 and Zend
	</syntaxhighlight>		</syntaxhighlight>

	5. Optionally, you can set the default standard in a configuration file:		5. Optionally, you can set the default standard in a configuration file:
	<~~code~~>		<syntaxhighlight lang="php">
	phpcs --config-set default_standard moodle		phpcs --config-set default_standard moodle
	</syntaxhighlight>		</syntaxhighlight>
Line 65:		Line 65:

	1. Run the following in your terminal from your moodle folder:		1. Run the following in your terminal from your moodle folder:
	<~~code~~>		<syntaxhighlight lang="php">
	composer global require "squizlabs/php_codesniffer=3.*"		composer global require "squizlabs/php_codesniffer=3.*"
	</syntaxhighlight>		</syntaxhighlight>
Line 75:		Line 75:

	3. Tell phpcs about where to find the Moodle code checker		3. Tell phpcs about where to find the Moodle code checker
	<~~code~~>		<syntaxhighlight lang="php">
	phpcs --config-set installed_paths /path/to/moodle-local_codechecker # adds moodle's standard to phpcs		phpcs --config-set installed_paths /path/to/moodle-local_codechecker # adds moodle's standard to phpcs
	</syntaxhighlight>		</syntaxhighlight>

	4. If they are installed properly, moodle and PHPCompatibility will show up in the output of `phpcs -i`. Here is a typical example:		4. If they are installed properly, moodle and PHPCompatibility will show up in the output of `phpcs -i`. Here is a typical example:
	<~~code~~>		<syntaxhighlight lang="php">
	The installed coding standards are MySource, PHPCompatibility, Squiz, PSR2, moodle, PEAR, PSR1, PSR12 and Zend		The installed coding standards are MySource, PHPCompatibility, Squiz, PSR2, moodle, PEAR, PSR1, PSR12 and Zend
	</syntaxhighlight>		</syntaxhighlight>

	5. Optionally, you can set the default standard in a configuration file:		5. Optionally, you can set the default standard in a configuration file:
	<~~code~~>		<syntaxhighlight lang="php">
	phpcs --config-set default_standard moodle		phpcs --config-set default_standard moodle
	</syntaxhighlight>		</syntaxhighlight>
Line 162:		Line 162:
	The script is located in lib/pear/PHP and is called runsniffer. To check the syntax of a given file (e.g. index.php), run:		The script is located in lib/pear/PHP and is called runsniffer. To check the syntax of a given file (e.g. index.php), run:

	<~~code~~>		<syntaxhighlight lang="php">
	lib/pear/PHP/runsniffer index.php		lib/pear/PHP/runsniffer index.php
	</syntaxhighlight>		</syntaxhighlight>
Line 168:		Line 168:
	You will get a report that looks like this:		You will get a report that looks like this:

	<~~code~~>		<syntaxhighlight lang="php">
	--------------------------------------------------------------------------------		--------------------------------------------------------------------------------
	FOUND 139 ERROR(S) AND 24 WARNING(S) AFFECTING 130 LINE(S)		FOUND 139 ERROR(S) AND 24 WARNING(S) AFFECTING 130 LINE(S)
Line 188:		Line 188:
	You can run the CodeSniffer with the -n flag to ignore warnings:		You can run the CodeSniffer with the -n flag to ignore warnings:

	<~~code~~>		<syntaxhighlight lang="php">
	lib/pear/PHP/runsniffer -n index.php		lib/pear/PHP/runsniffer -n index.php
	</syntaxhighlight>		</syntaxhighlight>

	Resulting output:		Resulting output:
	<~~code~~>		<syntaxhighlight lang="php">
	--------------------------------------------------------------------------------		--------------------------------------------------------------------------------
	FOUND 139 ERROR(S) AFFECTING 125 LINE(S)		FOUND 139 ERROR(S) AFFECTING 125 LINE(S)
Line 205:		Line 205:
	If you give the name of a folder instead of a file, it will search, analyse and report on all PHP files found in this folder and all its subfolders. This will produce a full report for each PHP file. Since this is likely to be too much information, you may want to print only a summary report, by using the following syntax (search the files/ folder as an example):		If you give the name of a folder instead of a file, it will search, analyse and report on all PHP files found in this folder and all its subfolders. This will produce a full report for each PHP file. Since this is likely to be too much information, you may want to print only a summary report, by using the following syntax (search the files/ folder as an example):

	<~~code~~>		<syntaxhighlight lang="php">
	lib/pear/PHP/runsniffer --report=summary files		lib/pear/PHP/runsniffer --report=summary files
	</syntaxhighlight>		</syntaxhighlight>

	Report:		Report:
	<~~code~~>		<syntaxhighlight lang="php">
	PHP CODE SNIFFER REPORT SUMMARY		PHP CODE SNIFFER REPORT SUMMARY
	--------------------------------------------------------------------------------		--------------------------------------------------------------------------------
Line 227:		Line 227:
	If you want to search all files under a folder, but not recurse through the subfolders, you can use the -l flag (local files only):		If you want to search all files under a folder, but not recurse through the subfolders, you can use the -l flag (local files only):

	<~~code~~>		<syntaxhighlight lang="php">
	lib/pear/PHP/runsniffer --report=summary -l grade		lib/pear/PHP/runsniffer --report=summary -l grade