Sha256: 8a89f7bdae9ab134c5d419e3c0b8138deede535f9bcc60279c003b764399af8b
Contents?: true
Size: 1.96 KB
Versions: 3
Compression:
Stored size: 1.96 KB
Contents
module Danger # A danger plugin to check Swift formatting using SwiftFormat. # # @example Check that the added and modified files are properly formatted: # # swiftformat.check_format # # @see garriguv/danger-swiftformat # @tags swiftformat # class DangerSwiftformat < Plugin # The path to SwiftFormat's executable # # @return [String] attr_accessor :binary_path # Additional swiftformat command line arguments # # @return [String] attr_accessor :additional_args # Runs swiftformat # # @param [Boolean] fail_on_error # # @return [void] # def check_format(fail_on_error: false) # Check if SwiftFormat is installed raise "Could not find SwiftFormat executable" unless swiftformat.installed? # Find Swift files swift_files = find_swift_files # Stop processing if there are no swift files return if swift_files.empty? # Run swiftformat results = swiftformat.check_format(swift_files, additional_args) # Stop processing if the errors array is empty return if results[:errors].empty? # Process the errors message = "### SwiftFormat found issues:\n\n" message << "| File | Rules |\n" message << "| ---- | ----- |\n" results[:errors].each do |error| message << "| #{error[:file]} | #{error[:rules].join(', ')} |\n" end markdown message if fail_on_error fail "SwiftFormat found issues" end end # Find the files on which SwiftFormat should be run # # @return [Array<String] def find_swift_files files = (git.modified_files - git.deleted_files) + git.added_files files .select { |file| file.end_with?(".swift") } .map { |file| Shellwords.escape(file) } .uniq .sort end # Constructs the SwiftFormat class # # @return [SwiftFormat] def swiftformat SwiftFormat.new(binary_path) end end end
Version data entries
3 entries across 3 versions & 1 rubygems
Version | Path |
---|---|
danger-swiftformat-0.3.1 | lib/swiftformat/plugin.rb |
danger-swiftformat-0.3.0 | lib/swiftformat/plugin.rb |
danger-swiftformat-0.2.0 | lib/swiftformat/plugin.rb |