lifterlms / lifterlms-cs
PHP_CodeSniffer rules for LifterLMS projects
Installs: 394 692
Dependents: 4
Suggesters: 0
Security: 0
Stars: 3
Watchers: 6
Forks: 4
Open Issues: 2
Type:phpcodesniffer-standard
Requires
- php: >=5.6
- phpcompatibility/phpcompatibility-wp: ^2.0.0
- phpmd/phpmd: ^2.6.0
- squizlabs/php_codesniffer: ^3.3.2
- wp-coding-standards/wpcs: ^1.1.0
Requires (Dev)
- phpcompatibility/php-compatibility: ^9.0.0
- roave/security-advisories: dev-master
This package is auto-updated.
Last update: 2024-10-30 00:01:33 UTC
README
LifterLMS Coding Standards (LifterLMS-CS) is a project with rulesets for code style and quality intended for use in LifterLMS projects.
Installation
To include in a project require as a development dependency:
composer require lifterlms/lifterlms-cs:dev-trunk --dev
If you are upgrading from the old version, be sure to remove any references to manually setting the installed_paths
as they are now automatically set by Composer.
Using PHPCS & PHPCBF
Access the PHPCS execultable via: ./vendor/bin/phpcs
Check for errors only: ./vendor/bin/phpcs --error-severity=1 --warning-severity=6
Fix errors via PHPCBF: ./vendor/bin/phpcbf
Predefined scripts
The following scripts can be added to your composer.json
file for easy access to thes scripts & to ensure configurations are automatically set during package installation and updates.
"scripts": { "check-cs": [ "\"vendor/bin/phpcs\" --colors" ], "check-cs-errors": [ "\"vendor/bin/phpcs\" --colors --error-severity=1 --warning-severity=6" ], "fix-cs": [ "\"vendor/bin/phpcbf\"" ] }
Developing LifterLMS-CS
To include in a project and make changes to the LifterLMS-CS project itself:
Add to your composer.json
file with the @dev
tag and reference your local copy of this repository in the repositories block:
"require-dev": { "lifterlms/lifterlms-cs": "@dev" }, "repositories": [ { "type": "path", "url": "/absolute/path/to/lifterlms-cs" } ]