Download the PHP package aeliot/php-cs-fixer-baseline without Composer
On this page you can find all versions of the php package aeliot/php-cs-fixer-baseline. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download aeliot/php-cs-fixer-baseline
More information about aeliot/php-cs-fixer-baseline
Files in aeliot/php-cs-fixer-baseline
Package php-cs-fixer-baseline
Short Description Baseline for PHP CS Fixer
License MIT
Informations about the package php-cs-fixer-baseline
Baseline for PHP CS Fixer
It's simple baseline for PHP CS Fixer.
Pros:
- It helps to start using of PHP CS Fixer without preparing of all project. Case you don't need to fix them all at the beginning. Only new & changed on each iteration.
- It may speed up pipelines on CI for big projects.
Base project has requires for it but not implemented yet: https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/issues/6451
So, it's some work around till baseline will be implemented in the PHP CS Fixer.
Installation
There are few ways of installation:
- Phive
- Composer
- Downloading of PHAR directly
Phive
You can install this package with Phive. It permits you to install package by one console command without extending dependencies in your composer-files.
Sometimes you may need to update database of package-aliases of PHIVE. See issue #3 So, just call console command for it:
To upgrade this package use the following command:
Composer
You can install this package with Composer:
Downloading of PHAR directly
Download PHAR directly to root directory of the project or in another place as you wish.
Configuration
- Extract
Finder
from the config of PHP CS Fixer to the separate file. It expects.php-cs-fixer-finder.php
at the root of the project. -
Add filtering of files detected by Finder.
- Autoload classes from PHAR (optional).
If you use this project as PHAR file, you need to require autoloader of it to use provided filter.
Do it in the main config file of PHP CS Fixer (
.php-cs-fixer.dist.php
)
Using
-
Generate baseline. Just call script without options when all config files uses default names.
-
Call PHAR
- Or call script installed via Composer:
See options of it below. You can see how it is configured in this project.
-
- Use PHP CS Fixer as usual. All files mentioned in the baseline will be scip till they are not changed.
This script store relative paths to files in baseline file by default. It is useful when baseline used in different environments.
Options of baseline generator
Short name | Long name | Description | Default value |
---|---|---|---|
a | absolute | Store absolute paths in baseline file. It does not expect any value. | |
b | baseline | Pathname of baseline file. | .php-cs-fixer-baseline.json |
c | config | Pathname of config file. | .php-cs-fixer.dist.php |
d | config-dir | Config files path | '' |
f | finder | Pathname of file with definition of Finder. | .php-cs-fixer-finder.php |
w | workdir | Working directory. |
Options baseline
, config
, finder
can be absolute or related or omitted at all. In the last case it expects
that files are in the root directory of project.
You can use option workdir
to customize path to working directory. Otherwise, directory where the script called
is used. The same with the filter for PHP CS Fixer. You may customize working directory by third option for
filter factory.
Pass option absolute
when you want to force saving of absolute paths to files of your project in baseline.
It cannot be used with option workdir
.
Restrictions for using of relative paths
- Option
workdir
MUST be absolute. You cannot use "double dots" in it. - Used function
realpath()
for normalisation of paths of files returned byFinder
. For proper cutting ofworkdir
out of file path to make it relative. It may return unexpected result based on current user permissions. Look for restrictions of this function in official documentation of PHP. - When the function
realpath()
returns an empty result or path of file returned byFinder
is not from working directory then path stored "as is".