Merge pull request #63 from worksome/JIRA-13724_single-quote

feat(ecs): JIRA-13724 Add `single_quote`
worksome · Oct 11, 2024 · 2b5cff3 · 2b5cff3
2 parents 3fd2ce8 + d5fca8e
commit 2b5cff3
Show file tree

Hide file tree

Showing 17 changed files with 36 additions and 34 deletions.
diff --git a/src/GenerateCommand.php b/src/GenerateCommand.php
@@ -10,7 +10,7 @@ class GenerateCommand extends BaseCommand
 {
     protected function configure()
     {
-        $this->setName("generate-coding-style-stubs");
+        $this->setName('generate-coding-style-stubs');
     }
 
     protected function execute(InputInterface $input, OutputInterface $output): int
@@ -24,7 +24,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         ];
 
         foreach ($files as $newFile => $oldFile) {
-            $path = sprintf("%s/%s", getcwd(), $newFile);
+            $path = sprintf('%s/%s', getcwd(), $newFile);
             if (file_exists($path)) {
                 $output->writeln("$newFile already exist. Skipping...");
                 continue;
@@ -36,11 +36,11 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
         $this->tryComposer()->getConfig()->merge([
             'scripts' => [
-                "ecs" => "vendor/bin/ecs",
-                "ecs:fix" => "vendor/bin/ecs --fix",
-                "phpstan" => "vendor/bin/phpstan analyse",
-                "rector" => "vendor/bin/rector process --dry-run --ansi",
-                "rector:fix" => "vendor/bin/rector process --ansi",
+                'ecs' => 'vendor/bin/ecs',
+                'ecs:fix' => 'vendor/bin/ecs --fix',
+                'phpstan' => 'vendor/bin/phpstan analyse',
+                'rector' => 'vendor/bin/rector process --dry-run --ansi',
+                'rector:fix' => 'vendor/bin/rector process --ansi',
             ]
         ]);
 

diff --git a/src/Rector/Generic/DisallowedAttributesRector.php b/src/Rector/Generic/DisallowedAttributesRector.php
@@ -24,7 +24,7 @@ public function getRuleDefinition(): RuleDefinition
                     #[NotAllowed]
                     class MyClass {}
                     PHP,
-                    "class MyClass {}",
+                    'class MyClass {}',
                 )
             ]
         );

diff --git a/src/Sniffs/Classes/ExceptionSuffixSniff.php b/src/Sniffs/Classes/ExceptionSuffixSniff.php
@@ -8,7 +8,7 @@
 
 class ExceptionSuffixSniff implements Sniff
 {
-    public string $suffix = "Exception";
+    public string $suffix = 'Exception';
 
     public function register(): array
     {
@@ -40,7 +40,7 @@ public function process(File $phpcsFile, $stackPtr)
         }
 
         $phpcsFile->addError(
-            "Exceptions should have `Exception` suffix.",
+            'Exceptions should have `Exception` suffix.',
             $classNamePointer,
             self::class,
         );

diff --git a/src/Sniffs/Comments/DisallowTodoCommentsSniff.php b/src/Sniffs/Comments/DisallowTodoCommentsSniff.php
@@ -24,7 +24,7 @@ public function process(File $phpcsFile, $stackPtr)
         }
 
         $phpcsFile->addError(
-            "Comments with TODO are disallowed",
+            'Comments with TODO are disallowed',
             $stackPtr,
             self::class
         );

diff --git a/src/Sniffs/Enums/PascalCasingEnumCasesSniff.php b/src/Sniffs/Enums/PascalCasingEnumCasesSniff.php
@@ -27,7 +27,7 @@ public function process(File $phpcsFile, $stackPtr)
         }
 
         $phpcsFile->addError(
-            "Enum cases MUST be PascalCase",
+            'Enum cases MUST be PascalCase',
             $nameRef,
             self::class
         );

diff --git a/src/Sniffs/Functions/DisallowCompactUsageSniff.php b/src/Sniffs/Functions/DisallowCompactUsageSniff.php
@@ -24,7 +24,7 @@ public function process(File $phpcsFile, $stackPtr)
         }
 
         $phpcsFile->addFixableError(
-            "Usage of compact function is disallowed.",
+            'Usage of compact function is disallowed.',
             $stackPtr,
             self::class
         );
@@ -37,7 +37,7 @@ public function process(File $phpcsFile, $stackPtr)
         foreach (range(1, $lastTokenPointer - 1) as $currentPointer) {
             $phpcsFile->fixer->replaceToken(
                 $stackPtr + $currentPointer,
-                ""
+                ''
             );
         }
 
@@ -58,7 +58,7 @@ private function generatePhpArray(array $variables): string
         // Remove the trailing `, ` from the array.
         $phpCode = substr($phpCode, 0, -2);
         // Close the array
