Rector Basic Setup

Rafael Fernandes — Wed, 10 Sep 2025 18:08:36 GMT

Current Revision posted to Dev Tutorials by Rafael Fernandes on 9/10/2025 6:08:36 PM

Refactoring your code required a very basic setup to make your life easier to track what Rector does to your code (if you use its auto-fix mode).

Basic setup means installing software you will need such as Rector and Git. Git will help us to keep track of changes in your Sugar instance folder after we initialize it.

Keep that info in mind if you are planing to use a pre-existing instance for this work, it will add a lot of extra files to it.

Step by Step

Download a build of SugarCRM. Please use the one that is compatible with your MPL.
Install the build locally or use your own Sugar instance if you have one local
If you are using Sugar >= 25.1
- You must use Rector that is shipped with Sugar and located at vendor lib in your Sugar Instance folder. ex: /path/to/sugar/vendor/rector/rector/bin/rector
  - You might need to give +x permissions to execute rector.
    - chmod +x /path/to/sugar/vendor/rector/rector/bin/rector
  - You may still use newer Rector version for your convenience, just make sure you use composer in a different directory (see below) to avoid incompatibilities.

If you are using Sugar < 25

You should leverage composer to install rector and its dependencies.
It is important that you DO NOT install it in the Sugar's directory, if you do you will get errors due to libraries incompatibilities, see Troubleshooting Rector.
You can use the following commands to prepare rector to be used.

# install composer if you dont have it
curl -sS https://getcomposer.org/installer | php
mv composer.phar /usr/local/bin/composer

# create a temp rector folder
mkdir /tmp/rector
cd /tmp/rector

# let composer decide which version works on your system
composer require rector/rector --dev

# or specify a specific version (if you need to)
composer require rector/rector:^1.2.3 --dev

Initialize a git repository inside the instance folder: cd /path/to/sugar && git init. It’s just convenient to use git to track the list of files and some other things.
Create /path/to/sugar/.gitignore file to skip the unneeded changes with the following contents:

cache
vendor
portal2
upload
upgrades
*.log
rector.php

Commit the initial repository state

git add . && git commit -am 'init'

You might wanna keep your initial commit hash in case you need to reset

sh-3.2$ git log
commit 0ac2bd9c175f7bff9842dcd8179fc9ec67b7002f (HEAD -> main)
Author: Rafael Fernandes <rafael.fernandes@sugarcrm.com>
Date:   Mon Apr 17 10:40:56 2023 -0400

Initialize Rector config (rector.php)

If you are using rector 0.15.x or less, you can use the following:

rector-0.15.20/bin/rector init

If you are using newer versions of Rector, you can use:

/path/to/rector/bin/rector

 No "rector.php" config found. Should we generate it for you? [yes]:
 > yes

 [OK] The config is added now. Re-run command to make Rector do the work!

Agree to create a rector.php file with the dummy config. It should generate a template file similar to this:

<?php

declare(strict_types=1);

use Rector\Config\RectorConfig;

return RectorConfig::configure()
    ->withPaths([
        __DIR__ . '/src',
    ])
    // uncomment to reach your current PHP version
    // ->withPhpSets()
    ->withTypeCoverageLevel(0)
    ->withDeadCodeLevel(0)
    ->withCodeQualityLevel(0);

Reset your Repo to start over

You can always start over at your initial Git commit and undo all changes by Rector or yourself after that point.
Take the initial commit hash from git log and reset as follows:

sh-3.2$ git log
commit 0ac2bd9c175f7bff9842dcd8179fc9ec67b7002f (HEAD -> main)
Author: Rafael Fernandes <rafael.fernandes@sugarcrm.com>
Date:   Mon Apr 17 10:40:56 2023 -0400

sh-3.2$ git status
On branch main
Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
        modified:   vCard.php

no changes added to commit (use "git add" and/or "git commit -a")

sh-3.2$ git reset --hard 0ac2bd9c175f7bff9842dcd8179fc9ec67b7002f
HEAD is now at 0ac2bd9c init

sh-3.2$ git clean -fd
Removing custom/Extension/application/Ext/Include/BuildingBlock_HelloWorldDashlet.php
Removing custom/Extension/application/Ext/Include/orderMapping.php
Removing custom/modules/ActivityStream/
Removing custom/modules/Forecasts/Ext/clients/
Removing custom/modules/pmse_Project/

sh-3.2$ git status
On branch main
nothing to commit, working tree clean

You can move on to the Prepare Phase:

Rector Basic Setup

Rafael Fernandes — Wed, 10 Sep 2025 18:06:28 GMT

Revision 21 posted to Dev Tutorials by Rafael Fernandes on 9/10/2025 6:06:28 PM

Refactoring your code required a very basic setup to make your life easier to track what Rector does to your code (if you use its auto-fix mode).

Basic setup means installing software you will need such as Rector and Git. Git will help us to keep track of changes in your Sugar instance folder after we initialize it.

Keep that info in mind if you are planing to use a pre-existing instance for this work, it will add a lot of extra files to it.

Step by Step

Download a build of SugarCRM. Please use the one that is compatible with your MPL.
Install the build locally or use your own Sugar instance if you have one local
If you are using Sugar >= 25.1
- You must use Rector that is shipped with Sugar and located at vendor lib in your Sugar Instance folder. ex: /path/to/sugar/vendor/rector/rector/bin/rector
  - You might need to give +x permissions to execute rector.
    - chmod +x /path/to/sugar/vendor/rector/rector/bin/rector
  - You may still download newer versions of Rector from its release repository, however, you'd need to follow their installation instructions

If you are using Sugar < 25

You should leverage composer to install rector and its dependencies.
It is important that you DO NOT install it in the Sugar's directory, if you do you will get errors due to libraries incompatibilities, see Troubleshooting Rector.
You can use the following commands to prepare rector to be used.

# install composer if you dont have it
curl -sS https://getcomposer.org/installer | php
mv composer.phar /usr/local/bin/composer

# create a temp rector folder
mkdir /tmp/rector
cd /tmp/rector

# let composer decide which version works on your system
composer require rector/rector --dev

# or specify a specific version (if you need to)
composer require rector/rector:^1.2.3 --dev

Initialize a git repository inside the instance folder: cd /path/to/sugar && git init. It’s just convenient to use git to track the list of files and some other things.
Create /path/to/sugar/.gitignore file to skip the unneeded changes with the following contents:

cache
vendor
portal2
upload
upgrades
*.log
rector.php

Commit the initial repository state

git add . && git commit -am 'init'

You might wanna keep your initial commit hash in case you need to reset

sh-3.2$ git log
commit 0ac2bd9c175f7bff9842dcd8179fc9ec67b7002f (HEAD -> main)
Author: Rafael Fernandes <rafael.fernandes@sugarcrm.com>
Date:   Mon Apr 17 10:40:56 2023 -0400

Initialize Rector config (rector.php)

If you are using rector 0.15.x or less, you can use the following:

rector-0.15.20/bin/rector init

If you are using newer versions of Rector, you can use:

/path/to/rector/bin/rector

 No "rector.php" config found. Should we generate it for you? [yes]:
 > yes


 [OK] The config is added now. Re-run command to make Rector do the work!

Agree to create a rector.php file with the dummy config. It should generate a template file similar to this:

<?php

declare(strict_types=1);

use Rector\Config\RectorConfig;

return RectorConfig::configure()
    ->withPaths([
        __DIR__ . '/src',
    ])
    // uncomment to reach your current PHP version
    // ->withPhpSets()
    ->withTypeCoverageLevel(0)
    ->withDeadCodeLevel(0)
    ->withCodeQualityLevel(0);

Reset your Repo to start over

You can always start over at your initial Git commit and undo all changes by Rector or yourself after that point.
Take the initial commit hash from git log and reset as follows:

sh-3.2$ git log
commit 0ac2bd9c175f7bff9842dcd8179fc9ec67b7002f (HEAD -> main)
Author: Rafael Fernandes <rafael.fernandes@sugarcrm.com>
Date:   Mon Apr 17 10:40:56 2023 -0400

sh-3.2$ git status
On branch main
Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
        modified:   vCard.php

no changes added to commit (use "git add" and/or "git commit -a")

sh-3.2$ git reset --hard 0ac2bd9c175f7bff9842dcd8179fc9ec67b7002f
HEAD is now at 0ac2bd9c init

sh-3.2$ git clean -fd
Removing custom/Extension/application/Ext/Include/BuildingBlock_HelloWorldDashlet.php
Removing custom/Extension/application/Ext/Include/orderMapping.php
Removing custom/modules/ActivityStream/
Removing custom/modules/Forecasts/Ext/clients/
Removing custom/modules/pmse_Project/

sh-3.2$ git status
On branch main
nothing to commit, working tree clean

You can move on to the Prepare Phase:

Rector Basic Setup

Rafael Fernandes — Mon, 17 Mar 2025 12:51:24 GMT

Revision 20 posted to Dev Tutorials by Rafael Fernandes on 3/17/2025 12:51:24 PM

Refactoring your code required a very basic setup to make your life easier to track what Rector does to your code (if you use its auto-fix mode).

Basic setup means installing software you will need such as Rector and Git. Git will help us to keep track of changes in your Sugar instance folder after we initialize it.

Keep that info in mind if you are planing to use a pre-existing instance for this work, it will add a lot of extra files to it.

Step by Step

Download a build of SugarCRM. Please use the one that is compatible with your MPL.
Install the build locally or use your own Sugar instance if you have one local
If you are using Sugar >= 25.1
- You must use Rector that is shipped with Sugar and located at vendor lib in your Sugar Instance folder. ex: /path/to/sugar/vendor/rector/rector/bin/rector
  - You might need to give +x permissions to execute rector.
    - chmod +x /path/to/sugar/vendor/rector/rector/bin/rector
  - You may still download newer versions of Rector from its release repository, however, you'd need to follow their installation instructions
