Package manager detection

Author: navidemad

lib/install/bootstrap/install.rb

@@ -37,7 +37,7 @@
 add_package_json_script("build:css:compile", "sass ./app/assets/stylesheets/application.bootstrap.scss:./app/assets/builds/application.css --no-source-map --load-path=node_modules")
 add_package_json_script("build:css:prefix", "postcss ./app/assets/builds/application.css --use=autoprefixer --output=./app/assets/builds/application.css")
 add_package_json_script("build:css", "#{bundler_run_cmd} build:css:compile && #{bundler_run_cmd} build:css:prefix")
-add_package_json_script("watch:css", "nodemon --watch ./app/assets/stylesheets/ --ext scss --exec \\\"#{bundler_run_cmd} build:css\\\"", false)
+add_package_json_script("watch:css", "nodemon --watch ./app/assets/stylesheets/ --ext scss --exec \\\"#{bundler_run_cmd} build:css\\\"", run_script: false)
 
 gsub_file "Procfile.dev", "build:css --watch", "watch:css"
 

lib/install/helpers.rb

@@ -1,48 +1,129 @@
+# frozen_string_literal: true
+
 require 'json'
 
 module Helpers
+  SUPPORTED_PACKAGE_MANAGERS = %i[yarn npm pnpm bun].freeze
+  UNSUPPORTED_PACKAGE_MANAGER_ERROR_MESSAGE = "No supported package manager (#{SUPPORTED_PACKAGE_MANAGERS.join(', ')}) found. Please install one."
+
+  PM_COMMANDS = {
+    yarn: { cmd: 'yarn', run: 'yarn', x: 'npx' },
+    npm: { cmd: 'npm', run: 'npm run', x: 'npx' },
+    pnpm: { cmd: 'pnpm', run: 'pnpm run', x: 'pnpx' },
+    bun: { cmd: 'bun', run: 'bun run', x: 'bunx' }
+  }.freeze
+
+  SCRIPT_STRATEGIES = {
+    bun: lambda do |helper, name, script, run_script|
+      package_json = JSON.parse(File.read("package.json"))
+      package_json["scripts"] ||= {}
+      package_json["scripts"][name] = script.gsub('\\"', '"')
+      File.write("package.json", JSON.pretty_generate(package_json))
+      helper.run %(#{helper.bundler_run_cmd} #{name}) if run_script
+    end,
+
+    pnpm: lambda do |helper, name, script, run_script|
+      helper.say "Add #{name} script"
+      helper.run %(pnpm pkg set scripts.#{name}="#{script}")
+      helper.run %(#{helper.bundler_run_cmd} #{name}) if run_script
+    end,
+
+    npm: lambda do |helper, name, script, run_script|
+      helper.say "Add #{name} script"
+      npx_version = `npx -v`.to_f
+
+      if npx_version >= 7.1 && npx_version < 8.0
+        helper.run %(npm set-script #{name} "#{script}")
+      else
+        helper.run %(npm pkg set scripts.#{name}="#{script}")
+      end
+
+      helper.run %(#{helper.bundler_run_cmd} #{name}) if run_script
+    end,
+
+    yarn: lambda do |helper, name, script, run_script|
+      npx_version = `npx -v`.to_f
+
+      if npx_version >= 7.1 && npx_version < 8.0
+        helper.say "Add #{name} script"
+        helper.run %(npm set-script #{name} "#{script}")
+        helper.run %(#{helper.bundler_run_cmd} #{name}) if run_script
+      elsif npx_version >= 8.0
+        helper.say "Add #{name} script"
+        helper.run %(npm pkg set scripts.#{name}="#{script}")
+        helper.run %(#{helper.bundler_run_cmd} #{name}) if run_script
+      else
+        helper.say %(Add "scripts": { "#{name}": "#{script}" } to your package.json), :green
+      end
+    end
+  }.freeze
+
   def bundler_cmd
-    using_bun? ? "bun" : "yarn"
+    PM_COMMANDS.dig(package_manager, :cmd) || PM_COMMANDS.dig(:yarn, :cmd)
   end
 
   def bundler_run_cmd
-    using_bun? ? "bun run" : "yarn"
+    PM_COMMANDS.dig(package_manager, :run) || PM_COMMANDS.dig(yarn, :run)
   end
 
   def bundler_x_cmd
-    using_bun? ? "bunx" : "npx"
+    PM_COMMANDS.dig(package_manager, :x) || PM_COMMANDS.dig(yarn, :x)
   end
 
   def using_bun?
-    tool_exists?('bun') && (File.exist?('bun.lockb') || 
-                            File.exist?('bun.lock') ||       
-                            File.exist?('yarn.lock'))
+    package_manager == :bun
+  end
+
+  def package_manager
+    @package_manager ||=
+      tool_determined_by_package_json_package_manager ||
+      tool_determined_by_config_file ||
+      tool_determined_by_executable
   end
 
+  def add_package_json_script(name, script, run_script: true)
+    strategy = SCRIPT_STRATEGIES[package_manager] || SCRIPT_STRATEGIES[:yarn]
+    strategy.call(self, name, script, run_script)
+  end
+
+  private
+
   def tool_exists?(tool)
     system "command -v #{tool} > /dev/null"
   end
 
-  def add_package_json_script(name, script, run_script=true)
-    if using_bun?
-      package_json = JSON.parse(File.read("package.json"))
-      package_json["scripts"] ||= {}
-      package_json["scripts"][name] = script.gsub('\\"', '"')
-      File.write("package.json", JSON.pretty_generate(package_json))
-      run %(bun run #{name}) if run_script
-    else
-      case `npx -v`.to_f
-      when 7.1...8.0
-        say "Add #{name} script"
-        run %(npm set-script #{name} "#{script}")
-        run %(yarn #{name}) if run_script
-      when (8.0..)
-        say "Add #{name} script"
-        run %(npm pkg set scripts.#{name}="#{script}")
-        run %(yarn #{name}) if run_script
-      else
-        say %(Add "scripts": { "#{name}": "#{script}" } to your package.json), :green
-      end
+  def tool_determined_by_package_json_package_manager
+    return nil unless File.exist?('package.json')
+
+    package_json = JSON.parse(File.read('package.json'))
+    return nil unless package_json['packageManager']
+
+    pm_name = package_json['packageManager'].split('@').first.downcase.to_sym
+
+    unless SUPPORTED_PACKAGE_MANAGERS.include?(pm_name)
+      raise UNSUPPORTED_PACKAGE_MANAGER_ERROR_MESSAGE
+    end
+
+    unless tool_exists?(pm_name)
+      raise "The package manager '#{pm_name}' specified in package.json is not installed. Please install it first."
+    end
+
+    pm_name
+  end
+
+  def tool_determined_by_config_file
+    case
+    when File.exist?("yarn.lock")         then :yarn
+    when File.exist?("bun.lockb")         then :bun
+    when File.exist?("bun.lock")          then :bun
+    when File.exist?("package-lock.json") then :npm
+    when File.exist?("pnpm-lock.yaml")    then :pnpm
+    end
+  end
+
+  def tool_determined_by_executable
+    PM_COMMANDS.keys.each do |tool|
+      return tool if tool_exists?(tool)
     end
   end
 end

lib/tasks/cssbundling/build.rake

@@ -22,7 +22,7 @@ module Cssbundling
     extend self
 
     LOCK_FILES = {
-      bun: %w[bun.lockb bun.lock yarn.lock],
+      bun: %w[bun.lockb bun.lock],
       yarn: %w[yarn.lock],
       pnpm: %w[pnpm-lock.yaml],
       npm: %w[package-lock.json]