grumphp/src/Task/Stylelint.php at v2.x · phpro/grumphp · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
<?php

declare(strict_types=1);

namespace GrumPHP\Task;

use GrumPHP\Collection\ProcessArgumentsCollection;
use GrumPHP\Fixer\Provider\FixableProcessResultProvider;
use GrumPHP\Formatter\ProcessFormatterInterface;
use GrumPHP\Runner\TaskResult;
use GrumPHP\Runner\TaskResultInterface;
use GrumPHP\Task\Config\ConfigOptionsResolver;
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;

/**
 * @extends AbstractExternalTask<ProcessFormatterInterface>
 */
class Stylelint extends AbstractExternalTask
{
    public static function getConfigurableOptions(): ConfigOptionsResolver
    {
        $resolver = new OptionsResolver();
        $resolver->setDefaults([
            // Task config options
            'bin' => null,
            'triggered_by' => ['css', 'scss', 'sass', 'less', 'sss'],
            'whitelist_patterns' => [],

            // Stylelint native config options
            'config' => null,
            'config_basedir' => null,
            'ignore_path' => null,
            'ignore_pattern' => null,
            'syntax' => null,
            'custom_syntax' => null,
            'ignore_disables' => null,
            'disable_default_ignores' => null,
            'cache' => null,
            'cache_location' => null,
            'formatter' => null,
            'custom_formatter' => null,
            'quiet' => null,
            'color' => null,
            'report_needless_disables' => null,
            'report_invalid_scope_disables' => null,
            'report_descriptionless_disables' => null,
            'max_warnings' => null,
            'output_file' => null,
        ]);

        // Task config options
        $resolver->addAllowedTypes('bin', ['null', 'string']);
        $resolver->addAllowedTypes('triggered_by', ['array']);
        $resolver->addAllowedTypes('whitelist_patterns', ['array']);

        // Stylelint native config options
        $resolver->addAllowedTypes('config', ['null', 'string']);
        $resolver->addAllowedTypes('config_basedir', ['null', 'string']);
        $resolver->addAllowedTypes('ignore_path', ['null', 'string']);
        $resolver->addAllowedTypes('ignore_pattern', ['null', 'string']);
        $resolver->addAllowedTypes('syntax', ['null', 'string']);
        $resolver->addAllowedTypes('custom_syntax', ['null', 'string']);
        $resolver->addAllowedTypes('ignore_disables', ['null', 'bool']);
        $resolver->addAllowedTypes('disable_default_ignores', ['null', 'bool']);
        $resolver->addAllowedTypes('cache', ['null', 'bool']);
        $resolver->addAllowedTypes('cache_location', ['null', 'string']);
        $resolver->addAllowedTypes('formatter', ['null', 'string']);
        $resolver->addAllowedTypes('custom_formatter', ['null', 'string']);
        $resolver->addAllowedTypes('quiet', ['null', 'bool']);
        $resolver->addAllowedTypes('color', ['null', 'bool']);
        $resolver->addAllowedTypes('report_needless_disables', ['null', 'bool']);
        $resolver->addAllowedTypes('report_invalid_scope_disables', ['null', 'bool']);
        $resolver->addAllowedTypes('report_descriptionless_disables', ['null', 'bool']);
        $resolver->addAllowedTypes('max_warnings', ['null', 'integer']);
        $resolver->addAllowedTypes('output_file', ['null', 'string']);

        return ConfigOptionsResolver::fromOptionsResolver($resolver);
    }

    public function canRunInContext(ContextInterface $context): bool
    {
        return ($context instanceof GitPreCommitContext || $context instanceof RunContext);
    }

    public function run(ContextInterface $context): TaskResultInterface
    {
        $config = $this->getConfig()->getOptions();

        $files = $context
            ->getFiles()
            ->paths($config['whitelist_patterns'])
            ->extensions($config['triggered_by']);

        if (0 === \count($files)) {
            return TaskResult::createSkipped($this, $context);
        }

        $arguments = isset($config['bin'])
            ? ProcessArgumentsCollection::forExecutable($config['bin'])
            : $this->processBuilder->createArgumentsForCommand('stylelint');

        $arguments->addOptionalArgument('--config=%s', $config['config']);
        $arguments->addOptionalArgument('--config-basedir=%s', $config['config_basedir']);
        $arguments->addOptionalArgument('--ignore-path=%s', $config['ignore_path']);
        $arguments->addOptionalArgument('--ignore-pattern=%s', $config['ignore_pattern']);
        $arguments->addOptionalArgument('--syntax=%s', $config['syntax']);
        $arguments->addOptionalArgument('--custom-syntax=%s', $config['custom_syntax']);
        $arguments->addOptionalArgument('--ignore-disables', $config['ignore_disables']);
        $arguments->addOptionalArgument('--disable-default-ignores', $config['disable_default_ignores']);
        $arguments->addOptionalArgument('--cache', $config['cache']);
        $arguments->addOptionalArgument('--cache-location=%s', $config['cache_location']);
        $arguments->addOptionalArgument('--formatter=%s', $config['formatter']);
        $arguments->addOptionalArgument('--custom-formatter=%s', $config['custom_formatter']);
        $arguments->addOptionalArgument('--quiet', $config['quiet']);
        $arguments->addOptionalBooleanArgument('--%s', $config['color'], 'color', 'no-color');
        $arguments->addOptionalArgument('--report-needless-disables', $config['report_needless_disables']);
        $arguments->addOptionalArgument('--report-invalid-scope-disables', $config['report_invalid_scope_disables']);
        $arguments->addOptionalArgument(
            '--report-descriptionless-disables',
            $config['report_descriptionless_disables']
        );
        $arguments->addOptionalIntegerArgument('--max-warnings=%d', $config['max_warnings']);
        $arguments->addOptionalArgument('--output-file=%s', $config['output_file']);
        $arguments->addFiles($files);

        $process = $this->processBuilder->buildProcess($arguments);
        $process->run();

        if (!$process->isSuccessful()) {
            return FixableProcessResultProvider::provide(
                TaskResult::createFailed($this, $context, $this->formatter->format($process)),
                function () use ($arguments): Process {
                    $arguments->add('--fix');
                    return $this->processBuilder->buildProcess($arguments);
                }
            );
        }

        return TaskResult::createPassed($this, $context);
    }
}