If you are using Sugar < 25
- Download the this rector release and unzip it into the Sugar instance folder. ex: /path/to/sugar/rector-0.18.1
  - Rector team might add or remove classes that we utilize on our scans
  - Latest we are using is 0.18.1, later than that might not work.
Initialize a git repository inside the instance folder: cd /path/to/sugar && git init. It’s just convenient to use git to track the list of files and some other things.
Create /path/to/sugar/.gitignore file to skip the unneeded changes with the following contents:

cache
vendor
portal2
upload
upgrades
*.log
rector.php

Commit the initial repository state

git add . && git commit -am 'init'

You might wanna keep your initial commit hash in case you need to reset

sh-3.2$ git log
commit 0ac2bd9c175f7bff9842dcd8179fc9ec67b7002f (HEAD -> main)
Author: Rafael Fernandes <rafael.fernandes@sugarcrm.com>
Date:   Mon Apr 17 10:40:56 2023 -0400

Initialize Rector config (rector.php)

If you are using rector 0.15.x or less, you can use the following:

cd /path/to/sugar && rector-0.15.20/bin/rector init

If you are using 0.16.x or higher, you can use:

cd /path/to/sugar && /path/to/rector/bin/rector

 No "rector.php" config found. Should we generate it for you? [yes]:
 > yes


 [OK] The config is added now. Re-run command to make Rector do the work!

Agree to create a rector.php file with the dummy config. It should generate a template file similar to this:

<?php

declare(strict_types=1);

use Rector\CodeQuality\Rector\Class_\InlineConstructorDefaultToPropertyRector;
use Rector\Config\RectorConfig;
use Rector\Set\ValueObject\LevelSetList;
use Rector\Set\ValueObject\SetList;

return static function (RectorConfig $rectorConfig): void {
    $rectorConfig->paths([
        __DIR__ . '/Ext',
        //... more subdirs here
        __DIR__ . '/upgrades',
    ]);

    // register a single rule
    $rectorConfig->rule(InlineConstructorDefaultToPropertyRector::class);

    // define sets of rules
    //    $rectorConfig->sets([
    //        LevelSetList::UP_TO_PHP_74
    //    ]);
};

Reset your Repo to start over

You can always start over at your initial Git commit and undo all changes by Rector or yourself after that point.
Take the initial commit hash from git log and reset as follows:

sh-3.2$ git log
commit 0ac2bd9c175f7bff9842dcd8179fc9ec67b7002f (HEAD -> main)
Author: Rafael Fernandes <rafael.fernandes@sugarcrm.com>
Date:   Mon Apr 17 10:40:56 2023 -0400

sh-3.2$ git status
On branch main
Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
        modified:   vCard.php

no changes added to commit (use "git add" and/or "git commit -a")

sh-3.2$ git reset --hard 0ac2bd9c175f7bff9842dcd8179fc9ec67b7002f
HEAD is now at 0ac2bd9c init

sh-3.2$ git clean -fd
Removing custom/Extension/application/Ext/Include/BuildingBlock_HelloWorldDashlet.php
Removing custom/Extension/application/Ext/Include/orderMapping.php
Removing custom/modules/ActivityStream/
Removing custom/modules/Forecasts/Ext/clients/
Removing custom/modules/pmse_Project/

sh-3.2$ git status
On branch main
nothing to commit, working tree clean

You can move on to the Prepare Phase:

Rector Basic Setup

Rafael Fernandes — Thu, 13 Mar 2025 19:20:26 GMT

Revision 19 posted to Dev Tutorials by Rafael Fernandes on 3/13/2025 7:20:26 PM

Refactoring your code required a very basic setup to make your life easier to track what Rector does to your code (if you use its auto-fix mode).

Basic setup means installing software you will need such as Rector and Git. Git will help us to keep track of changes in your Sugar instance folder after we initialize it.

Keep that info in mind if you are planing to use a pre-existing instance for this work, it will add a lot of extra files to it.

Step by Step

Download a build of SugarCRM. Please use the one that is compatible with your MPL.
Install the build locally or use your own Sugar instance if you have one local
If you are using PHP >= 8.3
- Download the this rector release and unzip it into the Sugar instance folder. ex: /path/to/sugar/rector-1.2.3
  - Rector team might add or remove classes that we utilize on our scans
  - Latest we are using is 1.2.3 for PHP 8.3, later than that might not work.
If you are using PHP < 8.3
- Download the this rector release and unzip it into the Sugar instance folder. ex: /path/to/sugar/rector-0.18.1
  - Rector team might add or remove classes that we utilize on our scans
  - Latest we are using is 0.18.1, later than that might not work.
Initialize a git repository inside the instance folder: cd /path/to/sugar && git init. It’s just convenient to use git to track the list of files and some other things.
Create /path/to/sugar/.gitignore file to skip the unneeded changes with the following contents:

cache
vendor
portal2
upload
upgrades
*.log
rector.php

Commit the initial repository state

git add . && git commit -am 'init'

You might wanna keep your initial commit hash in case you need to reset

sh-3.2$ git log
commit 0ac2bd9c175f7bff9842dcd8179fc9ec67b7002f (HEAD -> main)
Author: Rafael Fernandes <rafael.fernandes@sugarcrm.com>
Date:   Mon Apr 17 10:40:56 2023 -0400

Initialize Rector config (rector.php)

If you are using 0.15.x or less, you can use the following:

cd /path/to/sugar && rector-0.15.20/bin/rector init

If you are using 0.16.x or higher, you can use:

cd /path/to/sugar && rector-0.18.1/bin/rector

 No "rector.php" config found. Should we generate it for you? [yes]:
 > yes


 [OK] The config is added now. Re-run command to make Rector do the work!

Agree to create a rector.php file with the dummy config. It should generate a template file similar to this:

<?php

declare(strict_types=1);

use Rector\CodeQuality\Rector\Class_\InlineConstructorDefaultToPropertyRector;
use Rector\Config\RectorConfig;
use Rector\Set\ValueObject\LevelSetList;
use Rector\Set\ValueObject\SetList;

return static function (RectorConfig $rectorConfig): void {
    $rectorConfig->paths([
        __DIR__ . '/Ext',
        //... more subdirs here
        __DIR__ . '/upgrades',
    ]);

    // register a single rule
    $rectorConfig->rule(InlineConstructorDefaultToPropertyRector::class);

    // define sets of rules
    //    $rectorConfig->sets([
    //        LevelSetList::UP_TO_PHP_74
    //    ]);
};

Reset your Repo to start over

You can always start over at your initial Git commit and undo all changes by Rector or yourself after that point.
Take the initial commit hash from git log and reset as follows:

sh-3.2$ git log
commit 0ac2bd9c175f7bff9842dcd8179fc9ec67b7002f (HEAD -> main)
Author: Rafael Fernandes <rafael.fernandes@sugarcrm.com>
Date:   Mon Apr 17 10:40:56 2023 -0400

sh-3.2$ git status
On branch main
Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
        modified:   vCard.php

no changes added to commit (use "git add" and/or "git commit -a")

sh-3.2$ git reset --hard 0ac2bd9c175f7bff9842dcd8179fc9ec67b7002f
HEAD is now at 0ac2bd9c init

sh-3.2$ git clean -fd
Removing custom/Extension/application/Ext/Include/BuildingBlock_HelloWorldDashlet.php
Removing custom/Extension/application/Ext/Include/orderMapping.php
Removing custom/modules/ActivityStream/
Removing custom/modules/Forecasts/Ext/clients/
Removing custom/modules/pmse_Project/

sh-3.2$ git status
On branch main
nothing to commit, working tree clean

You can move on to the Prepare Phase:

Rector Basic Setup

Rafael Fernandes — Thu, 26 Oct 2023 17:44:41 GMT

Revision 18 posted to Dev Tutorials by Rafael Fernandes on 10/26/2023 5:44:41 PM

Refactoring your code required a very basic setup to make your life easier to track what Rector does to your code (if you use its auto-fix mode).

Basic setup means installing software you will need such as Rector and Git. Git will help us to keep track of changes in your Sugar instance folder after we initialize it.

Keep that info in mind if you are planing to use a pre-existing instance for this work, it will add a lot of extra files to it.

Step by Step

Download a build of SugarCRM. Please use the one that is compatible with your MPL.
Install the build locally or use your own Sugar instance if you have one local
Download the latest rector release and unzip it into the Sugar instance folder. ex: /path/to/sugar/rector-0.18.1
- Rector team might add or remove classes that we utilize on our scans
- Latest we are using is 0.18.1, later than that might not work.
Initialize a git repository inside the instance folder: cd /path/to/sugar && git init. It’s just convenient to use git to track the list of files and some other things.
Create /path/to/sugar/.gitignore file to skip the unneeded changes with the following contents:

cache
vendor
portal2
upload
upgrades
*.log
rector.php

Commit the initial repository state

git add . && git commit -am 'init'

You might wanna keep your initial commit hash in case you need to reset

sh-3.2$ git log
commit 0ac2bd9c175f7bff9842dcd8179fc9ec67b7002f (HEAD -> main)
Author: Rafael Fernandes <rafael.fernandes@sugarcrm.com>
Date:   Mon Apr 17 10:40:56 2023 -0400

Initialize Rector config (rector.php)

If you are using 0.15.x or less, you can use the following:

cd /path/to/sugar && rector-0.15.20/bin/rector init

If you are using 0.16.x or higher, you can use:

cd /path/to/sugar && rector-0.18.1/bin/rector

 No "rector.php" config found. Should we generate it for you? [yes]:
 > yes


 [OK] The config is added now. Re-run command to make Rector do the work!

Agree to create a rector.php file with the dummy config. It should generate a template file similar to this:

<?php

declare(strict_types=1);

use Rector\CodeQuality\Rector\Class_\InlineConstructorDefaultToPropertyRector;
use Rector\Config\RectorConfig;
use Rector\Set\ValueObject\LevelSetList;
use Rector\Set\ValueObject\SetList;

