Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ibexa/code-style
https://github.com/ibexa/code-style
Last synced: 6 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/ibexa/code-style
- Owner: ibexa
- License: other
- Created: 2021-11-30T10:08:19.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-10T11:40:11.000Z (7 months ago)
- Last Synced: 2024-04-10T20:24:39.080Z (7 months ago)
- Language: PHP
- Size: 58.6 KB
- Stars: 0
- Watchers: 13
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Ibexa Code Style
This package contains Ibexa Coding Standards which are aimed to include plugins
for code style tools, plugins for CI, IDE settings, Git hooks, GitHub templates related
to contributions, etc.
## Installation and backward compatibility promise
This package doesn't follow strict SemVer BC promise due to maintenance reasons.
Backward compatibility is guaranteed within a single minor release, instead of a major one.
We recommend installing it using tilde (`~`) composer constraint followed by `X.Y.Z` version number format, e.g.:
```bash
composer req --dev ibexa/code-style:~2.0.0
```
This ensures that composer will install `v2.0.*` patch releases only.
Minor releases might receive configuration updates either needed by [Ibexa DXP](https://www.ibexa.co/products)
packages or other changes forced by PHP CS Fixer package itself.
## Usage
### Third party packages
Create a `.php-cs-fixer.php` file in your project root directory with the following content:
```php
withRules([
// Your rules go here
]);
$config = $factory->buildConfig();
$config->setFinder(
PhpCsFixer\Finder::create()
->in(__DIR__ . '/src')
->in(__DIR__ . '/tests')
->files()->name('*.php')
);
return $config;
```
### Ibexa packages
Create a `.php-cs-fixer.php` file in your project root directory with the following content:
```php
setFinder(
PhpCsFixer\Finder::create()
->in(__DIR__ . '/src')
->in(__DIR__ . '/tests')
->files()->name('*.php')
)
;
```
## FAQ
See [FAQ](doc/FAQ.md) for common questions about contributing to Ibexa-related packages.
## COPYRIGHT
Copyright (C) 1999-2024 Ibexa AS (formerly eZ Systems AS). All rights reserved.
## LICENSE
This source code is available separately under the following licenses:
A - Ibexa Business Use License Agreement (Ibexa BUL),
version 2.4 or later versions (as license terms may be updated from time to time)
Ibexa BUL is granted by having a valid Ibexa DXP (formerly eZ Platform Enterprise) subscription,
as described at: https://www.ibexa.co/product
For the full Ibexa BUL license text, please see:
- LICENSE-bul file placed in the root of this source code, or
- https://www.ibexa.co/software-information/licenses-and-agreements (latest version applies)
AND
B - GNU General Public License, version 2
Grants an copyleft open source license with ABSOLUTELY NO WARRANTY. For the full GPL license text, please see:
- LICENSE file placed in the root of this source code, or
- https://www.gnu.org/licenses/old-licenses/gpl-2.0.html