-        $phpCode .= "]";
+        $phpCode .= ']';
 
         return $phpCode;
     }

diff --git a/src/Sniffs/Laravel/ConfigFilenameKebabCaseSniff.php b/src/Sniffs/Laravel/ConfigFilenameKebabCaseSniff.php
@@ -32,7 +32,7 @@ public function process(File $phpcsFile, $stackPtr)
         }
 
         $phpcsFile->addError(
-            "Config files should be named with kebab-case.",
+            'Config files should be named with kebab-case.',
             0,
             self::class,
         );

diff --git a/src/Sniffs/Laravel/DisallowBladeOutsideOfResourcesDirectorySniff.php b/src/Sniffs/Laravel/DisallowBladeOutsideOfResourcesDirectorySniff.php
@@ -33,7 +33,7 @@ public function process(File $phpcsFile, $stackPtr): void
         }
 
         $phpcsFile->addError(
-            "Blade files must be placed in the resources directory.",
+            'Blade files must be placed in the resources directory.',
             $stackPtr,
             self::class
         );

diff --git a/src/Sniffs/Laravel/DisallowEnvUsageSniff.php b/src/Sniffs/Laravel/DisallowEnvUsageSniff.php
@@ -30,7 +30,7 @@ public function process(File $phpcsFile, $stackPtr)
         }
 
         $phpcsFile->addError(
-            "Usage of env in non-config file is disallowed.",
+            'Usage of env in non-config file is disallowed.',
             $stackPtr,
             self::class
         );

diff --git a/src/Sniffs/Laravel/DisallowHasFactorySniff.php b/src/Sniffs/Laravel/DisallowHasFactorySniff.php
@@ -8,7 +8,7 @@
 
 class DisallowHasFactorySniff implements Sniff
 {
-    private const HAS_FACTORY_FQCN = "Illuminate\\Database\\Eloquent\\Factories\\HasFactory";
+    private const HAS_FACTORY_FQCN = 'Illuminate\\Database\\Eloquent\\Factories\\HasFactory';
 
     private string|null $partial = null;
 
@@ -34,7 +34,7 @@ public function process(File $phpcsFile, $stackPtr)
     private function isHasFactoryNamespace(string $givenNamespace): bool
     {
         if ($this->partial !== null && strlen($this->partial) > 0) {
-            $givenNamespace = $this->partial . Str::after($givenNamespace, Str::afterLast($this->partial, "\\"));
+            $givenNamespace = $this->partial . Str::after($givenNamespace, Str::afterLast($this->partial, '\\'));
         }
 
         if ($givenNamespace !== self::HAS_FACTORY_FQCN) {
@@ -47,7 +47,7 @@ private function isHasFactoryNamespace(string $givenNamespace): bool
     private function trackRelevantPartialNamespace(string $givenNamespace): void
     {
         Str::of(self::HAS_FACTORY_FQCN)
-            ->explode("\\")
+            ->explode('\\')
             ->skip(1)
             ->reduce(function (string $carry, string $item) use ($givenNamespace) {
                 $updatedNamespacePartial = "{$carry}\\{$item}";
@@ -63,7 +63,7 @@ private function trackRelevantPartialNamespace(string $givenNamespace): void
     private function addError(File $phpcsFile, int $line): void
     {
         $phpcsFile->addError(
-            "Models should not use the `HasFactory` trait.",
+            'Models should not use the `HasFactory` trait.',
             $line,
             self::class,
         );

diff --git a/src/Sniffs/Laravel/EventListenerSuffixSniff.php b/src/Sniffs/Laravel/EventListenerSuffixSniff.php
@@ -8,7 +8,7 @@
 
 class EventListenerSuffixSniff implements Sniff
 {
-    public string $suffix = "Listener";
+    public string $suffix = 'Listener';
 
     public function register(): array
     {
@@ -35,7 +35,7 @@ public function process(File $phpcsFile, $stackPtr)
         }
 
         $phpcsFile->addError(
-            "Listeners should have `Listener` suffix.",
+            'Listeners should have `Listener` suffix.',
             $classNamePointer,
             self::class,
         );

diff --git a/src/Sniffs/PhpDoc/DisallowParamNoTypeOrCommentSniff.php b/src/Sniffs/PhpDoc/DisallowParamNoTypeOrCommentSniff.php
@@ -31,15 +31,15 @@ public function process(File $phpcsFile, $stackPtr)
         }
 
         $phpcsFile->addFixableError(
-            "@param tags with no type or comment are disallowed",
+            '@param tags with no type or comment are disallowed',
             $stackPtr,
             self::class
         );
 
         foreach (range(-4, 2) as $pointer) {
             $phpcsFile->fixer->replaceToken(
                 $stackPtr + $pointer,
-                ""
+                ''
             );
         }
     }

diff --git a/src/Sniffs/PhpDoc/PropertyDollarSignSniff.php b/src/Sniffs/PhpDoc/PropertyDollarSignSniff.php
@@ -29,7 +29,7 @@ public function process(File $phpcsFile, $stackPtr)
         }
 
         $phpcsFile->addFixableError(
-            "All @property variables should start with a dollar symbol.",
+            'All @property variables should start with a dollar symbol.',
             $stackPtr,
             self::class
         );

diff --git a/src/WorksomeEcsConfig.php b/src/WorksomeEcsConfig.php
@@ -33,6 +33,7 @@
 use PhpCsFixer\Fixer\Phpdoc\PhpdocAlignFixer;
 use PhpCsFixer\Fixer\Phpdoc\PhpdocSeparationFixer;
 use PhpCsFixer\Fixer\Semicolon\NoEmptyStatementFixer;
+use PhpCsFixer\Fixer\StringNotation\SingleQuoteFixer;
 use PhpCsFixer\Fixer\Whitespace\LineEndingFixer;
 use PhpCsFixer\Fixer\Whitespace\TypesSpacesFixer;
 use SlevomatCodingStandard\Sniffs\Classes\ClassConstantVisibilitySniff;
@@ -200,6 +201,7 @@ public static function setup(ECSConfig $ecsConfig): void
             PropertyDollarSignSniff::class,
             TypesSpacesFixer::class,
             PascalCasingEnumCasesSniff::class,
+            SingleQuoteFixer::class,
         ]);
     }
 

diff --git a/tests/PHPStan/Laravel/DisallowEnvironmentCheckRule/DisallowEnvironmentCheckRuleTest.php b/tests/PHPStan/Laravel/DisallowEnvironmentCheckRule/DisallowEnvironmentCheckRuleTest.php
@@ -12,7 +12,7 @@
         $lineNumber,
     ], [4, 5, 6]);
 