return static function (RectorConfig $rectorConfig): void {
    $rectorConfig->paths([
        __DIR__ . '/Ext',
        //... more subdirs here
        __DIR__ . '/upgrades',
    ]);

    // register a single rule
    $rectorConfig->rule(InlineConstructorDefaultToPropertyRector::class);

    // define sets of rules
    //    $rectorConfig->sets([
    //        LevelSetList::UP_TO_PHP_74
    //    ]);
};

Reset your Repo to start over

You can always start over at your initial Git commit and undo all changes by Rector or yourself after that point.
Take the initial commit hash from git log and reset as follows:

sh-3.2$ git log
commit 0ac2bd9c175f7bff9842dcd8179fc9ec67b7002f (HEAD -> main)
Author: Rafael Fernandes <rafael.fernandes@sugarcrm.com>
Date:   Mon Apr 17 10:40:56 2023 -0400

sh-3.2$ git status
On branch main
Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
        modified:   vCard.php

no changes added to commit (use "git add" and/or "git commit -a")

sh-3.2$ git reset --hard 0ac2bd9c175f7bff9842dcd8179fc9ec67b7002f
HEAD is now at 0ac2bd9c init

sh-3.2$ git clean -fd
Removing custom/Extension/application/Ext/Include/BuildingBlock_HelloWorldDashlet.php
Removing custom/Extension/application/Ext/Include/orderMapping.php
Removing custom/modules/ActivityStream/
Removing custom/modules/Forecasts/Ext/clients/
Removing custom/modules/pmse_Project/

sh-3.2$ git status
On branch main
nothing to commit, working tree clean

You can move on to the Prepare Phase:

Rector Basic Setup

Rafael Fernandes — Thu, 31 Aug 2023 15:10:32 GMT

Revision 17 posted to Dev Tutorials by Rafael Fernandes on 8/31/2023 3:10:32 PM

Refactoring your code required a very basic setup to make your life easier to track what Rector does to your code (if you use its auto-fix mode).

Basic setup means installing software you will need such as Rector and Git. Git will help us to keep track of changes in your Sugar instance folder after we initialize it.

Keep that info in mind if you are planing to use a pre-existing instance for this work, it will add a lot of extra files to it.

Step by Step

Download a build of SugarCRM. Please use the one that is compatible with your MPL.
Install the build locally or use your own Sugar instance if you have one local
Download the latest rector release and unzip it into the Sugar instance folder. ex: /path/to/sugar/rector-0.15.20
Initialize a git repository inside the instance folder: cd /path/to/sugar && git init. It’s just convenient to use git to track the list of files and some other things.
Create /path/to/sugar/.gitignore file to skip the unneeded changes with the following contents:

cache
vendor
portal2
upload
upgrades
*.log
rector.php

Commit the initial repository state

git add . && git commit -am 'init'

You might wanna keep your initial commit hash in case you need to reset

sh-3.2$ git log
commit 0ac2bd9c175f7bff9842dcd8179fc9ec67b7002f (HEAD -> main)
Author: Rafael Fernandes <rafael.fernandes@sugarcrm.com>
Date:   Mon Apr 17 10:40:56 2023 -0400

Initialize Rector config (rector.php)

If you are using 0.15.x or less, you can use the following:

cd /path/to/sugar && rector-0.15.20/bin/rector init

If you are using 0.16.x or higher, you can use:

cd /path/to/sugar && rector-0.18.1/bin/rector

 No "rector.php" config found. Should we generate it for you? [yes]:
 > yes


 [OK] The config is added now. Re-run command to make Rector do the work!

Agree to create a rector.php file with the dummy config. It should generate a template file similar to this:

<?php

declare(strict_types=1);

use Rector\CodeQuality\Rector\Class_\InlineConstructorDefaultToPropertyRector;
use Rector\Config\RectorConfig;
use Rector\Set\ValueObject\LevelSetList;
use Rector\Set\ValueObject\SetList;

return static function (RectorConfig $rectorConfig): void {
    $rectorConfig->paths([
        __DIR__ . '/Ext',
        //... more subdirs here
        __DIR__ . '/upgrades',
    ]);

    // register a single rule
    $rectorConfig->rule(InlineConstructorDefaultToPropertyRector::class);

    // define sets of rules
    //    $rectorConfig->sets([
    //        LevelSetList::UP_TO_PHP_74
    //    ]);
};

Reset your Repo to start over

You can always start over at your initial Git commit and undo all changes by Rector or yourself after that point.
Take the initial commit hash from git log and reset as follows:

sh-3.2$ git log
commit 0ac2bd9c175f7bff9842dcd8179fc9ec67b7002f (HEAD -> main)
Author: Rafael Fernandes <rafael.fernandes@sugarcrm.com>
Date:   Mon Apr 17 10:40:56 2023 -0400

sh-3.2$ git status
On branch main
Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
        modified:   vCard.php

no changes added to commit (use "git add" and/or "git commit -a")

sh-3.2$ git reset --hard 0ac2bd9c175f7bff9842dcd8179fc9ec67b7002f
HEAD is now at 0ac2bd9c init

sh-3.2$ git clean -fd
Removing custom/Extension/application/Ext/Include/BuildingBlock_HelloWorldDashlet.php
Removing custom/Extension/application/Ext/Include/orderMapping.php
Removing custom/modules/ActivityStream/
Removing custom/modules/Forecasts/Ext/clients/
Removing custom/modules/pmse_Project/

sh-3.2$ git status
On branch main
nothing to commit, working tree clean

You can move on to the Prepare Phase:

Rector Basic Setup

Rafael Fernandes — Thu, 31 Aug 2023 15:10:07 GMT

Revision 16 posted to Dev Tutorials by Rafael Fernandes on 8/31/2023 3:10:07 PM

Refactoring your code required a very basic setup to make your life easier to track what Rector does to your code (if you use its auto-fix mode).

Basic setup means installing software you will need such as Rector and Git. Git will help us to keep track of changes in your Sugar instance folder after we initialize it.

Keep that info in mind if you are planing to use a pre-existing instance for this work, it will add a lot of extra files to it.

Step by Step

Download a build of SugarCRM. Please use the one that is compatible with your MPL.
Install the build locally or use your own Sugar instance if you have one local
Download the latest rector release and unzip it into the Sugar instance folder. ex: /path/to/sugar/rector-0.15.20
Initialize a git repository inside the instance folder: cd /path/to/sugar && git init. It’s just convenient to use git to track the list of files and some other things.
Create /path/to/sugar/.gitignore file to skip the unneeded changes with the following contents:

cache
vendor
portal2
upload
upgrades
*.log
rector.php

Commit the initial repository state

git add . && git commit -am 'init'

You might wanna keep your initial commit hash in case you need to reset

sh-3.2$ git log
commit 0ac2bd9c175f7bff9842dcd8179fc9ec67b7002f (HEAD -> main)
Author: Rafael Fernandes <rafael.fernandes@sugarcrm.com>
Date:   Mon Apr 17 10:40:56 2023 -0400

Initialize Rector config (rector.php)

If you are using 0.15.x or less, you can use the following:

cd /path/to/sugar && rector-0.15.20/bin/rector init

If you are using 0.16.x or higher, you can use:

cd /path/to/sugar && rector-0.18.24/bin/rector

 No "rector.php" config found. Should we generate it for you? [yes]:
 > yes


 [OK] The config is added now. Re-run command to make Rector do the work!

Agree to create a rector.php file with the dummy config. It should generate a template file similar to this:

<?php

declare(strict_types=1);

use Rector\CodeQuality\Rector\Class_\InlineConstructorDefaultToPropertyRector;
use Rector\Config\RectorConfig;
use Rector\Set\ValueObject\LevelSetList;
use Rector\Set\ValueObject\SetList;

return static function (RectorConfig $rectorConfig): void {
    $rectorConfig->paths([
        __DIR__ . '/Ext',
        //... more subdirs here
        __DIR__ . '/upgrades',
    ]);

    // register a single rule
    $rectorConfig->rule(InlineConstructorDefaultToPropertyRector::class);

    // define sets of rules
    //    $rectorConfig->sets([
    //        LevelSetList::UP_TO_PHP_74
    //    ]);
};

Reset your Repo to start over

You can always start over at your initial Git commit and undo all changes by Rector or yourself after that point.
Take the initial commit hash from git log and reset as follows:

sh-3.2$ git log
commit 0ac2bd9c175f7bff9842dcd8179fc9ec67b7002f (HEAD -> main)
Author: Rafael Fernandes <rafael.fernandes@sugarcrm.com>
Date:   Mon Apr 17 10:40:56 2023 -0400

sh-3.2$ git status
On branch main
Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
        modified:   vCard.php

no changes added to commit (use "git add" and/or "git commit -a")

sh-3.2$ git reset --hard 0ac2bd9c175f7bff9842dcd8179fc9ec67b7002f
HEAD is now at 0ac2bd9c init

sh-3.2$ git clean -fd
Removing custom/Extension/application/Ext/Include/BuildingBlock_HelloWorldDashlet.php
Removing custom/Extension/application/Ext/Include/orderMapping.php
Removing custom/modules/ActivityStream/
Removing custom/modules/Forecasts/Ext/clients/
Removing custom/modules/pmse_Project/

sh-3.2$ git status
On branch main
nothing to commit, working tree clean

You can move on to the Prepare Phase:

Rector Basic Setup

Rafael Fernandes — Thu, 31 Aug 2023 15:09:15 GMT

Revision 15 posted to Dev Tutorials by Rafael Fernandes on 8/31/2023 3:09:15 PM

Refactoring your code required a very basic setup to make your life easier to track what Rector does to your code (if you use its auto-fix mode).

Basic setup means installing software you will need such as Rector and Git. Git will help us to keep track of changes in your Sugar instance folder after we initialize it.

