aboutsummaryrefslogtreecommitdiffhomepage
path: root/scripts/linters/src/Linters/CargoWorkspaceDependencies.php
blob: 3ad86b6f4aa1dc60a248dcfbe8f6d0bb20a774ed (plain)
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
<?php

declare(strict_types=1);

namespace Shirabe\Lint\Linters;

use Shirabe\Lint\Linter;
use Shirabe\Lint\Support\FileFinder;
use Shirabe\Lint\Support\Paths;

final class CargoWorkspaceDependencies implements Linter
{
    private const SECTION_NAMES = ['dependencies', 'dev-dependencies', 'build-dependencies'];

    public function name(): string
    {
        return 'cargo_workspace_dependencies';
    }

    public function failureIntro(): string
    {
        return "Found `[dependencies]` / `[dev-dependencies]` entries that do not use `workspace = true`.\n"
            . 'In a crate `Cargo.toml`, only `name.workspace = true` or `name = { workspace = true, ... }` is allowed:';
    }

    public function check(string $rootDir, array $excludes): array
    {
        $errors = [];

        foreach (FileFinder::cargoTomls($rootDir) as $path) {
            $relative = Paths::relativeTo($rootDir, $path);
            if (in_array($relative, $excludes, true)) {
                continue;
            }

            array_push($errors, ...$this->findNonWorkspaceDeps($path, $relative));
        }

        return $errors;
    }

    /** @return list<string> */
    private function findNonWorkspaceDeps(string $path, string $relative): array
    {
        $errors = [];
        $currentSection = null;

        foreach (file($path) as $idx => $rawLine) {
            $stripped = trim($rawLine);

            if (preg_match('/\A\[([^\]]+)\]\z/', $stripped, $m)) {
                $currentSection = $m[1];
                continue;
            }

            if ($currentSection === null || !in_array($currentSection, self::SECTION_NAMES, true)) {
                continue;
            }
            if ($stripped === '' || str_starts_with($stripped, '#')) {
                continue;
            }

            if (preg_match('/\A([A-Za-z0-9_-]+)\.workspace\s*=\s*true\b/', $stripped)) {
                continue;
            }

            if (preg_match('/\A([A-Za-z0-9_-]+)\s*=\s*\{(.+)\}\s*\z/', $stripped, $m)) {
                [, $name, $inner] = $m;
                if (preg_match('/\bworkspace\s*=\s*true\b/', $inner)) {
                    continue;
                }
                $errors[] = "{$relative}:" . ($idx + 1) . ": `{$name}` does not use `workspace = true`";
                continue;
            }

            if (preg_match('/\A([A-Za-z0-9_-]+)\s*=/', $stripped, $m)) {
                $errors[] = "{$relative}:" . ($idx + 1) . ": `{$m[1]}` does not use `workspace = true`";
            }
        }

        return $errors;
    }
}