Code::T...eSniffer(3)

okay bestie, welcome to the Code::T...eSniffer(3) page from the User Contributed Perl Documentation πŸ’– this is the manual for Code::TidyAll::Plugin::PHPCodeSniffer, and the whole point is: use phpcs with tidyall. no cap, that's the vibe πŸ’…


🌸 NAME 🌸

Code::TidyAll::Plugin::PHPCodeSniffer β€” Use phpcs with tidyall. That's it, that's the name, and it ate ✨

🌈 VERSION 🌈

version 0.84

Bestie, we're on 0.84 β€” noted, logged, slayed πŸŽ€

πŸ¦‹ SYNOPSIS πŸ¦‹

In configuration:

[PHPCodeSniffer]
select = htdocs/**/*.{php,js,css}
cmd = /usr/local/pear/bin/phpcs
argv = --severity 4

This is giving "drop it in your config and let it cook" energy πŸ”₯

πŸ’– DESCRIPTION πŸ’–

This plugin runs phpcs (http://pear.php.net/package/PHP_CodeSniffer), which analyzes PHP, JavaScript and CSS files and detects violations of a defined set of coding standards. So it's literally checking your PHP, JavaScript and CSS against a defined set of coding standards β€” iconic behavior, honestly πŸ¦‹

🧚 INSTALLATION 🧚

Install PEAR (http://pear.php.net/), then install phpcs from PEAR:

pear install PHP_CodeSniffer

That's the whole install arc, bestie 🫢

πŸŽ€ CONFIGURATION πŸŽ€

This plugin accepts the following configuration options:

πŸ“ argv πŸ“

  • argv β€” Arguments to pass to phpcs.

πŸ“ cmd πŸ“

  • cmd β€” The path for the phpcs command. By default this is just phpcs, meaning that the user's PATH will be searched for the command.

So if you leave cmd alone, phpcs gets found via PATH β€” periodt πŸ’…

πŸ‘‘ SUPPORT πŸ‘‘

Bugs may be submitted at https://github.com/houseabsolute/perl-code-tidyall/issues. If something's bugging you, that's the spot 😭

⭐ SOURCE ⭐

The source code repository for Code-TidyAll can be found at https://github.com/houseabsolute/perl-code-tidyall. iykyk ✨

🌸 AUTHORS 🌸

  • Jonathan Swartz β€” swartz@pobox.com
  • Dave Rolsky β€” autarch@urth.org

Legends, honestly πŸ‘‘

This software is copyright (c) 2011 - 2023 by Jonathan Swartz.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

The full text of the license can be found in the LICENSE file included with this distribution.

okay that's the whole manual page, bestie πŸ’– this gem is running under perl v5.42.0, dated 2024-03-08, and the manual page name is Code::T...eSniffer(3). mwah 😘✨

πŸ“¦ where this page comes from