Keep that info in mind if you are planing to use a pre-existing instance for this work, it will add a lot of extra files to it.

Step by Step

Download a build of SugarCRM. Please use the one that is compatible with your MPL.
Install the build locally or use your own Sugar instance if you have one local
Download the latest rector release and unzip it into the Sugar instance folder. ex: /path/to/sugar/rector-0.15.20
Initialize a git repository inside the instance folder: cd /path/to/sugar && git init. It’s just convenient to use git to track the list of files and some other things.
Create /path/to/sugar/.gitignore file to skip the unneeded changes with the following contents:

cache
vendor
portal2
upload
upgrades
*.log
rector.php

Commit the initial repository state

git add . && git commit -am 'init'

You might wanna keep your initial commit hash in case you need to reset

sh-3.2$ git log
commit 0ac2bd9c175f7bff9842dcd8179fc9ec67b7002f (HEAD -> main)
Author: Rafael Fernandes <rafael.fernandes@sugarcrm.com>
Date:   Mon Apr 17 10:40:56 2023 -0400

Initialize Rector config (rector.php)

If you are using 0.15.x or less, you can use the following:

cd /path/to/sugar && rector-0.15.20/bin/rector init

If you are using 0.16.x or higher, you can use:

vendor/bin/rector

 No "rector.php" config found. Should we generate it for you? [yes]:
 > yes


 [OK] The config is added now. Re-run command to make Rector do the work!

Agree to create a rector.php file with the dummy config. It should generate a template file similar to this:

<?php

declare(strict_types=1);

use Rector\CodeQuality\Rector\Class_\InlineConstructorDefaultToPropertyRector;
use Rector\Config\RectorConfig;
use Rector\Set\ValueObject\LevelSetList;
use Rector\Set\ValueObject\SetList;

return static function (RectorConfig $rectorConfig): void {
    $rectorConfig->paths([
        __DIR__ . '/Ext',
        //... more subdirs here
        __DIR__ . '/upgrades',
    ]);

    // register a single rule
    $rectorConfig->rule(InlineConstructorDefaultToPropertyRector::class);

    // define sets of rules
    //    $rectorConfig->sets([
    //        LevelSetList::UP_TO_PHP_74
    //    ]);
};

Reset your Repo to start over

You can always start over at your initial Git commit and undo all changes by Rector or yourself after that point.
Take the initial commit hash from git log and reset as follows:

sh-3.2$ git log
commit 0ac2bd9c175f7bff9842dcd8179fc9ec67b7002f (HEAD -> main)
Author: Rafael Fernandes <rafael.fernandes@sugarcrm.com>
Date:   Mon Apr 17 10:40:56 2023 -0400

sh-3.2$ git status
On branch main
Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
        modified:   vCard.php

no changes added to commit (use "git add" and/or "git commit -a")

sh-3.2$ git reset --hard 0ac2bd9c175f7bff9842dcd8179fc9ec67b7002f
HEAD is now at 0ac2bd9c init

sh-3.2$ git clean -fd
Removing custom/Extension/application/Ext/Include/BuildingBlock_HelloWorldDashlet.php
Removing custom/Extension/application/Ext/Include/orderMapping.php
Removing custom/modules/ActivityStream/
Removing custom/modules/Forecasts/Ext/clients/
Removing custom/modules/pmse_Project/

sh-3.2$ git status
On branch main
nothing to commit, working tree clean

You can move on to the Prepare Phase:

Rector Basic Setup

Rafael Fernandes — Thu, 31 Aug 2023 15:09:00 GMT

Revision 14 posted to Dev Tutorials by Rafael Fernandes on 8/31/2023 3:09:00 PM

Refactoring your code required a very basic setup to make your life easier to track what Rector does to your code (if you use its auto-fix mode).

Basic setup means installing software you will need such as Rector and Git. Git will help us to keep track of changes in your Sugar instance folder after we initialize it.

Keep that info in mind if you are planing to use a pre-existing instance for this work, it will add a lot of extra files to it.

Step by Step

Download a build of SugarCRM. Please use the one that is compatible with your MPL.
Install the build locally or use your own Sugar instance if you have one local
Download the latest rector release and unzip it into the Sugar instance folder. ex: /path/to/sugar/rector-0.15.20
Initialize a git repository inside the instance folder: cd /path/to/sugar && git init. It’s just convenient to use git to track the list of files and some other things.
Create /path/to/sugar/.gitignore file to skip the unneeded changes with the following contents:

cache
vendor
portal2
upload
upgrades
*.log
rector.php

Commit the initial repository state

git add . && git commit -am 'init'

You might wanna keep your initial commit hash in case you need to reset

sh-3.2$ git log
commit 0ac2bd9c175f7bff9842dcd8179fc9ec67b7002f (HEAD -> main)
Author: Rafael Fernandes <rafael.fernandes@sugarcrm.com>
Date:   Mon Apr 17 10:40:56 2023 -0400

Initialize Rector config (rector.php)

If you are using 0.15.x or less, you can use init.

If you are using 0.15.x or less, you can use the following:

cd /path/to/sugar && rector-0.15.20/bin/rector init

If you are using 0.16.x or higher, you can use:

vendor/bin/rector

 No "rector.php" config found. Should we generate it for you? [yes]:
 > yes


 [OK] The config is added now. Re-run command to make Rector do the work!

Agree to create a rector.php file with the dummy config. It should generate a template file similar to this:

<?php

declare(strict_types=1);

use Rector\CodeQuality\Rector\Class_\InlineConstructorDefaultToPropertyRector;
use Rector\Config\RectorConfig;
use Rector\Set\ValueObject\LevelSetList;
use Rector\Set\ValueObject\SetList;

return static function (RectorConfig $rectorConfig): void {
    $rectorConfig->paths([
        __DIR__ . '/Ext',
        //... more subdirs here
        __DIR__ . '/upgrades',
    ]);

    // register a single rule
    $rectorConfig->rule(InlineConstructorDefaultToPropertyRector::class);

    // define sets of rules
    //    $rectorConfig->sets([
    //        LevelSetList::UP_TO_PHP_74
    //    ]);
};

Reset your Repo to start over

You can always start over at your initial Git commit and undo all changes by Rector or yourself after that point.
Take the initial commit hash from git log and reset as follows:

sh-3.2$ git log
commit 0ac2bd9c175f7bff9842dcd8179fc9ec67b7002f (HEAD -> main)
Author: Rafael Fernandes <rafael.fernandes@sugarcrm.com>
Date:   Mon Apr 17 10:40:56 2023 -0400

sh-3.2$ git status
On branch main
Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
        modified:   vCard.php

no changes added to commit (use "git add" and/or "git commit -a")

sh-3.2$ git reset --hard 0ac2bd9c175f7bff9842dcd8179fc9ec67b7002f
HEAD is now at 0ac2bd9c init

sh-3.2$ git clean -fd
Removing custom/Extension/application/Ext/Include/BuildingBlock_HelloWorldDashlet.php
Removing custom/Extension/application/Ext/Include/orderMapping.php
Removing custom/modules/ActivityStream/
Removing custom/modules/Forecasts/Ext/clients/
Removing custom/modules/pmse_Project/

sh-3.2$ git status
On branch main
nothing to commit, working tree clean

You can move on to the Prepare Phase:

Rector Basic Setup

Rafael Fernandes — Thu, 31 Aug 2023 15:08:37 GMT

Revision 13 posted to Dev Tutorials by Rafael Fernandes on 8/31/2023 3:08:37 PM

Refactoring your code required a very basic setup to make your life easier to track what Rector does to your code (if you use its auto-fix mode).

Basic setup means installing software you will need such as Rector and Git. Git will help us to keep track of changes in your Sugar instance folder after we initialize it.

Keep that info in mind if you are planing to use a pre-existing instance for this work, it will add a lot of extra files to it.

Step by Step

Download a build of SugarCRM. Please use the one that is compatible with your MPL.
Install the build locally or use your own Sugar instance if you have one local
Download the latest rector release and unzip it into the Sugar instance folder. ex: /path/to/sugar/rector-0.15.20
Initialize a git repository inside the instance folder: cd /path/to/sugar && git init. It’s just convenient to use git to track the list of files and some other things.
Create /path/to/sugar/.gitignore file to skip the unneeded changes with the following contents:

cache
vendor
portal2
upload
upgrades
*.log
rector.php

Commit the initial repository state

git add . && git commit -am 'init'

You might wanna keep your initial commit hash in case you need to reset

sh-3.2$ git log
commit 0ac2bd9c175f7bff9842dcd8179fc9ec67b7002f (HEAD -> main)
Author: Rafael Fernandes <rafael.fernandes@sugarcrm.com>
Date:   Mon Apr 17 10:40:56 2023 -0400

Initialize Rector config (rector.php)

If you are using 0.15.x or less, you can use init.

If you are using 0.15.x or less, you can use the following:

cd /path/to/sugar && rector-0.15.20/bin/rector init

If you are using 0.16.x or higher, you can use:

vendor/bin/rector

 No "rector.php" config found. Should we generate it for you? [yes]:
 > yes


 [OK] The config is added now. Re-run command to make Rector do the work!

Agree to create a rector.php file with the dummy config. It should generate a template file similar to this:

<?php

declare(strict_types=1);

use Rector\CodeQuality\Rector\Class_\InlineConstructorDefaultToPropertyRector;
use Rector\Config\RectorConfig;
use Rector\Set\ValueObject\LevelSetList;
use Rector\Set\ValueObject\SetList;

return static function (RectorConfig $rectorConfig): void {
    $rectorConfig->paths([
        __DIR__ . '/Ext',
        //... more subdirs here
        __DIR__ . '/upgrades',
    ]);

    // register a single rule
    $rectorConfig->rule(InlineConstructorDefaultToPropertyRector::class);

    // define sets of rules
    //    $rectorConfig->sets([
    //        LevelSetList::UP_TO_PHP_74
    //    ]);
};

