https://github.com/netgen/coding-standard
Coding standard for Netgen packages
https://github.com/netgen/coding-standard
Last synced: 5 days ago
JSON representation
Coding standard for Netgen packages
- Host: GitHub
- URL: https://github.com/netgen/coding-standard
- Owner: netgen
- License: mit
- Created: 2025-12-05T10:03:50.000Z (6 months ago)
- Default Branch: master
- Last Pushed: 2025-12-10T14:20:42.000Z (6 months ago)
- Last Synced: 2026-04-03T01:50:01.455Z (2 months ago)
- Language: PHP
- Size: 5.86 KB
- Stars: 1
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Netgen Coding Standard
This repository provides a default configuration used by all Netgen projects to
check for coding standards violations. The config is based on PHP CS Fixer.
## Installation
```bash
$ composer require --dev netgen/coding-standard
```
## Usage
Create a `.php-cs-fixer.php` file in the root of your project with the following:
```php
setFinder(
PhpCsFixer\Finder::create()
->exclude(['vendor'])
->in(__DIR__)
)
;
```
Run the fixer with:
```bash
$ vendor/bin/php-cs-fixer fix
```
## Overriding existing rules
You can override rules included in this config per project:
```php
addRules([
'list_syntax' => ['syntax' => 'long'],
])
->setFinder(
PhpCsFixer\Finder::create()
->exclude(['vendor'])
->in(__DIR__)
)
;
```
## Supporting PHAR distribution of PHP CS Fixer
You can also support running PHAR version of PHP CS Fixer by adding the
following at the top of your `.php-cs-fixer.php` file:
```php
// To support running PHP CS Fixer via PHAR file (e.g. in GitHub Actions)
require_once __DIR__ . '/vendor/netgen/coding-standard/lib/PhpCsFixer/Config.php';
```
This is e.g. useful if you wish to run PHP CS Fixer via GitHub action, which
does not need running `composer install`:
```yaml
# .github/workflows/coding_standards.yml
name: Coding standards
on: [push, pull_request]
jobs:
php-cs-fixer:
name: PHP CS Fixer
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- uses: actions/checkout@v6
with:
repository: netgen/coding-standard
path: vendor/netgen/coding-standard
- name: PHP CS Fixer
uses: docker://oskarstark/php-cs-fixer-ga
with:
args: --diff --dry-run
```
Check https://github.com/OskarStark/php-cs-fixer-ga for more details.