Download the PHP package valkyrja/ci-phpcodesniffer without Composer

On this page you can find all versions of the php package valkyrja/ci-phpcodesniffer. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of valkyrja/ci-phpcodesniffer

Informations about the package ci-phpcodesniffer

Valkyrja PHP Code Sniffer

Shared PHP Code Sniffer configuration for Valkyrja PHP projects — ruleset and reusable workflow that enforce the project's file-naming and namespace conventions across consuming repositories.

PHP Version Require Latest Stable Version License CI Status Scrutinizer Coverage Status Psalm Shepherd Maintainability Rating

Usage

The ruleset is defined in .github/ci/phpcodesniffer/ruleset.xml and run via the phpcodesniffer Composer script:

This runs phpcs against src/ and tests/ using the project ruleset. The src/ run suppresses warnings (-n); the tests/ run additionally shows sniff source codes (-n -s).

To see all warnings (not just errors), run:

Ruleset

Excluded Paths

The following paths are excluded from all checks:

Path
.github/
.phpunit.cache/
build/
coverage-html/
docs/
functions/
pre-commit-hooks/
vendor/

Rules

SlevomatCodingStandard.Files.TypeNameMatchesFileName

Enforces that each type (class, interface, trait, enum) is declared in a file whose name matches the type name, rooted at the configured namespaces:

Root path Namespace
src/Valkyrja Valkyrja
tests/Tests Valkyrja\Tests

The following directories are skipped when resolving file paths:

.github, docs, functions, pre-commit-hooks, vendor

SlevomatCodingStandard.Namespaces.ReferenceUsedNamesOnly

All referenced names must appear in use statements — fully qualified names are not permitted inline:

Property Value Effect
allowPartialUses false Partial uses (e.g. use Foo\Bar referencing Bar\Baz) are not allowed
allowFullyQualifiedNameForCollidingClasses false Colliding class names must be aliased, not referenced fully qualified
searchAnnotations true Annotations in docblocks are also checked for unimported names

Workflows

The _workflow-call.yml reusable workflow runs PHP Code Sniffer against the calling repository's source. It is designed to be called from other repositories via workflow_call.

Inputs

Input Type Default Description
paths string — Required. YAML filter spec with two keys: ci (CI config files that trigger a base-branch fetch) and files (all files that trigger the check).
post-pr-comment boolean true Post a PR comment on failure and remove it on success. Disable when the calling workflow handles its own reporting.
composer-options string '' Extra flags passed to every composer install step (e.g. --ignore-platform-req=ext-openswoole).
php-version string '8.4' PHP version to use.
ci-directory string '.github/ci/phpcodesniffer' Path to the CI directory containing composer.json and the tool config.
extensions string 'mbstring, intl' PHP extensions to install via shivammathur/setup-php.

Usage

secrets: inherit is required to pass the VALKYRJA_GHA_APP_ID and VALKYRJA_GHA_PRIVATE_KEY org secrets used for PR comments.

Contributing

See CONTRIBUTING.md for the submission process and VOCABULARY.md for the terminology used across Valkyrja.

Security Issues

If you discover a security vulnerability, please follow our disclosure procedure.

License

Licensed under the MIT license. See LICENSE.md.

All versions of ci-phpcodesniffer with dependencies

PHP Build Version
Package Version
Requires php Version >=8.4
squizlabs/php_codesniffer Version ^4.0.4
slevomat/coding-standard Version ^8.31.1
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package valkyrja/ci-phpcodesniffer contains the following files

Loading the files please wait ...