Enhancement: Add rector config file for easy migration

README.md

@@ -57,6 +57,37 @@ for ($i = 0; $i < 3; $i++) {
 // 'Orlo Bergstrom'
 ```
 
+## Automated refactoring
+
+If you already used this library with its properties, they are now deprecated and needs to be replaced by their equivalent methods.
+
+You can use the provided [Rector](https://github.com/rectorphp/rector) config file to automate the work.
+
+Run
+
+```bash
+$ composer require --dev rector/rector
+```
+
+to install `rector/rector`.
+
+Run
+
+```bash
+vendor/bin/rector process src/ --config vendor/fakerphp/faker/rector-migrate.php
+```
+
+to run `rector/rector`.
+
+*Note:* do not forget to replace "src/" with the path to your source directory.
+
+Another way is to use it in your `rector.php` file:
+
+```php
+$faker = require 'vendor/fakerphp/faker/rector-migrate.php';
+$faker($rectorConfig);
+```
+
 ## License
 
 Faker is released under the MIT License. See [`LICENSE`](LICENSE) for details.

rector-migrate.php

@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\Transform\Rector\Assign\PropertyFetchToMethodCallRector;
+use Rector\Transform\ValueObject\PropertyFetchToMethodCall;
+
+// This file configures rector/rector to replace all deprecated property usages with their equivalent functions.
+return static function (RectorConfig $rectorConfig): void {
+    $properties = [
+        'boolean',
+        'city',
+        'dateTime',
+        'dateTimeThisYear',
+        'email',
+        'firstName',
+        'firstNameFemale',
+        'lastName',
+        'name',
+        'password',
+        'phoneNumber',
+        'sentence',
+        'sha256',
+        'slug',
+        'text',
+        'url',
+        'word',
+        'words',
+    ];
+
+    $methodCalls = [];
+    foreach ($properties as $property) {
+        $methodCalls[] = new PropertyFetchToMethodCall(Generator::class, $property, $property);
+    }
+
+    $rectorConfig->ruleWithConfiguration(
+        PropertyFetchToMethodCallRector::class,
+        $methodCalls
+    );
+};