feat: initial commit

.editorconfig

@@ -0,0 +1,19 @@
+; This file is for unifying the coding style for different editors and IDEs.
+; More information at http://editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+indent_size = 4
+indent_style = space
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+max_line_length = 120
+
+[*.md]
+trim_trailing_whitespace = false
+
+[{*.yml, *.yaml}]
+indent_size = 2

.gitattributes

@@ -0,0 +1,13 @@
+# Path-based git attributes
+# https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html
+
+# Ignore all test and documentation with "export-ignore".
+/.gitattributes     export-ignore
+/.gitignore         export-ignore
+/.travis.yml        export-ignore
+/phpunit.xml.dist   export-ignore
+/.scrutinizer.yml   export-ignore
+/.styleci.yml       export-ignore
+/tests              export-ignore
+/.editorconfig      export-ignore
+/docs               export-ignore

.github/workflows/styling.yml

@@ -0,0 +1,23 @@
+name: Check & fix styling
+
+on: [ push ]
+
+jobs:
+  styling:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+        with:
+          ref: ${{ github.head_ref }}
+
+      - name: Run PHP CS Fixer
+        uses: docker://oskarstark/php-cs-fixer-ga
+        with:
+          args: --allow-risky=yes
+
+      - name: Commit changes
+        uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          commit_message: Fix styling

.github/workflows/update-changelog.yml

@@ -0,0 +1,28 @@
+name: "Update Changelog"
+
+on:
+  release:
+    types: [ released ]
+
+jobs:
+  update:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+        with:
+          ref: main
+
+      - name: Update Changelog
+        uses: stefanzweifel/changelog-updater-action@v1
+        with:
+          latest-version: ${{ github.event.release.name }}
+          release-notes: ${{ github.event.release.body }}
+
+      - name: Commit updated CHANGELOG
+        uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          branch: main
+          commit_message: Update CHANGELOG
+          file_pattern: CHANGELOG.md

.gitignore

@@ -0,0 +1,7 @@
+/.idea
+/vendor
+composer.phar
+composer.lock
+.phpunit.result.cache
+.php_cs.cache
+.php-cs-fixer.cache

.php-cs-fixer.dist.php

@@ -0,0 +1,40 @@
+<?php
+
+$finder = Symfony\Component\Finder\Finder::create()
+    ->notPath('vendor')
+    ->in([
+        __DIR__ . '/src',
+    ])
+    ->name('*.php')
+    ->notName('*.blade.php')
+    ->ignoreDotFiles(true)
+    ->ignoreVCS(true);
+
+$config = new PhpCsFixer\Config();
+
+return $config->setRules([
+    '@PSR12' => true,
+    'array_syntax' => ['syntax' => 'short'],
+    'ordered_imports' => ['sort_algorithm' => 'alpha'],
+    'no_unused_imports' => true,
+    'declare_strict_types' => true,
+    'not_operator_with_successor_space' => true,
+    'trailing_comma_in_multiline' => true,
+    'phpdoc_scalar' => true,
+    'unary_operator_spaces' => true,
+    'binary_operator_spaces' => true,
+    'blank_line_before_statement' => [
+        'statements' => ['break', 'continue', 'declare', 'return', 'throw', 'try'],
+    ],
+    'phpdoc_single_line_var_spacing' => true,
+    'phpdoc_var_without_name' => true,
+    'class_attributes_separation' => [
+        'elements' => [
+            'method' => 'one',
+        ],
+    ],
+    'method_argument_space' => [
+        'on_multiline' => 'ensure_fully_multiline',
+        'keep_multiple_spaces_after_comma' => true,
+    ],
+])->setFinder($finder);

CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+All notable changes to `yieldstudio/grumphp-laravel-pint` will be documented in this file.
+
+Updates should follow the [Keep a CHANGELOG](http://keepachangelog.com/) principles.

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Yield Studio
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,39 @@
+# GrumPHP Laravel Pint
+
+A [Laravel Pint](https://laravel.com/docs/9.x/pint) task for [GrumPHP](https://github.com/phpro/grumphp).
+
+[![Latest Version](https://img.shields.io/github/release/yieldstudio/grumphp-laravel-pint?style=flat-square)](https://github.com/yieldstudio/grumphp-laravel-pint/releases)
+[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/yieldstudio/grumphp-laravel-pint/tests?style=flat-square)](https://github.com/yieldstudio/grumphp-laravel-pint/actions/workflows/tests.yml)
+[![Total Downloads](https://img.shields.io/packagist/dt/yieldstudio/grumphp-laravel-pint?style=flat-square)](https://packagist.org/packages/yieldstudio/grumphp-laravel-pint)
+
+## Installation
+
+	composer require yieldstudio/grumphp-laravel-pint
+
+## Usage
+
+In your grumphp.yml : 
+
+```yaml
+grumphp:
+  tasks:
+    laravel_pint:
+      config: pint.json
+```
+
+## Changelog
+
+Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
+
+### Security
+
+If you've found a bug regarding security please mail [[email protected]](mailto:[email protected]) instead of using the issue tracker.
+
+## Credits
+
+- [James Hemery](https://github.com/jameshemery)
+
+## License
+
+The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
+

composer.json

@@ -0,0 +1,42 @@
+{
+    "name": "yieldstudio/grumphp-laravel-pint",
+    "description": "A Laravel Pint task for GrumPHP.",
+    "type": "plugin",
+    "keywords": [
+        "yieldstudio",
+        "laravel",
+        "grumphp",
+        "quality",
+        "phpcsfixer",
+        "pint",
+        "linter"
+    ],
+    "homepage": "https://github.com/YieldStudio/grumphp-laravel-pint",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "James Hemery",
+            "email": "[email protected]",
+            "homepage": "https://yieldstudio.fr",
+            "role": "Developer"
+        }
+    ],
+    "require": {
+        "php": "^8.0",
+        "phpro/grumphp": "^1.13"
+    },
+    "autoload": {
+        "psr-4": {
+            "YieldStudio\\GrumPHPLaravelPint\\": "src"
+        }
+    },
+    "scripts": {
+        "format": "vendor/bin/php-cs-fixer fix --allow-risky=yes"
+    },
+    "config": {
+        "sort-packages": true,
+        "allow-plugins": {}
+    },
+    "minimum-stability": "stable",
+    "prefer-stable": true
+}

src/ExtensionLoader.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace YieldStudio\GrumPHPLaravelPint;
+
+use GrumPHP\Extension\ExtensionInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Reference;
+
+class ExtensionLoader implements ExtensionInterface
+{
+    /**
+     * @param  ContainerBuilder  $container
+     */
+    public function load(ContainerBuilder $container): void
+    {
+        $container->register('task.laravel_pint', LaravelPintTask::class)
+            ->addArgument(new Reference('process_builder'))
+            ->addArgument(new Reference('formatter.raw_process'))
+            ->addTag('grumphp.task', ['task' => 'laravel_pint']);
+    }
+}

src/LaravelPintTask.php

@@ -0,0 +1,97 @@
+<?php
+
+declare(strict_types=1);
+
+namespace YieldStudio\GrumPHPLaravelPint;
+
+use GrumPHP\Runner\TaskResult;
+use GrumPHP\Runner\TaskResultInterface;
+use GrumPHP\Task\AbstractExternalTask;
+use GrumPHP\Task\Context\ContextInterface;
+use GrumPHP\Task\Context\GitPreCommitContext;
+use GrumPHP\Task\Context\RunContext;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+use Symfony\Component\Process\Process;
+
+class LaravelPintTask extends AbstractExternalTask
+{
+    public function getName(): string
+    {
+        return 'laravel_pint';
+    }
+
+    public static function getConfigurableOptions(): OptionsResolver
+    {
+        $resolver = new OptionsResolver();
+        $resolver->setDefaults([
+            'config' => null,
+            'triggered_by' => ['php'],
+        ]);
+
+        $resolver->addAllowedTypes('config', ['null', 'string']);
+        $resolver->addAllowedTypes('triggered_by', ['array']);
+
+        return $resolver;
+    }
+
+    public function canRunInContext(ContextInterface $context): bool
+    {
+        return $context instanceof GitPreCommitContext || $context instanceof RunContext;
+    }
+
+    public function runProcess(Process $process, ContextInterface $context): ?TaskResult
+    {
+        $process->run();
+
+        if (! $process->isSuccessful()) {
+            return TaskResult::createFailed($this, $context, $this->formatter->format($process));
+        }
+
+        return null;
+    }
+
+    public function run(ContextInterface $context): TaskResultInterface
+    {
+        $config = $this->getConfig()->getOptions();
+        if (! ($context instanceof GitPreCommitContext)) {
+            $arguments = $this->processBuilder->createArgumentsForCommand('pint');
+            $arguments->addOptionalArgument('--config=%s', $config['config']);
+
+            $result = $this->runProcess($this->processBuilder->buildProcess($arguments), $context);
+            if ($result) {
+                return $result;
+            }
+
+            return TaskResult::createPassed($this, $context);
+        }
+
+        $files = $context->getFiles()->extensions($config['triggered_by']);
+        if (0 === \count($files)) {
+            return TaskResult::createSkipped($this, $context);
+        }
+
+        $arguments = $this->processBuilder->createArgumentsForCommand('pint');
+        $arguments->addOptionalArgument('--config=%s', $config['config']);
+
+        $arguments->addFiles($files);
+        $process = $this->processBuilder->buildProcess($arguments);
+
+        $result = $this->runProcess($process, $context);
+        if ($result) {
+            return $result;
+        }
+
+        $gitArgs = $this->processBuilder->createArgumentsForCommand('git');
+        $gitArgs->add('add');
+        $gitArgs->addFiles($files);
+
+        $gitProcess = $this->processBuilder->buildProcess($gitArgs);
+        $gitProcess->run();
+
+        if (! $gitProcess->isSuccessful()) {
+            return TaskResult::createFailed($this, $context, $this->formatter->format($process));
+        }
+
+        return TaskResult::createPassed($this, $context);
+    }
+}