fastlane-plugin-npm 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd934fcc7364a6ea35c25b152feb8e99b4fb31356991b4f541b7c344c973f7bc
-  data.tar.gz: dd77a9c60180186ce5df50334ab25fccbc14adc456c78fd42267dc009c24f0a6
+  metadata.gz: e7dfd78f976bdccb3f211411f1f2a4fd1a0a7164fa16df9d08c345827bfd8657
+  data.tar.gz: 2963aaa3f6614d7519bf7a87fb943b93364e889d22215ad1f9757206cad92907
 SHA512:
-  metadata.gz: aa002fba732679883ba2cb8414c059b80b1cc6fbee72eeeb839b93d057c4f7fb3932f795ce3c5ea659580570e3334e51c07a0928f55f687aa330c780fdec2278
-  data.tar.gz: c59ab6c570d6f398b026891eaad20a3600973772084f95bb3eff930d82c4988fdb199e65e0fa71459733b3737b5c762a3baa0cb690b9fcefaf96009e526e860a
+  metadata.gz: 509914010d6058f61803e8f970fe85c991bdb634a9d04f5e92fc69773144df3fe87b5bb44b47457c3d4de1fa781e23eb22f6818cae9a744f6f84582aa9cb4409
+  data.tar.gz: 479ec44e3309fc5df03ccc27f6ccd3299f69bb089e35c7c6ae2f29cb6866e18e966cb1a0656e9a0dad087fe3b0367a6d1fb514d52db6b9fe0075d968e4a0f1f3

data/README.md

