Difference between revisions of "Coding Standards"

From Freephile Wiki
Jump to navigation Jump to search
(Add ESLint)
m
 
(One intermediate revision by the same user not shown)
Line 15: Line 15:
 
[https://eslint.org/ ESLint] statically analyzes your code to quickly find problems. It is built into most text editors and you can run ESLint as part of your [[continuous integration]] pipeline.
 
[https://eslint.org/ ESLint] statically analyzes your code to quickly find problems. It is built into most text editors and you can run ESLint as part of your [[continuous integration]] pipeline.
  
ESLint is used as a code quality tool for the MediaWiki project, and specifically their Vue codebase. More at https://www.mediawiki.org/wiki/Manual:Coding_conventions/Vue
+
ESLint is used as a code quality tool for the MediaWiki project, and specifically their [[Vue.js|Vue]] codebase. More at https://www.mediawiki.org/wiki/Manual:Coding_conventions/Vue
 
 
  
 
[[Category:Tools]]
 
[[Category:Tools]]

Latest revision as of 16:58, 6 November 2023

In the PHP community, as well as every other development community, there has been a long-standing tradition of establishing 'Coding Standards' that specify how developers should format their code. So, the PHP Framework Interop(ability) Group came up with PSR-1 and PSR-2 that deal with the issue specifically.

Tools[edit | edit source]

Fabien Potencier (Sensio Labs) has released the PHP Coding Standards Fixer tool which fixes most issues in your code. It helps you follow the PHP coding standards as defined in the PSR-1 and PSR-2 documents.

Greg Sherwood (Squiz Labs) is the maintainer of PHP CodeSniffer, which was originally a PEAR project. PHP_CodeSniffer tokenizes and "sniffs" PHP, JavaScript and CSS files to detect violations of a defined coding standard. It is an essential development tool that ensures your code remains clean and consistent. It can also help prevent some common semantic errors made by developers.

ESLint[edit | edit source]

ESLint statically analyzes your code to quickly find problems. It is built into most text editors and you can run ESLint as part of your continuous integration pipeline.

ESLint is used as a code quality tool for the MediaWiki project, and specifically their Vue codebase. More at https://www.mediawiki.org/wiki/Manual:Coding_conventions/Vue