iqrf/coding-style

IQRF PHPCodeSniffer ruleset.

v0.1.1 2024-11-24 14:38 UTC

Requires

• php: >=8.0
• contributte/qa: ^0.4

Apache-2.0

• Roman Ondráček

• phpcs
• ruleset
• PHPCodeSniffer
• iqrf

README

PHPCodeSniffer ruleset for our PHP projects.

Requires PHP 8.1 or higher.

Installation

Install the latest version of iqrf/php-coding-style using Composer.

composer require --dev iqrf/coding-style

Usage

Create a ruleset.xml file in the root of your project with the following content:

<?xml version="1.0"?>
<ruleset name="My Project">
	<rule ref="vendor/iqrf/coding-style/ruleset.xml" />

	<!-- custom settings -->
</ruleset>

Run PHPCodeSniffer with the following command:

vendor/bin/codesniffer --runtime-set php_version 80100 src tests

License

This project is licensed under Apache License 2.0:

Copyright 2017-2024 IQRF Tech s.r.o.
Copyright 2019-2024 MICRORISC s.r.o.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.