Reset your Repo to start over

You can always start over at your initial Git commit and undo all changes by Rector or yourself after that point.
Take the initial commit hash from git log and reset as follows:

sh-3.2$ git log
commit 0ac2bd9c175f7bff9842dcd8179fc9ec67b7002f (HEAD -> main)
Author: Rafael Fernandes <rafael.fernandes@sugarcrm.com>
Date:   Mon Apr 17 10:40:56 2023 -0400

sh-3.2$ git status
On branch main
Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
        modified:   vCard.php

no changes added to commit (use "git add" and/or "git commit -a")

sh-3.2$ git reset --hard 0ac2bd9c175f7bff9842dcd8179fc9ec67b7002f
HEAD is now at 0ac2bd9c init

sh-3.2$ git clean -fd
Removing custom/Extension/application/Ext/Include/BuildingBlock_HelloWorldDashlet.php
Removing custom/Extension/application/Ext/Include/orderMapping.php
Removing custom/modules/ActivityStream/
Removing custom/modules/Forecasts/Ext/clients/
Removing custom/modules/pmse_Project/

sh-3.2$ git status
On branch main
nothing to commit, working tree clean

You can move on to the Prepare Phase:

Rector Basic Setup

Rafael Fernandes — Tue, 11 Jul 2023 19:41:12 GMT

Revision 12 posted to Dev Tutorials by Rafael Fernandes on 7/11/2023 7:41:12 PM

Refactoring your code required a very basic setup to make your life easier to track what Rector does to your code (if you use its auto-fix mode).

Basic setup means installing software you will need such as Rector and Git. Git will help us to keep track of changes in your Sugar instance folder after we initialize it.

Keep that info in mind if you are planing to use a pre-existing instance for this work, it will add a lot of extra files to it.

Step by Step

Download a build of SugarCRM. Please use the one that is compatible with your MPL.
Install the build locally or use your own Sugar instance if you have one local
Download the latest rector release and unzip it into the Sugar instance folder. ex: /path/to/sugar/rector-0.15.20

Initialize a git repository inside the instance folder: cd /path/to/sugar && git init. It’s just convenient to use git to track the list of files and some other things.
Create /path/to/sugar/.gitignore file to skip the unneeded changes with the following contents:

cache
vendor
portal2
upload
upgrades
*.log
rector.php

Commit the initial repository state

git add . && git commit -am 'init'

You might wanna keep your initial commit hash in case you need to reset

sh-3.2$ git log
commit 0ac2bd9c175f7bff9842dcd8179fc9ec67b7002f (HEAD -> main)
Author: Rafael Fernandes <rafael.fernandes@sugarcrm.com>
Date:   Mon Apr 17 10:40:56 2023 -0400

Initialize rector config:

cd /path/to/sugar && rector-0.15.20/bin/rector init

Agree to create a rector.php file with the dummy config. It should generate a template file similar to this:

<?php

declare(strict_types=1);

use Rector\CodeQuality\Rector\Class_\InlineConstructorDefaultToPropertyRector;
use Rector\Config\RectorConfig;
use Rector\Set\ValueObject\LevelSetList;
use Rector\Set\ValueObject\SetList;

return static function (RectorConfig $rectorConfig): void {
    $rectorConfig->paths([
        __DIR__ . '/Ext',
        //... more subdirs here
        __DIR__ . '/upgrades',
    ]);

    // register a single rule
    $rectorConfig->rule(InlineConstructorDefaultToPropertyRector::class);

    // define sets of rules
    //    $rectorConfig->sets([
    //        LevelSetList::UP_TO_PHP_74
    //    ]);
};

Reset your Repo to start over

You can always start over at your initial Git commit and undo all changes by Rector or yourself after that point.
Take the initial commit hash from git log and reset as follows:

sh-3.2$ git log
commit 0ac2bd9c175f7bff9842dcd8179fc9ec67b7002f (HEAD -> main)
Author: Rafael Fernandes <rafael.fernandes@sugarcrm.com>
Date:   Mon Apr 17 10:40:56 2023 -0400

sh-3.2$ git status
On branch main
Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
        modified:   vCard.php

no changes added to commit (use "git add" and/or "git commit -a")

sh-3.2$ git reset --hard 0ac2bd9c175f7bff9842dcd8179fc9ec67b7002f
HEAD is now at 0ac2bd9c init

sh-3.2$ git clean -fd
Removing custom/Extension/application/Ext/Include/BuildingBlock_HelloWorldDashlet.php
Removing custom/Extension/application/Ext/Include/orderMapping.php
Removing custom/modules/ActivityStream/
Removing custom/modules/Forecasts/Ext/clients/
Removing custom/modules/pmse_Project/

sh-3.2$ git status
On branch main
nothing to commit, working tree clean

You can move on to the Prepare Phase:

Rector Basic Setup

Rafael Fernandes — Tue, 20 Jun 2023 12:57:22 GMT

Revision 11 posted to Dev Tutorials by Rafael Fernandes on 6/20/2023 12:57:22 PM

Refactoring your code required a very basic setup to make your life easier to track what Rector does to your code (if you use its auto-fix mode).

Basic setup means installing software you will need such as Rector and Git. Git will help us to keep track of changes in your Sugar instance folder after we initialize it.

Keep that info in mind if you are planing to use a pre-existing instance for this work, it will add a lot of extra files to it.

Step by Step

Download a build of SugarCRM. Please use the one that is compatible with your MPL.
Install the build locally or use your own Sugar instance if you have one local
Download the latest rector release and unzip it into the Sugar instance folder. ex: /path/to/sugar/rector-0.15.20
Rector needs phpstan tool to run, for that create a new file in the Sugar instance folder called stan.neon. ex: /path/to/sugar/stan.neon

parameters:
	level: 1
	bootstrapFiles:
		- include/entryPoint.php

Initialize a git repository inside the instance folder: cd /path/to/sugar && git init. It’s just convenient to use git to track the list of files and some other things.
Create /path/to/sugar/.gitignore file to skip the unneeded changes with the following contents:

cache
vendor
portal2
upload
upgrades
*.log
rector.php

Commit the initial repository state

git add . && git commit -am 'init'

You might wanna keep your initial commit hash in case you need to reset

sh-3.2$ git log
commit 0ac2bd9c175f7bff9842dcd8179fc9ec67b7002f (HEAD -> main)
Author: Rafael Fernandes <rafael.fernandes@sugarcrm.com>
Date:   Mon Apr 17 10:40:56 2023 -0400

Initialize rector config:

cd /path/to/sugar && rector-0.15.20/bin/rector init

Agree to create a rector.php file with the dummy config. It should generate a template file similar to this:

<?php

declare(strict_types=1);

use Rector\CodeQuality\Rector\Class_\InlineConstructorDefaultToPropertyRector;
use Rector\Config\RectorConfig;
use Rector\Set\ValueObject\LevelSetList;
use Rector\Set\ValueObject\SetList;

return static function (RectorConfig $rectorConfig): void {
    $rectorConfig->paths([
        __DIR__ . '/Ext',
        //... more subdirs here
        __DIR__ . '/upgrades',
    ]);

    // register a single rule
    $rectorConfig->rule(InlineConstructorDefaultToPropertyRector::class);

    // define sets of rules
    //    $rectorConfig->sets([
    //        LevelSetList::UP_TO_PHP_74
    //    ]);
};

Reset your Repo to start over

You can always start over at your initial Git commit and undo all changes by Rector or yourself after that point.
Take the initial commit hash from git log and reset as follows:

sh-3.2$ git log
commit 0ac2bd9c175f7bff9842dcd8179fc9ec67b7002f (HEAD -> main)
Author: Rafael Fernandes <rafael.fernandes@sugarcrm.com>
Date:   Mon Apr 17 10:40:56 2023 -0400

sh-3.2$ git status
On branch main
Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
        modified:   vCard.php

no changes added to commit (use "git add" and/or "git commit -a")

sh-3.2$ git reset --hard 0ac2bd9c175f7bff9842dcd8179fc9ec67b7002f
HEAD is now at 0ac2bd9c init

sh-3.2$ git clean -fd
Removing custom/Extension/application/Ext/Include/BuildingBlock_HelloWorldDashlet.php
Removing custom/Extension/application/Ext/Include/orderMapping.php
Removing custom/modules/ActivityStream/
Removing custom/modules/Forecasts/Ext/clients/
Removing custom/modules/pmse_Project/

sh-3.2$ git status
On branch main
nothing to commit, working tree clean

You can move on to the Prepare Phase:

Rector Basic Setup

Rafael Fernandes — Wed, 19 Apr 2023 19:42:26 GMT

Revision 10 posted to Dev Tutorials by Rafael Fernandes on 4/19/2023 7:42:26 PM

Refactoring your code required a very basic setup to make your life easier to track what Rector does to your code (if you use its auto-fix mode).

Basic setup means installing software you will need such as Rector and Git. Git will help us to keep track of changes in your Sugar instance folder after we initialize it.

Keep that info in mind if you are planing to use a pre-existing instance for this work, it will add a lot of extra files to it.

Step by Step

Download a build of SugarCRM. Please use the one that is compatible with your MPL.
Install the build locally or use your own Sugar instance if you have one local
Download the latest rector release and unzip it into the Sugar instance folder. ex: /path/to/sugar/rector-0.15.20
Rector needs phpstan tool to run, for that create a new file in the Sugar instance folder called stan.neon. ex: /path/to/sugar/stan.neon

parameters:
	level: 1
	bootstrapFiles:
		- include/entryPoint.php

Initialize a git repository inside the instance folder: cd /path/to/sugar && git init. It’s just convenient to use git to track the list of files and some other things.
Create /path/to/sugar/.gitignore file to skip the unneeded changes with the following contents:

