aboutsummaryrefslogtreecommitdiffhomepage
path: root/scripts/linters/cargo_workspace_dependencies.rb
blob: 85305c9ce646af805b6fd450842be4359a6483c3 (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
def cargo_workspace_dependencies(root_dir)
  pattern = root_dir.join('crates', '*', 'Cargo.toml').to_s
  errors = Dir.glob(pattern).sort.flat_map do |path|
    relative = Pathname.new(path).relative_path_from(root_dir).to_s
    find_non_workspace_deps(path, relative)
  end

  return true if errors.empty?

  puts 'Found `[dependencies]` / `[dev-dependencies]` entries that do not use `workspace = true`.'
  puts 'In a crate `Cargo.toml`, only `name.workspace = true` or `name = { workspace = true, ... }` is allowed:'
  errors.each do |err|
    puts "  #{err}"
  end
  false
end

def find_non_workspace_deps(path, relative)
  errors = []
  current_section = nil

  File.read(path).each_line.with_index do |raw_line, idx|
    stripped = raw_line.chomp.strip

    if stripped =~ /\A\[([^\]]+)\]\z/
      current_section = $1
      next
    end

    next unless %w[dependencies dev-dependencies build-dependencies].include?(current_section)
    next if stripped.empty? || stripped.start_with?('#')

    if stripped =~ /\A([A-Za-z0-9_-]+)\.workspace\s*=\s*true\b/
      next
    elsif stripped =~ /\A([A-Za-z0-9_-]+)\s*=\s*\{(.+)\}\s*\z/
      name = $1
      inner = $2
      next if inner =~ /\bworkspace\s*=\s*true\b/

      errors << "#{relative}:#{idx + 1}: `#{name}` does not use `workspace = true`"
    elsif stripped =~ /\A([A-Za-z0-9_-]+)\s*=/
      name = $1
      errors << "#{relative}:#{idx + 1}: `#{name}` does not use `workspace = true`"
    end
  end

  errors
end