feat: laravel lint

Author: shaunthegeek

.github/workflows/laravel-6.yml

@@ -0,0 +1,30 @@
+name: Laravel 6
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+jobs:
+  test:
+    name: Test
+    runs-on: ubuntu-18.04
+    container:
+      image: php:7.4-cli
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: PHPUnit
+        run: |
+          apt update
+          apt install -y libzip-dev unzip
+          pecl install xdebug
+          docker-php-ext-enable xdebug
+          curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer
+          composer require orchestra/testbench:^v4 --dev
+          ./vendor/bin/phpunit --coverage-clover coverage.xml --coverage-filter src/ tests/
+      - name: codecov
+        uses: codecov/codecov-action@v1
+        with:
+          name: laravel-6

.github/workflows/laravel-7.yml

@@ -0,0 +1,30 @@
+name: Laravel 7
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+jobs:
+  test:
+    name: Test
+    runs-on: ubuntu-18.04
+    container:
+      image: php:7.4-cli
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: PHPUnit
+        run: |
+          apt update
+          apt install -y libzip-dev unzip
+          pecl install xdebug
+          docker-php-ext-enable xdebug
+          curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer
+          composer require orchestra/testbench:^v5 --dev
+          ./vendor/bin/phpunit --coverage-clover coverage.xml --coverage-filter src/ tests/
+      - name: codecov
+        uses: codecov/codecov-action@v1
+        with:
+          name: laravel-6

.gitignore

@@ -0,0 +1,3 @@
+/.idea/
+/composer.lock
+/vendor/

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Laravel Fans
+
+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,27 @@
+# Laravel Lint
+
+[![codecov](https://codecov.io/gh/laravel-fans/laravel-lint/branch/main/graph/badge.svg)](https://codecov.io/gh/laravel-fans/laravel-lint)
+[![Laravel 6](https://github.com/laravel-fans/laravel-lint/workflows/Laravel%206/badge.svg)](https://github.com/laravel-fans/laravel-lint/actions)
+[![Laravel 7](https://github.com/laravel-fans/laravel-lint/workflows/Laravel%207/badge.svg)](https://github.com/laravel-fans/laravel-lint/actions)
+
+Check Code Style(default PSR-12) for Laravel
+
+## install
+
+Run in your Laravel project:
+
+```shell
+composer install --dev laravel-fans/lint
+php artisan lint:publish
+```
+
+## use
+
+```shell
+php artisan lint:check .
+php artisan lint:check app/ tests/
+php artisan lint:check --standard=Squiz app/
+php artisan lint:staged
+```
+
+The default standard is PSR-12, feel free to change the `phpcs.xml`.

composer.json

@@ -0,0 +1,38 @@
+{
+    "name": "laravel-fans/lint",
+    "description": "Laravel Lint Code Style",
+    "type": "library",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "sinkcup",
+            "email": "[email protected]"
+        }
+    ],
+    "autoload": {
+        "psr-4": {
+            "LaravelFans\\Lint\\": "src"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "App\\": "vendor/orchestra/testbench-core/laravel/app/",
+            "LaravelFans\\Lint\\Tests\\": "tests/"
+        }
+    },
+    "extra": {
+        "laravel": {
+            "providers": [
+                "LaravelFans\\Lint\\LintServiceProvider"
+            ]
+        }
+    },
+    "minimum-stability": "stable",
+    "require": {
+        "laravel/framework": ">=v6.18.38",
+        "squizlabs/php_codesniffer": "^3.5"
+    },
+    "require-dev": {
+        "orchestra/testbench": ">=v4.8.0"
+    }
+}

src/LintCheckCommand.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace LaravelFans\Lint;
+
+use FilesystemIterator;
+use Illuminate\Console\Command;
+use Illuminate\Support\Facades\File;
+
+class LintCheckCommand extends Command
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'lint:check
+        {files*}
+        {--standard=phpcs.xml : coding standards}';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Lint files';
+
+    /**
+     * Execute the console command.
+     *
+     * @return void
+     */
+    public function handle()
+    {
+        exec(
+            'vendor/bin/phpcs --standard=' . $this->option('standard')
+            . ' ' . implode(' ', $this->argument('files')),
+            $output,
+            $code
+        );
+        foreach ($output as $line) {
+            $this->line($line);
+        }
+        return $code;
+    }
+}

src/LintPublishCommand.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace LaravelFans\Lint;
+
+use FilesystemIterator;
+use Illuminate\Console\Command;
+use Illuminate\Support\Facades\File;
+
+class LintPublishCommand extends Command
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'lint:publish';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Publish Lint config files';
+
+    /**
+     * Execute the console command.
+     *
+     * @return void
+     */
+    public function handle()
+    {
+        $basePath = $this->laravel->basePath();
+
+        File::copy(__DIR__ . '/stubs/phpcs.xml', $basePath . '/phpcs.xml');
+        if (File::exists($basePath . '/.git')) {
+            File::copy(__DIR__ . '/stubs/git-pre-commit', $basePath . '/.git/hooks/pre-commit');
+            File::chmod($basePath . '/.git/hooks/pre-commit', 0755);
+        }
+
+        $this->info('published successfully.');
+    }
+}

src/LintServiceProvider.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace LaravelFans\Lint;
+
+use Illuminate\Support\ServiceProvider;
+
+class LintServiceProvider extends ServiceProvider
+{
+    /**
+     * Bootstrap any application services.
+     *
+     * @return void
+     */
+    public function boot()
+    {
+        if ($this->app->runningInConsole()) {
+            $this->commands([
+                LintCheckCommand::class,
+                LintPublishCommand::class,
+                LintStagedCommand::class,
+            ]);
+        }
+    }
+
+    /**
+     * Get the services provided by the provider.
+     *
+     * @return array
+     */
+    public function provides()
+    {
+        return [
+            LintCheckCommand::class,
+            LintPublishCommand::class,
+            LintStagedCommand::class,
+        ];
+    }
+}

src/LintStagedCommand.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace LaravelFans\Lint;
+
+use FilesystemIterator;
+use Illuminate\Console\Command;
+use Illuminate\Support\Facades\File;
+
+class LintStagedCommand extends Command
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'lint:staged';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Lint git staged files';
+
+    /**
+     * Execute the console command.
+     *
+     * @return void
+     */
+    public function handle()
+    {
+        exec('.git/hooks/pre-commit', $output, $code);
+        foreach ($output as $line) {
+            $this->line($line);
+        }
+        return $code;
+    }
+}