Rector (#5)

feat: Rector

Makefile

@@ -23,3 +23,4 @@ install:
 	@sudo ln -sf $(shell pwd)/bin/pint          /usr/local/bin/pint
 	@sudo ln -sf $(shell pwd)/bin/exakat        /usr/local/bin/exakat
 	@sudo ln -sf $(shell pwd)/bin/frankenphp    /usr/local/bin/frankenphp
+	@sudo ln -sf $(shell pwd)/bin/rector        /usr/local/bin/rector

README.md

@@ -75,6 +75,7 @@ phpctl sh echo 'Hello, World!' # To run arbitrary sh commands inside the contain
 | `box`          | Runs [Box](https://github.com/box-project/box). |
 | `exakat`       | Runs [Exakat](https://www.exakat.io)            |
 | `frankenphp`   | Runs [FrankenPHP](https://frankenphp.dev)       |
+| `rector`       | Runs [Rector](https://getrector.com)            |
 
 ### Scaffolders
 | Command                    | Description                                                   |

bin/rector

@@ -0,0 +1,2 @@
+#!/usr/bin/env sh
+phpctl rector $@

examples/rector/.gitignore

@@ -0,0 +1 @@
+vendor/

examples/rector/README.md

@@ -0,0 +1,36 @@
+# Rector
+
+This is an example of how to use Rector to refactor your code.
+
+Run `phpctl rector -n` (yes, with the `-n` flag) to see what Rector would do.
+
+You should be seeing something like:
+```shell
+➜  rector git:(feat/rector) ✗ phpctl rector -n
+Running opencodeco/phpctl:php82
+ 1/1 [▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓] 100%
+1 file with changes
+===================
+
+1) src/example.php:0
+
+    ---------- begin diff ----------
+@@ @@
+ <?php
+
+-$arr = array();
++$arr = [];
+    ----------- end diff -----------
+
+Applied rules:
+ * LongArrayToShortArrayRector
+
+
+
+ [OK] 1 file would have changed (dry-run) by Rector                                                                     
+
+
+
+```
+
+Where Rector attempts to change the code from using `array()` to `[]`.

examples/rector/composer.json

@@ -0,0 +1,5 @@
+{
+    "require-dev": {
+        "rector/rector": "^0.19.2"
+    }
+}

examples/rector/rector.php

@@ -0,0 +1,21 @@
+<?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__ . '/src',
+    ]);
+
+    // register a single rule
+    $rectorConfig->rule(InlineConstructorDefaultToPropertyRector::class);
+
+    // define sets of rules
+    $rectorConfig->sets([
+        LevelSetList::UP_TO_PHP_82
+    ]);
+};

examples/rector/src/example.php

@@ -0,0 +1,3 @@
+<?php
+
+$arr = array();

installer.sh

@@ -15,6 +15,7 @@ symlink() {
     sudo ln -sf "${INSTALL_DIR}/bin/pint"         /usr/local/bin/pint
     sudo ln -sf "${INSTALL_DIR}/bin/exakat"       /usr/local/bin/exakat
     sudo ln -sf "${INSTALL_DIR}/bin/frankenphp"   /usr/local/bin/frankenphp
+    sudo ln -sf "${INSTALL_DIR}/bin/rector"       /usr/local/bin/rector
 }
 
 echo "\033[0;33mInstalling phpctl at \033[0m$INSTALL_DIR"
@@ -45,5 +46,6 @@ else
     echo "  sudo ln -sf ${INSTALL_DIR}/bin/pint         /usr/local/bin/pint"
     echo "  sudo ln -sf ${INSTALL_DIR}/bin/exakat       /usr/local/bin/exakat"
     echo "  sudo ln -sf ${INSTALL_DIR}/bin/frankenphp   /usr/local/bin/frankenphp"
+    echo "  sudo ln -sf ${INSTALL_DIR}/bin/rector       /usr/local/bin/rector"
     echo ""
 fi

src/help.sh

@@ -42,5 +42,6 @@ help() {
     echo -e "\033[0;32m  box                        \033[0m Runs Box (PHAR builder)"
     echo -e "\033[0;32m  exakat                     \033[0m Runs Exakat"
     echo -e "\033[0;32m  frankenphp                 \033[0m Runs FrankenPHP"
+    echo -e "\033[0;32m  rector                     \033[0m Runs Rector"
     echo -e ""
 }

src/tools.sh

@@ -65,3 +65,7 @@ pint() {
         run -- pint ${@}
     fi;
 }
+
+rector() {
+    run -- vendor/bin/rector ${@}
+}