cache
vendor
portal2
upload
upgrades
*.log
rector.php

Commit the initial repository state

git add . && git commit -am 'init'

You might wanna keep your initial commit hash in case you need to reset

sh-3.2$ git log
commit 0ac2bd9c175f7bff9842dcd8179fc9ec67b7002f (HEAD -> main)
Author: Rafael Fernandes <rafael.fernandes@sugarcrm.com>
Date:   Mon Apr 17 10:40:56 2023 -0400

Initialize rector config:

cd /path/to/sugar && rector-0.15.20/bin/rector init

Agree to create a rector.php file with the dummy config. It should generate a template file similar to this:

<?php

declare(strict_types=1);

use Rector\CodeQuality\Rector\Class_\InlineConstructorDefaultToPropertyRector;
use Rector\Config\RectorConfig;
use Rector\Set\ValueObject\LevelSetList;

return static function (RectorConfig $rectorConfig): void {
    $rectorConfig->paths([
        __DIR__ . '/Ext',
        //... more subdirs here
        __DIR__ . '/upgrades',
    ]);

    // register a single rule
    $rectorConfig->rule(InlineConstructorDefaultToPropertyRector::class);

    // define sets of rules
    //    $rectorConfig->sets([
    //        LevelSetList::UP_TO_PHP_74
    //    ]);
};

Reset your Repo to start over

You can always start over at your initial Git commit and undo all changes by Rector or yourself after that point.
Take the initial commit hash from git log and reset as follows:

sh-3.2$ git log
commit 0ac2bd9c175f7bff9842dcd8179fc9ec67b7002f (HEAD -> main)
Author: Rafael Fernandes <rafael.fernandes@sugarcrm.com>
Date:   Mon Apr 17 10:40:56 2023 -0400

sh-3.2$ git status
On branch main
Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
        modified:   vCard.php

no changes added to commit (use "git add" and/or "git commit -a")

sh-3.2$ git reset --hard 0ac2bd9c175f7bff9842dcd8179fc9ec67b7002f
HEAD is now at 0ac2bd9c init

sh-3.2$ git clean -fd
Removing custom/Extension/application/Ext/Include/BuildingBlock_HelloWorldDashlet.php
Removing custom/Extension/application/Ext/Include/orderMapping.php
Removing custom/modules/ActivityStream/
Removing custom/modules/Forecasts/Ext/clients/
Removing custom/modules/pmse_Project/

sh-3.2$ git status
On branch main
nothing to commit, working tree clean

You can move on to the Prepare Phase:

Rector Basic Setup

Rafael Fernandes — Wed, 19 Apr 2023 14:29:22 GMT

Revision 9 posted to Dev Tutorials by Rafael Fernandes on 4/19/2023 2:29:22 PM

Refactoring your code required a very basic setup to make your life easier to track what Rector does to your code (if you use its auto-fix mode).

Basic setup means installing software you will need such as Rector and Git. Git will help us to keep track of changes in your Sugar instance folder after we initialize it.

Keep that info in mind if you are planing to use a pre-existing instance for this work, it will add a lot of extra files to it.

Step by Step

Download a build of SugarCRM. Please use the one that is compatible with your MPL.
Install the build locally or use your own Sugar instance if you have one local
Download the latest rector release and unzip it into the Sugar instance folder. ex: /path/to/sugar/rector-0.15.20
Rector needs phpstan tool to run, for that create a new file in the Sugar instance folder called stan.neon. ex: /path/to/sugar/stan.neon

parameters:
	level: 1
	bootstrapFiles:
		- include/entryPoint.php

Initialize a git repository inside the instance folder: cd /path/to/sugar && git init. It’s just convenient to use git to track the list of files and some other things.
Create /path/to/sugar/.gitignore file to skip the unneeded changes with the following contents:

cache
vendor
portal2
upload
upgrades
*.log
rector.php

Commit the initial repository state

git add . && git commit -am 'init'

You might wanna keep your initial commit hash in case you need to reset

sh-3.2$ git log
commit 0ac2bd9c175f7bff9842dcd8179fc9ec67b7002f (HEAD -> main)
Author: Rafael Fernandes <rafael.fernandes@sugarcrm.com>
Date:   Mon Apr 17 10:40:56 2023 -0400

Initialize rector config:

cd /path/to/sugar && rector-0.15.20/bin/rector init

Agree to create a rector.php file with the dummy config. It should generate a template file similar to this:

<?php

declare(strict_types=1);

use Rector\CodeQuality\Rector\Class_\InlineConstructorDefaultToPropertyRector;
use Rector\Config\RectorConfig;
use Rector\Set\ValueObject\LevelSetList;

return static function (RectorConfig $rectorConfig): void {
    $rectorConfig->paths([
        __DIR__ . '/Ext',
        //... more subdirs here
        __DIR__ . '/upgrades',
    ]);

    // register a single rule
    $rectorConfig->rule(InlineConstructorDefaultToPropertyRector::class);

    // define sets of rules
    //    $rectorConfig->sets([
    //        LevelSetList::UP_TO_PHP_74
    //    ]);
};

Reset your Repo to start over

You can always start over at your initial Git commit and undo all changes by Rector or yourself after that point.
Take the initial commit hash from git log and reset as follows:

sh-3.2$ git log
commit 0ac2bd9c175f7bff9842dcd8179fc9ec67b7002f (HEAD -> main)
Author: Rafael Fernandes <rafael.fernandes@sugarcrm.com>
Date:   Mon Apr 17 10:40:56 2023 -0400

sh-3.2$ git status
On branch main
Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
        modified:   vCard.php

no changes added to commit (use "git add" and/or "git commit -a")

sh-3.2$ git reset --hard 0ac2bd9c175f7bff9842dcd8179fc9ec67b7002f
HEAD is now at 0ac2bd9c init

sh-3.2$ git clean -fd
Removing custom/Extension/application/Ext/Include/BuildingBlock_HelloWorldDashlet.php
Removing custom/Extension/application/Ext/Include/orderMapping.php
Removing custom/modules/ActivityStream/
Removing custom/modules/Forecasts/Ext/clients/
Removing custom/modules/pmse_Project/

sh-3.2$ git status
On branch main
nothing to commit, working tree clean

Rector Basic Setup

Rafael Fernandes — Wed, 19 Apr 2023 14:29:05 GMT

Revision 8 posted to Dev Tutorials by Rafael Fernandes on 4/19/2023 2:29:05 PM

Refactoring your code required a very basic setup to make your life easier to track what Rector does to your code (if you use its auto-fix mode).

Basic setup means installing software you will need such as Rector and Git. Git will help us to keep track of changes in your Sugar instance folder after we initialize it.

Keep that info in mind if you are planing to use a pre-existing instance for this work, it will add a lot of extra files to it.

Step by Step

Download a build of SugarCRM. Please use the one that is compatible with your MPL.
Install the build locally or use your own Sugar instance if you have one local
Download the latest rector release and unzip it into the Sugar instance folder. ex: /path/to/sugar/rector-0.15.20
Rector needs phpstan tool to run, for that create a new file in the Sugar instance folder called stan.neon. ex: /path/to/sugar/stan.neon

parameters:
	level: 1
	bootstrapFiles:
		- include/entryPoint.php

Initialize a git repository inside the instance folder: cd /path/to/sugar && git init. It’s just convenient to use git to track the list of files and some other things.
Create /path/to/sugar/.gitignore file to skip the unneeded changes with the following contents:

cache
vendor
portal2
upload
upgrades
*.log
rector.php

Commit the initial repository state

git add . && git commit -am 'init'

You might wanna keep your initial commit hash in case you need to reset

sh-3.2$ git log
commit 0ac2bd9c175f7bff9842dcd8179fc9ec67b7002f (HEAD -> main)
Author: Rafael Fernandes <rafael.fernandes@sugarcrm.com>
Date:   Mon Apr 17 10:40:56 2023 -0400

Initialize rector config:

cd /path/to/sugar && rector-0.15.20/bin/rector init

Agree to create a rector.php file with the dummy config. It should generate a template file similar to this:

<?php

declare(strict_types=1);

use Rector\CodeQuality\Rector\Class_\InlineConstructorDefaultToPropertyRector;
use Rector\Config\RectorConfig;
use Rector\Set\ValueObject\LevelSetList;

return static function (RectorConfig $rectorConfig): void {
    $rectorConfig->paths([
        __DIR__ . '/Ext',
        //... more subdirs here
        __DIR__ . '/upgrades',
    ]);

    // register a single rule
    $rectorConfig->rule(InlineConstructorDefaultToPropertyRector::class);

    // define sets of rules
    //    $rectorConfig->sets([
    //        LevelSetList::UP_TO_PHP_74
    //    ]);
};

Reset your Repo to start over

You can always start over at your initial Git commit and undo all changes by Rector or yourself after that point.
Take the initial commit hash from git log and reset as follows:

sh-3.2$ git log
commit 0ac2bd9c175f7bff9842dcd8179fc9ec67b7002f (HEAD -> main)
Author: Rafael Fernandes <rafael.fernandes@sugarcrm.com>
Date:   Mon Apr 17 10:40:56 2023 -0400

sh-3.2$ git status
On branch main
Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
        modified:   vCard.php

no changes added to commit (use "git add" and/or "git commit -a")

sh-3.2$ git reset --hard 0ac2bd9c175f7bff9842dcd8179fc9ec67b7002f
HEAD is now at 0ac2bd9c init

sh-3.2$ git clean -fd
Removing custom/Extension/application/Ext/Include/BuildingBlock_HelloWorldDashlet.php
Removing custom/Extension/application/Ext/Include/orderMapping.php
Removing custom/modules/ActivityStream/
Removing custom/modules/Forecasts/Ext/clients/
Removing custom/modules/pmse_Project/

sh-3.2$ git status
On branch main
nothing to commit, working tree clean

Rector Basic Setup

