Class: Fastlane::Actions::LintSwiftPackageAction

Inherits:
Action
  • Object
show all
Defined in:
lib/fastlane/plugin/stream_actions/actions/lint_swift_package.rb

Documentation collapse

Class Method Summary collapse

Class Method Details

.available_options ⇒ Object 



105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/fastlane/plugin/stream_actions/actions/lint_swift_package.rb', line 105

def self.available_options
  [
    FastlaneCore::ConfigItem.new(
      key: :swift_package_path,
      description: 'The path to your project Package.swift',
      is_string: true,
      default_value: './Package.swift',
      optional: false
    )
  ]
end

.dependency_violations(dependency) ⇒ Object 



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/fastlane/plugin/stream_actions/actions/lint_swift_package.rb', line 19

def self.dependency_violations(dependency)
  body = dependency[:body]
  violations = []
  if body =~ /\bbranch:/ || body.include?('.branch(')
    violations << violation(dependency, 'branch-based dependency — pin it with `from:` or `exact:` instead')
  end
  if body =~ /\brevision:/ || body.include?('.revision(')
    violations << violation(dependency, 'revision-pinned dependency — pin it with `from:` or `exact:` instead')
  end
  if body.include?('..<') || body =~ /"\s*\.\.\.\s*"/ || body.include?('.upToNextMinor(')
    violations << violation(dependency, 'version-range dependency — pin it with `from:` or `exact:` instead')
  end
  if body =~ /\bpath:/
    violations << violation(dependency, 'local path dependency — it will not resolve for package consumers')
  end
  if dependency[:url] && dependency[:url] !~ %r{\Ahttps://}
    violations << violation(dependency, 'insecure or non-https url — use `https://`')
  end
  if violations.empty? && body !~ /\b(from|exact):/ && !body.include?('.exact(') && !body.include?('.upToNextMajor(')
    violations << violation(dependency, 'missing version requirement — pin it with `from:` or `exact:`')
  end
  violations
end

.description ⇒ Object 



96
97
98
 
# File 'lib/fastlane/plugin/stream_actions/actions/lint_swift_package.rb', line 96

def self.description
  'Scans Package.swift for common mistakes in dependency declarations'
end

.details ⇒ Object 



100
101
102
103
 
# File 'lib/fastlane/plugin/stream_actions/actions/lint_swift_package.rb', line 100

def self.details
  'Fails if any dependency is declared via branch, revision, version range, local path, ' \
    'insecure url, or is duplicated. All dependencies should be pinned with `from:` or `exact:`.'
end

.duplicate_violations(dependencies) ⇒ Object 



43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/fastlane/plugin/stream_actions/actions/lint_swift_package.rb', line 43

def self.duplicate_violations(dependencies)
  dependencies
    .select { |dependency| dependency[:url] }
    .group_by { |dependency| dependency[:url].downcase.sub(/\.git\z/, '') }
    .values
    .select { |group| group.size > 1 }
    .map do |group|
      lines = group.map { |dependency| dependency[:line] }.join(', ')
      "- #{group.first[:url]} (lines #{lines}): duplicate dependency"
    end
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


117
118
119
 
# File 'lib/fastlane/plugin/stream_actions/actions/lint_swift_package.rb', line 117

def self.is_supported?(platform)
  true
end

.package_declarations(content) ⇒ Object 



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
 
# File 'lib/fastlane/plugin/stream_actions/actions/lint_swift_package.rb', line 60

def self.package_declarations(content)
  declarations = []
  offset = 0
  while (start = content.index('.package(', offset))
    body_start = start + 9 # '.package('.length
    index = body_start
    depth = 1
    in_string = false
    while index < content.length && depth > 0
      char = content[index]
      if in_string
        in_string = false if char == '"' && content[index - 1] != '\\'
      else
        case char
        when '"' then in_string = true
        when '(' then depth += 1
        when ')' then depth -= 1
        end
      end
      index += 1
    end
    body = content[body_start...(index - 1)]
    declarations << {
      body: body,
      url: body[/url:\s*"([^"]+)"/, 1],
      line: content[0..start].count("\n") + 1
    }
    offset = index
  end
  declarations
end

.run(params) ⇒ Object 



4
5
6
7
8
9
10
11
12
13
14
15
16
17
 
# File 'lib/fastlane/plugin/stream_actions/actions/lint_swift_package.rb', line 4

def self.run(params)
  path = params[:swift_package_path]
  UI.user_error!("Package.swift not found at path: #{path}") unless File.exist?(path)

  dependencies = package_declarations(File.read(path))
  violations = dependencies.flat_map { |dependency| dependency_violations(dependency) }
  violations += duplicate_violations(dependencies)

  if violations.any?
    UI.user_error!("Package.swift contains #{violations.size} dependency issue(s):\n#{violations.join("\n")}")
  end

  UI.success("Package.swift dependencies look good 🚀")
end

.violation(dependency, message) ⇒ Object 



55
56
57
58
 
# File 'lib/fastlane/plugin/stream_actions/actions/lint_swift_package.rb', line 55

def self.violation(dependency, message)
  location = dependency[:url] ? "#{dependency[:url]} (line #{dependency[:line]})" : "line #{dependency[:line]}"
  "- #{location}: #{message}"
end