10.8k sao GitHub và vẫn tăng — squizlabs/PHP_CodeSniffer là dự án PHP mà TopGit đang theo dõi trên nền tảng. PHP_CodeSniffer tokenizes PHP files and detects violations of a defined set of coding standards.
Tóm tắt dựng từ metadata GitHub của chính dự án — chưa có bài review TopGit. Trang sẽ tự động cập nhật khi bài review đầy đủ được xuất bản.
VÌ SAO CHƯA CÓ REVIEW
TopGit viết bài đầy đủ cho repo có nhiều sao nhất và được yêu cầu nhiều nhất. Trang này là snapshot trong thời gian chờ — xem README gốc ở tab READ ME.
[!WARNING]
This repository has been abandoned. Its successor is PHPCSStandards/PHP_CodeSniffer
See issue #3932 for more information.
About
PHP_CodeSniffer is a set of two PHP scripts; the main phpcs script that tokenizes PHP, JavaScript and CSS files to detect violations of a defined coding standard, and a second phpcbf script to automatically correct coding standard violations. PHP_CodeSniffer is an essential development tool that ensures your code remains clean and consistent.
Requirements
PHP_CodeSniffer requires PHP version 5.4.0 or greater, although individual sniffs may have additional requirements such as external applications and scripts. See the Configuration Options manual page for a list of these requirements.
If you're using PHP_CodeSniffer as part of a team, or you're running it on a CI server, you may want to configure your project's settings using a configuration file.
Installation
The easiest way to get started with PHP_CodeSniffer is to download the Phar files for each of the commands:
# Download using curl
curl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcs.phar
curl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcbf.phar
# Or download using wget
wget https://squizlabs.github.io/PHP_CodeSniffer/phpcs.phar
wget https://squizlabs.github.io/PHP_CodeSniffer/phpcbf.phar
# Then test the downloaded PHARs
php phpcs.phar -h
php phpcbf.phar -h
Composer
If you use Composer, you can install PHP_CodeSniffer system-wide with the following command:
composer global require "squizlabs/php_codesniffer=*"
Make sure you have the composer bin dir in your PATH. The default value is ~/.composer/vendor/bin/, but you can check the value that you need to use by running composer global config bin-dir --absolute.
Or alternatively, include a dependency for squizlabs/php_codesniffer in your composer.json file. For example:
You will then be able to run PHP_CodeSniffer from the vendor bin directory:
./vendor/bin/phpcs -h
./vendor/bin/phpcbf -h
Phive
If you use Phive, you can install PHP_CodeSniffer as a project tool using the following commands:
phive install phpcs
phive install phpcbf
You will then be able to run PHP_CodeSniffer from the tools directory:
./tools/phpcs -h
./tools/phpcbf -h
PEAR
If you use PEAR, you can install PHP_CodeSniffer using the PEAR installer. This will make the phpcs and phpcbf commands immediately available for use. To install PHP_CodeSniffer using the PEAR installer, first ensure you have installed PEAR and then run the following command:
pear install PHP_CodeSniffer
Git Clone
You can also download the PHP_CodeSniffer source and run the phpcs and phpcbf commands directly from the Git clone:
The default coding standard used by PHP_CodeSniffer is the PEAR coding standard. To check a file against the PEAR coding standard, simply specify the file's location:
phpcs /path/to/code/myfile.php
Or if you wish to check an entire directory you can specify the directory location instead of a file.
phpcs /path/to/code-directory
If you wish to check your code against the PSR-12 coding standard, use the --standard command line argument:
phpcs --standard=PSR12 /path/to/code-directory
If PHP_CodeSniffer finds any coding standard errors, a report will be shown after running the command.
Full usage information and example reports are available on the usage page.
Documentation
The documentation for PHP_CodeSniffer is available on the Github wiki.
Issues
Bug reports and feature requests can be submitted on the Github Issue Tracker.
Contributing
See CONTRIBUTING.md for information.
Versioning
PHP_CodeSniffer uses a MAJOR.MINOR.PATCH version number format.
The MAJOR version is incremented when:
backwards-incompatible changes are made to how the phpcs or phpcbf commands are used, or
backwards-incompatible changes are made to the ruleset.xml format, or
backwards-incompatible changes are made to the API used by sniff developers, or
custom PHP_CodeSniffer token types are removed, or
existing sniffs are removed from PHP_CodeSniffer entirely
The MINOR version is incremented when:
new backwards-compatible features are added to the phpcs and phpcbf commands, or
backwards-compatible changes are made to the ruleset.xml format, or
backwards-compatible changes are made to the API used by sniff developers, or
new sniffs are added to an included standard, or
existing sniffs are removed from an included standard
NOTE: Backwards-compatible changes to the API used by sniff developers will allow an existing sniff to continue running without producing fatal errors but may not result in the sniff reporting the same errors as it did previously without changes being required.
The PATCH version is incremented when:
backwards-compatible bug fixes are made
NOTE: As PHP_CodeSniffer exists to report and fix issues, most bugs are the result of coding standard errors being incorrectly reported or coding standard errors not being reported when they should be. This means that the messages produced by PHP_CodeSniffer, and the fixes it makes, are likely to be different between PATCH versions.
Trang TopGit này là một snapshot — tab "Readme" hiển thị nguyên văn README của repo (đã bỏ link, giữ ảnh). Repo GitHub ở github.com/squizlabs/PHP_CodeSniffer là nguồn chính thức.
squizlabs/PHP_CodeSniffer có bao nhiêu sao?
squizlabs/PHP_CodeSniffer có 10.8k sao GitHub — tải lại trang để xem số mới nhất, hoặc xem trực tiếp github.com/squizlabs/PHP_CodeSniffer. TopGit phản chiếu số sao của GitHub nhưng không cam kết đến từng phút.
squizlabs/PHP_CodeSniffer có phải mã nguồn mở không?
Có — squizlabs/PHP_CodeSniffer phát hành theo license BSD-3-Clause, nghĩa là mã nguồn mở để đọc, fork và (tùy license) tái sử dụng. Mã: github.com/squizlabs/PHP_CodeSniffer.
squizlabs/PHP_CodeSniffer còn đang phát triển không?
Commit gần nhất trên squizlabs/PHP_CodeSniffer là 2.6 năm trước (theo timestamp GitHub). Repo có 1.4k fork — một chỉ báo về mức độ quan tâm của cộng đồng.
squizlabs/PHP_CodeSniffer là gì?
squizlabs/PHP_CodeSniffer (squizlabs/PHP_CodeSniffer) là dự án PHP trên GitHub. Theo mô tả gốc: PHP_CodeSniffer tokenizes PHP files and detects violations of a defined set of coding standards.
squizlabs/PHP_CodeSniffer so với các dự án Automation khác thế nào?
squizlabs/PHP_CodeSniffer được TopGit xếp vào nhóm Automation, với 10.8k sao GitHub và viết bằng PHP. Xem trang chủ đề Automation trên TopGit để so sánh với các dự án tương tự theo số sao và mức độ hoạt động.
Đọc đầy đủ README ở tab phía trên.
PHP_CodeSniffer có đáng để bạn bỏ thời gian?
ChatGPT, Claude và Perplexity đều đọc được trang này. Hỏi thử xem họ nghĩ gì về PHP_CodeSniffer.