Rafael Fernandes — Tue, 18 Apr 2023 19:16:19 GMT

Revision 7 posted to Dev Tutorials by Rafael Fernandes on 4/18/2023 7:16:19 PM

Basic Setup

Refactoring your code required a very basic setup to make your life easier to track what Rector does to your code (if you use its auto-fix mode).

Basic setup means installing software you will need such as Rector and Git. Git will help us to keep track of changes in your Sugar instance folder after we initialize it.

Keep that info in mind if you are planing to use a pre-existing instance for this work, it will add a lot of extra files to it.

Step by Step

Download a build of SugarCRM. Please use the one that is compatible with your MPL.
Install the build locally or use your own Sugar instance if you have one local
Download the latest rector release and unzip it into the Sugar instance folder. ex: /path/to/sugar/rector-0.15.20
Rector needs phpstan tool to run, for that create a new file in the Sugar instance folder called stan.neon. ex: /path/to/sugar/stan.neon

parameters:
	level: 1
	bootstrapFiles:
		- include/entryPoint.php

Initialize a git repository inside the instance folder: cd /path/to/sugar && git init. It’s just convenient to use git to track the list of files and some other things.
Create /path/to/sugar/.gitignore file to skip the unneeded changes with the following contents:

cache
vendor
portal2
upload
upgrades
*.log
rector.php

Commit the initial repository state

git add . && git commit -am 'init'

You might wanna keep your initial commit hash in case you need to reset

sh-3.2$ git log
commit 0ac2bd9c175f7bff9842dcd8179fc9ec67b7002f (HEAD -> main)
Author: Rafael Fernandes <rafael.fernandes@sugarcrm.com>
Date:   Mon Apr 17 10:40:56 2023 -0400

Initialize rector config:

cd /path/to/sugar && rector-0.15.20/bin/rector init

Agree to create a rector.php file with the dummy config. It should generate a template file similar to this:

<?php

declare(strict_types=1);

use Rector\CodeQuality\Rector\Class_\InlineConstructorDefaultToPropertyRector;
use Rector\Config\RectorConfig;
use Rector\Set\ValueObject\LevelSetList;

return static function (RectorConfig $rectorConfig): void {
    $rectorConfig->paths([
        __DIR__ . '/Ext',
        //... more subdirs here
        __DIR__ . '/upgrades',
    ]);

    // register a single rule
    $rectorConfig->rule(InlineConstructorDefaultToPropertyRector::class);

    // define sets of rules
    //    $rectorConfig->sets([
    //        LevelSetList::UP_TO_PHP_74
    //    ]);
};

Reset your Repo to start over

You can always start over at your initial Git commit and undo all changes by Rector or yourself after that point.
Take the initial commit hash from git log and reset as follows:

sh-3.2$ git log
commit 0ac2bd9c175f7bff9842dcd8179fc9ec67b7002f (HEAD -> main)
Author: Rafael Fernandes <rafael.fernandes@sugarcrm.com>
Date:   Mon Apr 17 10:40:56 2023 -0400

sh-3.2$ git status
On branch main
Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
        modified:   vCard.php

no changes added to commit (use "git add" and/or "git commit -a")

sh-3.2$ git reset --hard 0ac2bd9c175f7bff9842dcd8179fc9ec67b7002f
HEAD is now at 0ac2bd9c init

sh-3.2$ git clean -fd
Removing custom/Extension/application/Ext/Include/BuildingBlock_HelloWorldDashlet.php
Removing custom/Extension/application/Ext/Include/orderMapping.php
Removing custom/modules/ActivityStream/
Removing custom/modules/Forecasts/Ext/clients/
Removing custom/modules/pmse_Project/

sh-3.2$ git status
On branch main
nothing to commit, working tree clean

Rector Basic Setup

Rafael Fernandes — Tue, 18 Apr 2023 19:15:57 GMT

Revision 6 posted to Dev Tutorials by Rafael Fernandes on 4/18/2023 7:15:57 PM

Basic Setup

Refactoring your code required a very basic setup to make your life easier to track what Rector does to your code (if you use its auto-fix mode).

Basic setup means installing software you will need such as Rector and Git. Git will help us to keep track of changes in your Sugar instance folder after we initialize it.

Keep that info in mind if you are planing to use a pre-existing instance for this work, it will add a lot of extra files to it.

Step by Step

Download a build of SugarCRM. Please use the one that is compatible with your MPL.
Install the build locally or use your own Sugar instance if you have one local
Download the latest rector release and unzip it into the Sugar instance folder. ex: /path/to/sugar/rector-0.15.20
Rector needs phpstan tool to run, for that create a new file in the Sugar instance folder called stan.neon. ex: /path/to/sugar/stan.neon

parameters:
	level: 1
	bootstrapFiles:
		- include/entryPoint.php

Initialize a git repository inside the instance folder: cd /path/to/sugar && git init. It’s just convenient to use git to track the list of files and some other things.
Create /path/to/sugar/.gitignore file to skip the unneeded changes with the following contents:

cache
vendor
portal2
upload
upgrades
*.log
rector.php

Commit the initial repository state

git add . && git commit -am 'init'

You might wanna keep your initial commit hash in case you need to reset

sh-3.2$ git log
commit 0ac2bd9c175f7bff9842dcd8179fc9ec67b7002f (HEAD -> main)
Author: Rafael Fernandes <rafael.fernandes@sugarcrm.com>
Date:   Mon Apr 17 10:40:56 2023 -0400

Initialize rector config:

cd /path/to/sugar && rector-0.15.20/bin/rector init

Agree to create a rector.php file with the dummy config. It should generate a template file similar to this:

<?php

declare(strict_types=1);

use Rector\CodeQuality\Rector\Class_\InlineConstructorDefaultToPropertyRector;
use Rector\Config\RectorConfig;
use Rector\Set\ValueObject\LevelSetList;

return static function (RectorConfig $rectorConfig): void {
    $rectorConfig->paths([
        __DIR__ . '/Ext',
        //... more subdirs here
        __DIR__ . '/upgrades',
    ]);

    // register a single rule
    $rectorConfig->rule(InlineConstructorDefaultToPropertyRector::class);

    // define sets of rules
    //    $rectorConfig->sets([
    //        LevelSetList::UP_TO_PHP_74
    //    ]);
};

Reset your Repo to start over

You can always start over at your initial Git commit and undo all changes by Rector or yourself after that point.
Take the initial commit hash from git log and reset as follows:

sh-3.2$ git log
commit 0ac2bd9c175f7bff9842dcd8179fc9ec67b7002f (HEAD -> main)
Author: Rafael Fernandes <rafael.fernandes@sugarcrm.com>
Date:   Mon Apr 17 10:40:56 2023 -0400

sh-3.2$ git status
On branch main
Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
        modified:   vCard.php

no changes added to commit (use "git add" and/or "git commit -a")

sh-3.2$ git reset --hard 0ac2bd9c175f7bff9842dcd8179fc9ec67b7002f
HEAD is now at 0ac2bd9c init

sh-3.2$ git clean -fd
Removing custom/Extension/application/Ext/Include/xxxx.php
Removing custom/Extension/application/Ext/Include/orderMapping.php
Removing custom/modules/ActivityStream/
Removing custom/modules/Forecasts/Ext/clients/
Removing custom/modules/pmse_Project/
Removing install/BusinessProcesses/data/

sh-3.2$ git status
On branch main
nothing to commit, working tree clean

sh-3.2$ git log
commit 0ac2bd9c175f7bff9842dcd8179fc9ec67b7002f (HEAD -> main)
Author: Rafael Fernandes <rafael.fernandes@sugarcrm.com>
Date:   Mon Apr 17 10:40:56 2023 -0400

sh-3.2$ git status
On branch main
Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
        modified:   vCard.php

no changes added to commit (use "git add" and/or "git commit -a")

sh-3.2$ git reset --hard 0ac2bd9c175f7bff9842dcd8179fc9ec67b7002f
HEAD is now at 0ac2bd9c init

sh-3.2$ git clean -fd
Removing custom/Extension/application/Ext/Include/BuildingBlock_HelloWorldDashlet.php
Removing custom/Extension/application/Ext/Include/orderMapping.php
Removing custom/modules/ActivityStream/
Removing custom/modules/Forecasts/Ext/clients/
Removing custom/modules/pmse_Project/

sh-3.2$ git status
On branch main
nothing to commit, working tree clean

Rector Basic Setup

Rafael Fernandes — Tue, 18 Apr 2023 15:57:58 GMT

Revision 5 posted to Dev Tutorials by Rafael Fernandes on 4/18/2023 3:57:58 PM

Basic Setup

Refactoring your code required a very basic setup to make your life easier to track what Rector does to your code (if you use its auto-fix mode).

Basic setup means installing software you will need such as Rector and Git. Git will help us to keep track of changes in your Sugar instance folder after we initialize it.

Keep that info in mind if you are planing to use a pre-existing instance for this work, it will add a lot of extra files to it.

Step by Step

Download a build of SugarCRM. Please use the one that is compatible with your MPL.
Install the build locally or use your own Sugar instance if you have one local
Download the latest rector release and unzip it into the Sugar instance folder. ex: /path/to/sugar/rector-0.15.20
Rector needs phpstan tool to run, for that create a new file in the Sugar instance folder called stan.neon. ex: /path/to/sugar/stan.neon

parameters:
	level: 1
	bootstrapFiles:
		- include/entryPoint.php

Initialize a git repository inside the instance folder: cd /path/to/sugar && git init. It’s just convenient to use git to track the list of files and some other things.
Create /path/to/sugar/.gitignore file to skip the unneeded changes with the following contents:

cache
vendor
portal2
upload
upgrades
*.log
rector.php

Commit the initial repository state

git add . && git commit -am 'init'

You might wanna keep your initial commit hash in case you need to reset