-    expect(__DIR__ . "/Fixture/app_helper_environment_checks.php.inc")->toHaveRuleErrors($errors);
+    expect(__DIR__ . '/Fixture/app_helper_environment_checks.php.inc')->toHaveRuleErrors($errors);
 });
 
 it('checks for environment checks made using the app facade', function () {
@@ -23,7 +23,7 @@
         $lineNumber,
     ], [4, 5, 6, 9, 10, 11]);
 
-    expect(__DIR__ . "/Fixture/app_facade_environment_checks.php.inc")->toHaveRuleErrors($errors);
+    expect(__DIR__ . '/Fixture/app_facade_environment_checks.php.inc')->toHaveRuleErrors($errors);
 });
 
 it('checks for environment checks made using an imported app facade', function () {
@@ -34,7 +34,7 @@
         $lineNumber,
     ], [6, 7, 8]);
 
-    expect(__DIR__ . "/Fixture/imported_app_facade_environment_checks.php.inc")->toHaveRuleErrors($errors);
+    expect(__DIR__ . '/Fixture/imported_app_facade_environment_checks.php.inc')->toHaveRuleErrors($errors);
 });
 
 it('checks for environment checks made using the application contract', function () {
@@ -45,5 +45,5 @@
         $lineNumber,
     ], [6, 10]);
 
-    expect(__DIR__ . "/Fixture/application_class_environment_checks.php.inc")->toHaveRuleErrors($errors);
+    expect(__DIR__ . '/Fixture/application_class_environment_checks.php.inc')->toHaveRuleErrors($errors);
 });
diff --git a/tests/Pest.php b/tests/Pest.php
@@ -53,7 +53,7 @@
 
     Assert::assertEmpty(
         $value->getErrors(),
-        "The following errors were found: " . PHP_EOL . json_encode($value->getErrors())
+        'The following errors were found: ' . PHP_EOL . json_encode($value->getErrors())
     );
 
     return $this;
@@ -144,7 +144,7 @@ function getSniffName(string $sniffClassName): string
 {
     $dotted = preg_replace(
         [
-            "~\\\\~",
+            '~\\\\~',
             '~\.Sniffs~',
             '~Sniff$~',
         ],

diff --git a/tests/Rector/BaseRectorTestCase.php b/tests/Rector/BaseRectorTestCase.php
@@ -12,6 +12,6 @@ abstract class BaseRectorTestCase extends AbstractRectorTestCase
 {
     public function provideConfigFilePath(): string
     {
-        return Str::beforeLast(invade($this)->__filename, "/") . '/config/configured_rule.php';
+        return Str::beforeLast(invade($this)->__filename, '/') . '/config/configured_rule.php';
     }
 }