fastlane-plugin-npm 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fd934fcc7364a6ea35c25b152feb8e99b4fb31356991b4f541b7c344c973f7bc
+  data.tar.gz: dd77a9c60180186ce5df50334ab25fccbc14adc456c78fd42267dc009c24f0a6
+SHA512:
+  metadata.gz: aa002fba732679883ba2cb8414c059b80b1cc6fbee72eeeb839b93d057c4f7fb3932f795ce3c5ea659580570e3334e51c07a0928f55f687aa330c780fdec2278
+  data.tar.gz: c59ab6c570d6f398b026891eaad20a3600973772084f95bb3eff930d82c4988fdb199e65e0fa71459733b3737b5c762a3baa0cb690b9fcefaf96009e526e860a

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Erick Martins <ericknmp@gmail.com>
+
+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,52 @@
+# npm plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-npm)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-npm`, add it to your project by running:
+
+```bash
+fastlane add_plugin npm
+```
+
+## About npm
+
+A very simple plugin to run npm scripts
+
+**Note to author:** Add a more detailed description about this plugin here. If your plugin contains multiple actions, make sure to mention them here.
+
+## Example
+
+Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test`.
+
+**Note to author:** Please set up a sample project to make it easy for users to explore what your plugin does. Provide everything that is necessary to try out the plugin in this project (including a sample Xcode/Android project if necessary)
+
+## Run tests for this plugin
+
+To run both the tests, and code style validation, run
+
+```
+rake
+```
+
+To automatically fix many of the styling issues, use
+```
+rubocop -a
+```
+
+## Issues and Feedback
+
+For any other issues and feedback about this plugin, please submit it to this repository.
+
+## Troubleshooting
+
+If you have trouble using plugins, check out the [Plugins Troubleshooting](https://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide.
+
+## 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/npm/actions/npm_install_action.rb

@@ -0,0 +1,76 @@
+require 'fastlane/action'
+require_relative '../helper/npm_helper'
+
+module Fastlane
+  module Actions
+    class NpmInstallAction < Action
+      def self.run(params)
+        # rm may exit with non zero in the case where there is no node_modules and that's what we want anyway
+        FastlaneCore::CommandExecutor.execute(command: 'rm -rf ../node_modules 2> /dev/null',
+                                        print_command: FastlaneCore::Globals.verbose?,
+                                            print_all: FastlaneCore::Globals.verbose?)
+                                            
+        other_action.npm_run(
+          script: 'install', 
+          step_name: params[:step_name],
+          arguments: params[:arguments]
+        )
+
+        other_action.npm_post_install if params[:post_install_after]
+      end
+
+      def self.description
+        "A very simple plugin to run npm scripts"
+      end
+
+      def self.authors
+        ["Erick Martins"]
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.details
+        # Optional:
+        "A very simple plugin to run npm scripts"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :step_name,
+                             default_value: "Installing dependencies",
+                               description: "Name for this step",
+                                  optional: true,
+                                      type: String),
+
+          FastlaneCore::ConfigItem.new(key: :clean,
+                             default_value: false,
+                               description: "Deletes node_modules folder",
+                                  optional: true,
+                                      type: Boolean),
+
+          FastlaneCore::ConfigItem.new(key: :arguments,
+                              default_value: [],
+                                description: "Script arguments",
+                                  optional: true,
+                                      type: Array),
+
+          FastlaneCore::ConfigItem.new(key: :post_install_after,
+                             default_value: false,
+                               description: "Run postinstall script right after",
+                                  optional: true,
+                                      type: Boolean),
+        ]
+      end
+
+      def self.is_supported?(platform)
+        # Adjust this if your plugin only works for a particular platform (iOS vs. Android, for example)
+        # See: https://docs.fastlane.tools/advanced/#control-configuration-by-lane-and-by-platform
+        #
+        # [:ios, :mac, :android].include?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/npm/actions/npm_lint_action.rb

@@ -0,0 +1,63 @@
+require 'fastlane/action'
+require_relative '../helper/npm_helper'
+
+module Fastlane
+  module Actions
+    class NpmLintAction < Action
+      def self.run(params)
+        other_action.npm_run(
+          script: 'lint', 
+          step_name: params[:step_name],
+          arguments: params[:arguments]
+        )
+      end
+
+      def self.description
+        "A very simple plugin to run npm scripts"
+      end
+
+      def self.authors
+        ["Erick Martins"]
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.details
+        # Optional:
+        "A very simple plugin to run npm scripts"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :script,
+                             default_value: 'lint',
+                               description: "Lint script",
+                                  optional: true,
+                                      type: String),
+
+          FastlaneCore::ConfigItem.new(key: :arguments,
+                              default_value: [],
+                                description: "Script arguments",
+                                  optional: true,
+                                      type: Array),
+
+          FastlaneCore::ConfigItem.new(key: :step_name,
+                             default_value: "Running lint script",
+                               description: "Name for this step",
+                                  optional: true,
+                                      type: String),
+        ]
+      end
+
+      def self.is_supported?(platform)
+        # Adjust this if your plugin only works for a particular platform (iOS vs. Android, for example)
+        # See: https://docs.fastlane.tools/advanced/#control-configuration-by-lane-and-by-platform
+        #
+        # [:ios, :mac, :android].include?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/npm/actions/npm_post_install_action.rb

@@ -0,0 +1,57 @@
+require 'fastlane/action'
+require_relative '../helper/npm_helper'
+
+module Fastlane
+  module Actions
+    class NpmPostInstallAction < Action
+      def self.run(params)
+        other_action.npm_run(
+          script: 'postinstall', 
+          step_name: params[:step_name],
+          arguments: params[:arguments]
+        )
+      end
+
+      def self.description
+        "A very simple plugin to run npm scripts"
+      end
+
+      def self.authors
+        ["Erick Martins"]
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.details
+        # Optional:
+        "A very simple plugin to run npm scripts"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :step_name,
+                             default_value: "Running npm post install script",
+                               description: "Name for this step",
+                                  optional: true,
+                                      type: String),
+
+          FastlaneCore::ConfigItem.new(key: :arguments,
+                              default_value: [],
+                                description: "Script arguments",
+                                  optional: true,
+                                      type: Array),
+        ]
+      end
+
+      def self.is_supported?(platform)
+        # Adjust this if your plugin only works for a particular platform (iOS vs. Android, for example)
+        # See: https://docs.fastlane.tools/advanced/#control-configuration-by-lane-and-by-platform
+        #
+        # [:ios, :mac, :android].include?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/npm/actions/npm_run_action.rb

@@ -0,0 +1,64 @@
+require 'fastlane/action'
+require_relative '../helper/npm_helper'
+
+module Fastlane
+  module Actions
+    class NpmRunAction < Action
+      def self.run(params)
+        command = ['npm', 'run', params[:script]]
+        command = ['npm', params[:script]] if ['install', 'test'].include? params[:script]
+
+        command.concat params[:arguments]
+
+        FastlaneCore::CommandExecutor.execute(command: command.join(' '),
+                                        print_command: FastlaneCore::Globals.verbose?,
+                                            print_all: true)
+      end
+
+      def self.description
+        "A very simple plugin to run npm scripts"
+      end
+
+      def self.authors
+        ["Erick Martins"]
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.details
+        # Optional:
+        "A very simple plugin to run npm scripts"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :script,
+                               description: "Script to run",
+                                  optional: false,
+                                      type: String),
+          
+          FastlaneCore::ConfigItem.new(key: :arguments,
+                             default_value: [],
+                               description: "Script arguments",
+                                  optional: true,
+                                      type: Array),
+
+          FastlaneCore::ConfigItem.new(key: :step_name,
+                               description: "Name for this step",
+                                  optional: true,
+                                      type: String),
+        ]
+      end
+
+      def self.is_supported?(platform)
+        # Adjust this if your plugin only works for a particular platform (iOS vs. Android, for example)
+        # See: https://docs.fastlane.tools/advanced/#control-configuration-by-lane-and-by-platform
+        #
+        # [:ios, :mac, :android].include?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/npm/actions/npm_test_action.rb

@@ -0,0 +1,74 @@
+require 'fastlane/action'
+require_relative '../helper/npm_helper'
+
+module Fastlane
+  module Actions
+    class NpmTestAction < Action
+      def self.run(params)
+        arguments = []
+        arguments = ['--coverage'] if params[:coverage]
+        arguments.concat params[:arguments]
+
+        other_action.npm_run(
+          script: 'test', 
+          step_name: params[:step_name],
+          arguments: params[:arguments]
+
+        )
+      end
+
+      def self.description
+        "A very simple plugin to run npm scripts"
+      end
+
+      def self.authors
+        ["Erick Martins"]
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.details
+        # Optional:
+        "A very simple plugin to run npm scripts"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :script,
+                             default_value: 'test',
+                               description: "Test script",
+                                  optional: true,
+                                      type: String),
+          
+          FastlaneCore::ConfigItem.new(key: :arguments,
+                              default_value: [],
+                                description: "Script arguments",
+                                  optional: true,
+                                      type: Array),
+
+          FastlaneCore::ConfigItem.new(key: :coverage,
+                              default_value: false,
+                                description: "With coverage",
+                                  optional: true,
+                                      type: Boolean),
+
+          FastlaneCore::ConfigItem.new(key: :step_name,
+                             default_value: "Running tests",
+                               description: "Name for this step",
+                                  optional: true,
+                                      type: String),
+        ]
+      end
+
+      def self.is_supported?(platform)
+        # Adjust this if your plugin only works for a particular platform (iOS vs. Android, for example)
+        # See: https://docs.fastlane.tools/advanced/#control-configuration-by-lane-and-by-platform
+        #
+        # [:ios, :mac, :android].include?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/npm/helper/npm_helper.rb

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

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

@@ -0,0 +1,5 @@
+module Fastlane
+  module Npm
+    VERSION = "0.2.0"
+  end
+end

data/lib/fastlane/plugin/npm.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/npm/version'
+
+module Fastlane
+  module Npm
+    # 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::Npm.all_classes.each do |current|
+  require current
+end

metadata

@@ -0,0 +1,178 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-npm
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Erick Martins
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-08-26 00:00:00.000000000 Z
+dependencies:
+- !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: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.99.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.99.0
+- !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: 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: 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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.12.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.12.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'
+description:
+email: ericknmp@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/npm.rb
+- lib/fastlane/plugin/npm/actions/npm_install_action.rb
+- lib/fastlane/plugin/npm/actions/npm_lint_action.rb
+- lib/fastlane/plugin/npm/actions/npm_post_install_action.rb
+- lib/fastlane/plugin/npm/actions/npm_run_action.rb
+- lib/fastlane/plugin/npm/actions/npm_test_action.rb
+- lib/fastlane/plugin/npm/helper/npm_helper.rb
+- lib/fastlane/plugin/npm/version.rb
+homepage: https://github.com/erick-martins/fastlane-plugin-npm
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.4
+signing_key:
+specification_version: 4
+summary: A very simple plugin to run npm scripts
+test_files: []