sh-3.2$ git log
commit 0ac2bd9c175f7bff9842dcd8179fc9ec67b7002f (HEAD -> main)
Author: Rafael Fernandes <rafael.fernandes@sugarcrm.com>
Date:   Mon Apr 17 10:40:56 2023 -0400

Initialize rector config:

cd /path/to/sugar && rector-0.15.20/bin/rector init

Agree to create a rector.php file with the dummy config. It should generate a template file similar to this:

<?php

declare(strict_types=1);

use Rector\CodeQuality\Rector\Class_\InlineConstructorDefaultToPropertyRector;
use Rector\Config\RectorConfig;
use Rector\Set\ValueObject\LevelSetList;

return static function (RectorConfig $rectorConfig): void {
    $rectorConfig->paths([
        __DIR__ . '/Ext',
        //... more subdirs here
        __DIR__ . '/upgrades',
    ]);

    // register a single rule
    $rectorConfig->rule(InlineConstructorDefaultToPropertyRector::class);

    // define sets of rules
    //    $rectorConfig->sets([
    //        LevelSetList::UP_TO_PHP_74
    //    ]);
};

Reset your Repo to start over

You can always start over at your initial Git commit and undo all changes by Rector or yourself after that point.
Take the initial commit hash from git log and reset as follows:

sh-3.2$ git log
commit 0ac2bd9c175f7bff9842dcd8179fc9ec67b7002f (HEAD -> main)
Author: Rafael Fernandes <rafael.fernandes@sugarcrm.com>
Date:   Mon Apr 17 10:40:56 2023 -0400

sh-3.2$ git status
On branch main
Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
        modified:   vCard.php

no changes added to commit (use "git add" and/or "git commit -a")

sh-3.2$ git reset --hard 0ac2bd9c175f7bff9842dcd8179fc9ec67b7002f
HEAD is now at 0ac2bd9c init

sh-3.2$ git clean -fd
Removing custom/Extension/application/Ext/Include/xxxx.php
Removing custom/Extension/application/Ext/Include/orderMapping.php
Removing custom/modules/ActivityStream/
Removing custom/modules/Forecasts/Ext/clients/
Removing custom/modules/pmse_Project/
Removing install/BusinessProcesses/data/

sh-3.2$ git status
On branch main
nothing to commit, working tree clean

Rector Basic Setup

Rafael Fernandes — Tue, 18 Apr 2023 15:51:32 GMT

Revision 4 posted to Dev Tutorials by Rafael Fernandes on 4/18/2023 3:51:32 PM

Basic Setup

Refactoring your code required a very basic setup to make your life easier to track what Rector does to your code (if you use its auto-fix mode).

Basic setup means installing software you will need such as Rector and Git. Git will help us to keep track of changes in your Sugar instance folder after we initialize it.

Keep that info in mind if you are planing to use a pre-existing instance for this work, it will add a lot of extra files to it.

Step by Step

Download a build of SugarCRM. Please use the one that is compatible with your MPL.
Install the build locally or use your own Sugar instance if you have one local
Download the latest rector release and unzip it into the Sugar instance folder. ex: /path/to/sugar/rector-0.15.20
Rector needs phpstan tool to run, for that create a new file in the Sugar instance folder called stan.neon. ex: /path/to/sugar/stan.neon

parameters:
	level: 1
	bootstrapFiles:
		- include/entryPoint.php

Initialize a git repository inside the instance folder: cd /path/to/sugar && git init. It’s just convenient to use git to track the list of files and some other things.
Create /path/to/sugar/.gitignore file to skip the unneeded changes with the following contents:

cache
vendor
portal2
upload
upgrades
*.log
rector.php

Commit the initial repository state

git add . && git commit -am 'init'

You might wanna keep your initial commit hash in case you need to reset

sh-3.2$ git log
commit 0ac2bd9c175f7bff9842dcd8179fc9ec67b7002f (HEAD -> main)
Author: Rafael Fernandes <rafael.fernandes@sugarcrm.com>
Date:   Mon Apr 17 10:40:56 2023 -0400

Initialize rector config:

cd /path/to/sugar && rector-0.15.20/bin/rector init

Agree to create a rector.php file with the dummy config. It should generate a template file similar to this:

<?php

declare(strict_types=1);

use Rector\CodeQuality\Rector\Class_\InlineConstructorDefaultToPropertyRector;
use Rector\Config\RectorConfig;
use Rector\Set\ValueObject\LevelSetList;

return static function (RectorConfig $rectorConfig): void {
    $rectorConfig->paths([
        __DIR__ . '/Ext',
        //... more subdirs here
        __DIR__ . '/upgrades',
    ]);

    // register a single rule
    $rectorConfig->rule(InlineConstructorDefaultToPropertyRector::class);

    // define sets of rules
    //    $rectorConfig->sets([
    //        LevelSetList::UP_TO_PHP_74
    //    ]);
};

Reset your Repo to start over

You can always start over at your initial Git commit and undo all changes by Rector or yourself after that point.
Take the initial commit hash from git log and reset as follows:

sh-3.2$ git log
commit 0ac2bd9c175f7bff9842dcd8179fc9ec67b7002f (HEAD -> main)
Author: Rafael Fernandes <rafael.fernandes@sugarcrm.com>
Date:   Mon Apr 17 10:40:56 2023 -0400

sh-3.2$ git status
On branch main
Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
        modified:   vCard.php

no changes added to commit (use "git add" and/or "git commit -a")

sh-3.2$ git reset --hard 0ac2bd9c175f7bff9842dcd8179fc9ec67b7002f
HEAD is now at 0ac2bd9c init


sh-3.2$ git status
On branch main
nothing to commit, working tree clean

Rector Basic Setup

Rafael Fernandes — Fri, 14 Apr 2023 14:01:34 GMT

Revision 3 posted to Dev Tutorials by Rafael Fernandes on 4/14/2023 2:01:34 PM

Basic Setup

Refactoring your code required a very basic setup to make your life easier to track what Rector does to your code (if you use its auto-fix mode).

Basic setup means installing software you will need such as Rector and Git. Git will help us to keep track of changes in your Sugar instance folder after we initialize it.

Keep that info in mind if you are planing to use a pre-existing instance for this work, it will add a lot of extra files to it.

Step by Step

Download a build of SugarCRM. Please use the one that is compatible with your MPL.
Install the build locally or use your own Sugar instance if you have one local
Download the latest rector release and unzip it into the Sugar instance folder. ex: /path/to/sugar/rector-0.15.20
Rector needs phpstan tool to run, for that create a new file in the Sugar instance folder called stan.neon. ex: /path/to/sugar/stan.neon

parameters:
	level: 1
	bootstrapFiles:
		- include/entryPoint.php

Initialize a git repository inside the instance folder: cd /path/to/sugar && git init. It’s just convenient to use git to track the list of files and some other things.
Create /path/to/sugar/.gitignore file to skip the unneeded changes with the following contents:

cache
vendor
portal2
upload
upgrades
*.log
rector.php

Commit the initial repository state

git add . && git commit -am 'init'

Initialize rector config:

cd /path/to/sugar && rector-0.15.20/bin/rector init

Agree to create a rector.php file with the dummy config. It should generate a template file similar to this:

<?php

declare(strict_types=1);

use Rector\CodeQuality\Rector\Class_\InlineConstructorDefaultToPropertyRector;
use Rector\Config\RectorConfig;
use Rector\Set\ValueObject\LevelSetList;

return static function (RectorConfig $rectorConfig): void {
    $rectorConfig->paths([
        __DIR__ . '/Ext',
        //... more subdirs here
        __DIR__ . '/upgrades',
    ]);

    // register a single rule
    $rectorConfig->rule(InlineConstructorDefaultToPropertyRector::class);

    // define sets of rules
    //    $rectorConfig->sets([
    //        LevelSetList::UP_TO_PHP_74
    //    ]);
};

Rector Basic Setup

Rafael Fernandes — Thu, 13 Apr 2023 15:04:25 GMT

Revision 2 posted to Dev Tutorials by Rafael Fernandes on 4/13/2023 3:04:25 PM

Basic Setup

You will need a basic setup to have Rector working with Sugar. We will create files and initialize a git repo in the Sugar instance folder to keep track of the changes.

If you are using a pre-existing instance, keep that in mind, we suggest creating a new instance for this purpose.

Step by Step

Download a build of SugarCRM. Please use the one that is compatible with your MPL.
Install the build locally or use your own Sugar instance if you have one local
Download the latest rector release and unzip it into the Sugar instance folder. ex: /path/to/sugar/rector-0.15.20
Rector needs phpstan tool to run, for that create a new file in the Sugar instance folder called stan.neon. ex: /path/to/sugar/stan.neon

parameters:
	level: 1
	bootstrapFiles:
		- include/entryPoint.php

Initialize a git repository inside the instance folder: cd /path/to/sugar && git init. It’s just convenient to use git to track the list of files and some other things.
Create /path/to/sugar/.gitignore file to skip the unneeded changes with the following contents:

cache
vendor
portal2
upload
upgrades
*.log
rector.php

Commit the initial repository state

git add . && git commit -am 'init'

Initialize rector config:

cd /path/to/sugar && rector-0.15.20/bin/rector init

Agree to create a rector.php file with the dummy config. It should generate a template file similar to this:

<?php

declare(strict_types=1);

use Rector\CodeQuality\Rector\Class_\InlineConstructorDefaultToPropertyRector;
use Rector\Config\RectorConfig;
use Rector\Set\ValueObject\LevelSetList;

return static function (RectorConfig $rectorConfig): void {
    $rectorConfig->paths([
        __DIR__ . '/Ext',
        //... more subdirs here
        __DIR__ . '/upgrades',
    ]);

    // register a single rule
    $rectorConfig->rule(InlineConstructorDefaultToPropertyRector::class);

    // define sets of rules
    //    $rectorConfig->sets([
    //        LevelSetList::UP_TO_PHP_74
    //    ]);
};