├── .gitignore
├── README.md
├── composer.json
└── ruleset.xml


/.gitignore:
--------------------------------------------------------------------------------
1 | /composer.lock
2 | /vendor
3 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # PHP Type hints convertor
 2 | 
 3 | Converts `@param` and `@return` annotations to PHP7+ native type hints.
 4 | 
 5 | ## Usage
 6 | 
 7 | 1. [Download](https://github.com/kukulich/php-type-hints-convertor/archive/master.zip) or clone
 8 | 
 9 | 2. Install dependencies
10 | 
11 |     ```
12 |     composer install
13 |     ```
14 | 
15 | 3. Edit [ruleset.xml](https://github.com/kukulich/php-type-hints-convertor/blob/master/ruleset.xml)
16 | 
17 | 4. Run convertor
18 | 
19 |     ```
20 |     vendor/bin/phpcbf --encoding=utf-8 --extensions=php --tab-width=4 --no-patch --standard=ruleset.xml directory_with_your_project
21 |     ```
22 | 
23 | 5. Run checker and add type hints that cannot be added automatically
24 | 
25 |     ```
26 |     vendor/bin/phpcs --encoding=utf-8 --extensions=php --tab-width=4 --standard=ruleset.xml directory_with_your_project
27 |     ```
28 | 
29 | 6. Run your tests and check if everything is ok
30 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 | 	"name": "kukulich/typehints-fixer",
 3 | 	"homepage": "http://github.com/kukulich/typehints-fixer",
 4 | 	"minimum-stability": "dev",
 5 | 	"prefer-stable": true,
 6 | 	"require": {
 7 | 		"slevomat/coding-standard": "dev-2.0-dev#1e3adf8"
 8 | 	}
 9 | }
10 | 


--------------------------------------------------------------------------------
/ruleset.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <ruleset name="Type hints convertor">
 3 | 	<rule ref="vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/TypeHintDeclarationSniff.php"/>
 4 | 
 5 | 	<!-- Enable for "NULL", remove for "null" -->
 6 | 	<rule ref="Generic.PHP.UpperCaseConstant"/>
 7 | 
 8 | 	<rule ref="SlevomatCodingStandard.TypeHints.TypeHintDeclaration">
 9 | 		<!-- Remove this if you want to convert parameter type hints -->
10 | 		<exclude name="SlevomatCodingStandard.TypeHints.TypeHintDeclaration.MissingParameterTypeHint"/>
11 | 
12 | 		<!-- Remove this if you want to convert return type hints -->
13 | 		<exclude name="SlevomatCodingStandard.TypeHints.TypeHintDeclaration.MissingReturnTypeHint"/>
14 | 
15 | 		<!-- Remove this if you want to remove useless doccomments -->
16 | 		<exclude name="SlevomatCodingStandard.TypeHints.TypeHintDeclaration.UselessDocComment"/>
17 | 
18 | 		<properties>
19 | 			<!-- List of traversable type hints -->
20 | 			<property name="traversableTypeHints" type="array" value="
21 | 				Traversable,
22 | 				Nette\ArrayHash,
23 | 				Nette\ArrayList
24 | 			"/>
25 | 
26 | 			<!-- PHP 7.1: Enable type hints with ? -->
27 | 			<property name="enableNullableTypeHints" value="false"/>
28 | 			<!-- PHP 7.1: Enable void -->
29 | 			<property name="enableVoidTypeHint" value="false"/>
30 | 
31 | 			<!-- For "UselessDocComment": doccomment is not detected as useless if it contains one of this annotions -->
32 | 			<property name="usefulAnnotations" type="array" value="
33 | 				@deprecated,
34 | 				@internal,
35 | 				@see
36 | 			"/>
37 | 		</properties>
38 | 
39 | 		<!-- Not useful here, just ignore -->
40 | 		<exclude name="SlevomatCodingStandard.TypeHints.TypeHintDeclaration.MissingPropertyTypeHint"/>
41 | 		<exclude name="SlevomatCodingStandard.TypeHints.TypeHintDeclaration.MissingTraversableParameterTypeHintSpecification"/>
42 | 		<exclude name="SlevomatCodingStandard.TypeHints.TypeHintDeclaration.MissingTraversablePropertyTypeHintSpecification"/>
43 | 		<exclude name="SlevomatCodingStandard.TypeHints.TypeHintDeclaration.MissingTraversableReturnTypeHintSpecification"/>
44 | 	</rule>
45 | </ruleset>
46 | 


--------------------------------------------------------------------------------