signpostmarv/php-cs-fixer-config

PHP-CS-Fixer Config

v0.12.0 2019-09-11 13:22 UTC

README

Build Status Psalm Type Coverage

There's two different versions, one for general use & one for use on projects that use static analysis.

Installation & Usage

  1. composer require --dev signpostmarv/php-cs-fixer-config
  2. create your .php_cs or .php_cs.dist file and enter the corresponding code for the config you wish to use

General Use

return \SignpostMarv\CS\Config::createWithPaths(...[
	__FILE__,
	(__DIR__ . '/src/'),
	(__DIR__ . '/tests/'),
])

Use without PHP 7.1 Nullable return types

return \SignpostMarv\CS\ConfigUsedWithoutNullableReturn::createWithPaths(...[
	__FILE__,
	(__DIR__ . '/src/'),
	(__DIR__ . '/tests/'),
])

With Static Analysis

return \SignpostMarv\CS\ConfigUsedWithStaticAnalysis::createWithPaths(...[
	__FILE__,
	(__DIR__ . '/src/'),
	(__DIR__ . '/tests/'),
])

Use without PHP 7.1 Nullable return types

return \SignpostMarv\CS\ConfigUsedWithStaticAnalysisWithoutNullableReturn::createWithPaths(...[
	__FILE__,
	(__DIR__ . '/src/'),
	(__DIR__ . '/tests/'),
])

Customising Rules

  1. Extend SignpostMarv\CS\Config
  2. Either
    • override the SignpostMarv\CS\Config::DEFAULT_RULES array const
    • override the SignpostMarv\CS\Config::RuntimeResolveRules() static method as in ConfigUsedWithStaticAnalysis