@@ -2,6 +2,8 @@
 
 [![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:
@@ -10,43 +12,90 @@ This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To
 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)
 
+## Actions
+
+```ruby
+lane :test do
+  npm_install(
+    fresh: true,                            # [Optional] Boolean: Defines if modules should be fresh instaled. Deletes node_modules folder (Default: false)
+    arguments: [],                          # [Optional] Array: List of arguments
+    step_name: 'Starting with reset cache'  # [Optional] String: Text that will be printed into the console
+  )
+
+  npm_post_install(
+    arguments: [],                          # [Optional] Array: List of arguments
+    step_name: 'Starting with reset cache'  # [Optional] String: Text that will be printed into the console
+  )
+
+  npm_lint(
+    script: 'lint',                         # [Optional] String: Overrides default lint script name (Default: lint)
+    fix: true,                              # [Optional] Boolean: Adds a --fix flag (Default: false)
+    arguments: [],                          # [Optional] Array: List of arguments
+    step_name: 'Starting with reset cache'  # [Optional] String: Text that will be printed into the console
+  )
+
+  npm_test(
+    script: 'test',                         # [Optional] String: Overrides default test script name (Default: test)
+    coverage: true,                         # [Optional] Boolean: Adds a --coverage flag (Default: false)
+    arguments: [],                          # [Optional] Array: List of arguments
+    step_name: 'Starting with reset cache'  # [Optional] String: Text that will be printed into the console
+  )
+
+  npm_run(
+    script: 'start',                        # [Required] String: Script to run
+    arguments: ['--reset-cache'],           # [Optional] Array: List of arguments
+    step_name: 'Starting with reset cache'  # [Optional] String: Text that will be printed into the console
+  )
+
+  upgrade_package_json_version(
+    new_version: "1.5.0",                  # [Required] String: Version to set
+    version_match: "(\d+\.\d+\.\d+)"       # [Optional] String: Regex as a string to match the version in the package.json (Default: "(\d+\.\d+\.\d+)")
+  )
+end
+```
 ## Run tests for this plugin
 
 To run both the tests, and code style validation, run
 
-```
+```bash
 rake
 ```
 
 To automatically fix many of the styling issues, use
-```
+```bash
 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

@@ -6,17 +6,23 @@ module Fastlane
     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?)
-                                            
+        if params[:fresh]
+          UI.important('Deleting node modules and installing packages')
+          
+          root_dir = Helper::NpmHelper.find_root_dir
+          node_module_dir = File.join(root_dir, 'node_modules')
+
+          FastlaneCore::CommandExecutor.execute(command: "rm -rf \"#{node_module_dir}\" 2> /dev/null",
+                                          print_command: FastlaneCore::Globals.verbose?,
+                                              print_all: FastlaneCore::Globals.verbose?)
+        end
+        
+
         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
@@ -44,7 +50,7 @@ module Fastlane
                                   optional: true,
                                       type: String),
 
-          FastlaneCore::ConfigItem.new(key: :clean,
+          FastlaneCore::ConfigItem.new(key: :fresh,
                              default_value: false,
                                description: "Deletes node_modules folder",
                                   optional: true,
@@ -55,12 +61,6 @@ module Fastlane
                                 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
 

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

@@ -5,15 +5,19 @@ module Fastlane
   module Actions
     class NpmLintAction < Action
       def self.run(params)
+        arguments = []
+        arguments = ['--fix'] if params[:fix]
+        arguments.concat params[:arguments]
+
         other_action.npm_run(
           script: 'lint', 
           step_name: params[:step_name],
-          arguments: params[:arguments]
+          arguments: arguments
         )
       end
 
       def self.description
-        "A very simple plugin to run npm scripts"
+        "Runs lint script"
       end
 
       def self.authors
@@ -37,6 +41,12 @@ module Fastlane
                                   optional: true,
                                       type: String),
 
+          FastlaneCore::ConfigItem.new(key: :fix,
+                             default_value: false,
+                               description: "Run postinstall script right after",
+                                  optional: true,
+                                      type: Boolean),
+
           FastlaneCore::ConfigItem.new(key: :arguments,
                               default_value: [],
                                 description: "Script arguments",

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

@@ -5,8 +5,10 @@ module Fastlane
   module Actions
     class NpmRunAction < Action
       def self.run(params)
+        UI.message(params[:step_name])
+        
         command = ['npm', 'run', params[:script]]
-        command = ['npm', params[:script]] if ['install', 'test'].include? params[:script]
+        command = ['npm', params[:script]] if ['install', 'test', 'start'].include? params[:script]
 
         command.concat params[:arguments]
 

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

@@ -0,0 +1,66 @@
+require 'fastlane/action'
+require_relative '../helper/npm_helper'
+
+module Fastlane
+  module Actions
+    class UpgradePackageJsonVersionAction < Action
+      def self.run(params)
+        UI.message "Changing package.json version to #{params[:new_version]}"
+        root_dir = Helper::NpmHelper.find_root_dir
+
+        UI.user_error! "apparently it's not running inside a node project. package.json cannot be found" unless root_dir
+
+        package_json_path = File.join(root_dir, 'package.json')
+
+        regex = Regexp.new("\"version\": \"#{params[:version_match]}\"")
+        
+        Helper::NpmHelper.update_file_content(
+          file_name: package_json_path, 
+          search: regex, 
+          replace: "\"version\": \"#{params[:new_version]}\""
+        )
+      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: :new_version,
+                             default_value: "Installing dependencies",
+                               description: "Name for this step",
+                                  optional: true,
+                                      type: String),
+
+          FastlaneCore::ConfigItem.new(key: :version_match,
+                              default_value: '(\d+\.\d+\.\d+)',
+                                description: "Regex to match the version",
+                                  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

@@ -5,12 +5,22 @@ module Fastlane
 
   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!")
+      def self.find_root_dir(dir = Dir.pwd)
+        return dir if File.file?(File.join(dir, 'package.json'))
+    
+        parent_dir = File.expand_path("..", dir)
+        return nil unless parent_dir != '/'
+      
+        find_root_dir parent_dir
       end
+
+      def self.update_file_content(file_name:, search:, replace:)
+        text = File.read(file_name)
+        new_contents = text.gsub(search, replace)
+
+        # To write changes to the file, use:
+        File.open(file_name, "w") {|file| file.puts new_contents }
+      end 
     end
   end
 end

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

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-npm
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Erick Martins
@@ -150,6 +150,7 @@ files:
 - 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/actions/upgrade_package_json_version_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