fastlane-plugin-swiftformat 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e72acfd10fcf8470ad31b0201f0dd372f605b4e2
+  data.tar.gz: 517c364dc1d4cb78c13ac15be61eff9bd5a8780d
+SHA512:
+  metadata.gz: 71995b5bda7b711ca58d8c2dd0ace837ae1b9f39ceef2e4b10c18c7b8772b51317d2a2034e9b5e311baf1726c5e4b2f623412b2ae619bf66e53c16a690277d15
+  data.tar.gz: 874f0c92fd85c735a46604201c2d0ab00c3d5268e7b61eb38d60695b7bd1466b3e297c7e2f126b7b3555089314041f9d0051be6a0e5641fe26265ccd7c977d08

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Felix Mau <me@felix.hamburg>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,50 @@
+# fastlane-plugin-swiftformat
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-swiftformat)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-swiftformat`, add it to your project by running:
+
+```bash
+gem "fastlane-plugin-swiftformat", git: "https://github.com/fxm90/fastlane-plugin-swiftformat"
+```
+
+## About fastlane-plugin-swiftformat
+
+Run swift code formatting using [SwiftFormat](https://github.com/nicklockwood/SwiftFormat) with fastlane. An up-to-date list with all available rules can be found in [Rules.md](https://github.com/nicklockwood/SwiftFormat/blob/master/Rules.md) along with documentation for how they are used.
+
+##### Example Code
+```ruby
+swiftformat(
+  executable: "Pods/SwiftFormat/CommandLineTool/swiftformat", # Path to the `swiftformat` executable on your machine (optional)
+  path: "path/to/format",                                     # Path to format (optional)
+  rules: "indent,linebreaks",                                 # Specify a whitelist of rules (optional)
+  disable: "redundantSelf,trailingClosures",                  # Specify rules to disable (optional)
+  enable: "isEmpty",                                          # Specify rules to enable (optional)
+  swiftversion: "5.1"                                         # Specify swift version (optional)
+  config: "path/to/configuration/.swiftformat"                # Path to configuration file (optional)
+  dryrun: false,                                              # Run in dry mode (without actually changing any files) (optional)
+  lint: true                                                  # Like `--dryrun`, but returns an error if formatting is needed (optional)
+)
+```
+
+## Run tests for this plugin
+
+To run both the tests, and code style validation, run
+
+```
+rake
+```
+
+## Issues and Feedback
+
+For any other issues and feedback about this plugin, please submit it to this repository.
+
+## Using _fastlane_ Plugins
+
+For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://docs.fastlane.tools/plugins/create-plugin/).
+
+## About _fastlane_
+
+_fastlane_ is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).

data/lib/fastlane/plugin/swiftformat.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/swiftformat/version'
+
+module Fastlane
+  module Swiftformat
+    # Return all .rb files inside the "actions" and "helper" directory
+    def self.all_classes
+      Dir[File.expand_path('**/{actions,helper}/*.rb', File.dirname(__FILE__))]
+    end
+  end
+end
+
+# By default we want to import all available actions and helpers
+# A plugin can contain any number of actions and plugins
+Fastlane::Swiftformat.all_classes.each do |current|
+  require current
+end

data/lib/fastlane/plugin/swiftformat/actions/swiftformat_action.rb

@@ -0,0 +1,135 @@
+require 'fastlane/action'
+require_relative '../helper/swiftformat_helper'
+
+module Fastlane
+  module Actions
+    class SwiftformatAction < Action
+      def self.run(params)
+        if `which swiftformat`.to_s.length == 0 && params[:executable].nil? && !Helper.test?
+          UI.user_error!("You have to install swiftformat using `brew install swiftformat` or specify the executable path with the `:executable` option.")
+        end
+
+        command = ""
+        if params[:executable]
+          command << params[:executable]
+        else
+          command << "swiftformat"
+        end
+
+        if params[:path]
+          command << " #{params[:path].shellescape}"
+        else
+          command << " ."
+        end
+
+        command << " --rules #{params[:rules].shellescape}" if params[:rules]
+        command << " --disable #{params[:disable].shellescape}" if params[:disable]
+        command << " --enable #{params[:enable].shellescape}" if params[:enable]
+
+        command << " --swiftversion #{params[:swiftversion].shellescape}" if params[:swiftversion]
+        command << " --config #{params[:config].shellescape}" if params[:config]
+
+        command << " --dryrun" if params[:dryrun]
+        command << " --lint" if params[:lint]
+
+        Actions.sh(command)
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Run swift code formatting using SwiftFormat"
+      end
+
+      def self.details
+        "Run swift code formatting using [SwiftFormat](https://github.com/nicklockwood/SwiftFormat). Please specify your options using a `.swiftformat` file.  An up-to-date list with all available rules can be found in [Rules.md](https://github.com/nicklockwood/SwiftFormat/blob/master/Rules.md) along with documentation for how they are used."
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :executable,
+                                       description: "Path to the `swiftformat` executable on your machine",
+                                       is_string: true,
+                                       optional: true,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Couldn't find path '#{File.expand_path(value)}'") unless File.exist?(value) || Helper.test?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :path,
+                                       description: "Path to format",
+                                       is_string: true,
+                                       optional: true,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Couldn't find path '#{File.expand_path(value)}'") unless File.exist?(value) || Helper.test?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :rules,
+                                       description: "Specify a whitelist of rules",
+                                       is_string: false,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :disable,
+                                       description: "Specify rules to disable",
+                                       is_string: false,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :enable,
+                                       description: "Specify rules to enable",
+                                       is_string: false,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :swiftversion,
+                                       description: "Specify swift version",
+                                       is_string: false,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :config,
+                                       description: "Path to configuration file",
+                                       is_string: true,
+                                       optional: true,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Couldn't find path '#{File.expand_path(value)}'") unless File.exist?(value) || Helper.test?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :dryrun,
+                                       description: "Run in dry mode (without actually changing any files)",
+                                       is_string: false,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :lint,
+                                       description: "Like `--dryrun`, but returns an error if formatting is needed",
+                                       is_string: false,
+                                       optional: true)
+        ]
+      end
+
+      def self.output
+      end
+
+      def self.return_value
+      end
+
+      def self.authors
+        ["fxm90"]
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :mac].include?(platform)
+      end
+
+      def self.example_code
+        [
+          'swiftformat(
+            executable: "Pods/SwiftFormat/CommandLineTool/swiftformat", # Path to the `swiftformat` executable on your machine (optional)
+            path: "path/to/format",                                     # Path to format (optional)
+            rules: "indent,linebreaks",                                 # Specify a whitelist of rules (optional)
+            disable: "redundantSelf,trailingClosures",                  # Specify rules to disable (optional)
+            enable: "isEmpty",                                          # Specify rules to enable (optional)
+            swiftversion: "5.1"                                         # Specify swift version (optional)
+            config: "path/to/configuration/.swiftformat"                # Path to configuration file (optional)
+            dryrun: false,                                              # Run in dry mode (without actually changing any files) (optional)
+            lint: true                                                  # Like `--dryrun`, but returns an error if formatting is needed (optional)
+          )'
+        ]
+      end
+
+      def self.category
+        :testing
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/swiftformat/helper/swiftformat_helper.rb

@@ -0,0 +1,16 @@
+require 'fastlane_core/ui/ui'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
+
+  module Helper
+    class SwiftformatHelper
+      # class methods that you define here become available in your action
+      # as `Helper::SwiftformatHelper.your_method`
+      #
+      def self.show_message
+        UI.message("Hello from the swiftformat plugin helper!")
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/swiftformat/version.rb

@@ -0,0 +1,5 @@
+module Fastlane
+  module Swiftformat
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-swiftformat
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Felix Mau
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-require_tools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.141.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.141.0
+description: 
+email: me@felix.hamburg
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/swiftformat.rb
+- lib/fastlane/plugin/swiftformat/actions/swiftformat_action.rb
+- lib/fastlane/plugin/swiftformat/helper/swiftformat_helper.rb
+- lib/fastlane/plugin/swiftformat/version.rb
+homepage: https://github.com/fxm90/fastlane-plugin-swiftformat
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.3
+signing_key: 
+specification_version: 4
+summary: Run swift code formatting using SwiftFormat
+test_files: []