webpacker-pnpm 1.2.0 → 1.2.2

data/lib/webpacker/pnpm/railtie.rb

@@ -1,24 +1,33 @@
-# frozen_string_literal: true
-
-require "rails/railtie"
-
-module Webpacker
-  module PNPM
-    class Railtie < Rails::Railtie
-      private
-
-      rake_tasks do
-        # load all the rake tasks within the `tasks` directory
-        Dir[File.join(File.dirname(__FILE__), "../tasks/**/*.rake")].each do |task|
-          load task
-        end
-      end
-
-      # manually specify bin path to skip Yarn execution during Webpack runner
-      # initialization
-      config.before_configuration do
-        ENV["WEBPACKER_NODE_MODULES_BIN_PATH"] ||= File.join(`pnpm root`.chomp, ".bin")
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require "rails/railtie"
+
+module Webpacker
+  module PNPM
+    class Railtie < Rails::Railtie
+      rake_tasks do
+        # load all the rake tasks within the `tasks` directory
+        Dir[File.join(File.dirname(__FILE__), "../tasks/**/*.rake")].each do |task|
+          load task
+        end
+      end
+
+      # manually specify node_modules bin path to skip Yarn execution during
+      # Webpack runner initialization
+      config.before_configuration do
+        begin
+          ENV["WEBPACKER_NODE_MODULES_BIN_PATH"] ||= File.join(`pnpm root`.chomp, ".bin")
+        rescue Errno::ENOENT
+          # use abort instead of Rails' logger because it doesn't show up when
+          # run within Rake tasks
+          abort(
+            <<~HEREDOC.squish
+              \e[31m[FATAL] pnpm is not installed or not present in $PATH.
+              Install pnpm and try again.\e[0m
+            HEREDOC
+          )
+        end
+      end
+    end
+  end
+end

data/lib/webpacker/pnpm/version.rb

@@ -1,7 +1,9 @@
-# frozen_string_literal: true
-
-module Webpacker
-  module PNPM
-    VERSION = "1.2.0"
-  end
-end
+# frozen_string_literal: true
+
+module Webpacker
+  module PNPM
+    VERSION = "1.2.2"
+
+    public_constant :VERSION
+  end
+end

data/lib/webpacker/pnpm.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
-
-require_relative "pnpm/version"
-require_relative "pnpm/railtie"
-require_relative "pnpm/patches"
+# frozen_string_literal: true
+
+require_relative "pnpm/version"
+require_relative "pnpm/railtie"
+require_relative "pnpm/patches"

data/lib/webpacker/tasks/check_pnpm.rake

@@ -1,27 +1,42 @@
-# frozen_string_literal: true
-
-require "semantic_range"
-namespace :webpacker do
-  desc "Verifies if pnpm is installed"
-  task check_pnpm: [:environment] do
-    begin
-      $stdout.puts "Verifying pnpm version..."
-
-      pnpm_version = `pnpm --version`.chomp
-      raise Errno::ENOENT if pnpm_version.blank?
-
-      pnpm_range = ">=3.0.0"
-      is_unsupported = SemanticRange.satisfies?(pnpm_version, pnpm_range) rescue false
-
-      unless is_unsupported
-        warn "Webpacker requires pnpm \"#{pnpm_range}\" and you are using #{pnpm_version}. Please upgrade pnpm https://pnpm.js.org/en/installation/"
-        warn "Exiting!"
-        exit!
-      end
-    rescue Errno::ENOENT
-      warn "pnpm is not installed. Please download and install pnpm from https://pnpm.js.org/en/installation/"
-      warn "Exiting!"
-      exit!
-    end
-  end
-end
+# frozen_string_literal: true
+
+require "semantic_range"
+
+namespace :webpacker do
+  desc "Verifies if pnpm is installed"
+  task check_pnpm: [:environment] do
+    begin
+      $stdout.puts "Verifying pnpm version..."
+
+      pnpm_version = `pnpm --version`.chomp
+      raise Errno::ENOENT if pnpm_version.blank?
+
+      begin
+        pnpm_range = ">= 3.0.0"
+        is_unsupported = SemanticRange.satisfies?(pnpm_version, pnpm_range)
+      rescue StandardError
+        is_unsupported = false
+      end
+
+      unless is_unsupported
+        warn(
+          <<~HEREDOC.squish
+            Webpacker requires pnpm \"#{pnpm_range}\" and you are using #{pnpm_version}.
+            Please upgrade pnpm https://pnpm.js.org/en/installation/.
+          HEREDOC
+        )
+        warn("Exiting!")
+        exit!
+      end
+    rescue Errno::ENOENT
+      warn(
+        <<~HEREDOC.squish
+          pnpm is not installed. Please download and install pnpm from
+          https://pnpm.js.org/en/installation/.
+        HEREDOC
+      )
+      warn("Exiting!")
+      exit!
+    end
+  end
+end

data/lib/webpacker/tasks/env.rake

@@ -1,20 +1,22 @@
-# frozen_string_literal: true
-
-require "webpacker/version"
-
-namespace :webpacker do
-  desc "Provide information on Webpacker's environment"
-  task env: [:environment] do
-    $stdout.puts "Ruby: #{`ruby --version`}"
-    $stdout.puts "Rails: #{Rails.version}"
-    $stdout.puts "Webpacker: #{Webpacker::VERSION}"
-    $stdout.puts "Node: #{`node --version`}"
-    $stdout.puts "pnpm: #{`pnpm --version`}"
-
-    $stdout.puts "\n"
-    $stdout.puts "@rails/webpacker: \n#{`npm list @rails/webpacker version`}"
-
-    $stdout.puts "Is bin/webpack present?: #{File.exist? 'bin/webpack'}"
-    $stdout.puts "Is bin/webpack-dev-server present?: #{File.exist? 'bin/webpack-dev-server'}"
-  end
-end
+# frozen_string_literal: true
+
+require "webpacker/version"
+
+namespace :webpacker do
+  desc "Provide information on Webpacker's current environment"
+  task env: [:environment] do
+    $stdout.puts "Ruby: #{`ruby --version`}"
+    $stdout.puts "Rails: #{Rails.version}"
+    $stdout.puts "Webpacker: #{Webpacker::VERSION}"
+    $stdout.puts "Node: #{`node --version`}"
+    $stdout.puts "pnpm: #{`pnpm --version`}"
+
+    $stdout.puts "\n"
+    $stdout.puts "@rails/webpacker: \n#{`npm list @rails/webpacker version`}"
+
+    $stdout.puts "Is bin/webpack present?: #{File.exist?("bin/webpack")}"
+    $stdout.puts <<~HEREDOC.squish
+      Is bin/webpack-dev-server present?: #{File.exist?("bin/webpack-dev-server")}
+    HEREDOC
+  end
+end

data/lib/webpacker/tasks/pnpm_install.rake

@@ -1,14 +1,14 @@
-# frozen_string_literal: true
-
-namespace :webpacker do
-  desc "Support for older Rails versions. Install all JavaScript dependencies as specified via pnpm"
-  task pnpm_install: [:environment] do
-    valid_node_envs = %w[test development production]
-
-    node_env = ENV.fetch("NODE_ENV") do
-      valid_node_envs.include?(Rails.env) ? Rails.env : "production"
-    end
-
-    system({ "NODE_ENV" => node_env }, "pnpm i --frozen-lockfile")
-  end
-end
+# frozen_string_literal: true
+
+namespace :webpacker do
+  desc "Install all JavaScript dependencies as specified via pnpm."
+  task pnpm_install: [:environment] do
+    valid_node_envs = ["test", "development", "production"]
+
+    node_env = ENV.fetch("NODE_ENV") do
+      valid_node_envs.include?(Rails.env) ? Rails.env : "production"
+    end
+
+    system({ "NODE_ENV" => node_env }, "pnpm i --frozen-lockfile --shamefully-hoist")
+  end
+end

data/test/rake_tasks_test.rb

@@ -1,106 +1,97 @@
-# frozen_string_literal: true
-
-require "test_helper"
-
-module Webpacker
-  module PNPM
-    class RakeTasksTest < Test
-      def test_rake_tasks
-        output = chdir_concurrent(test_path, "bundle exec rake --tasks")
-        assert_includes output, "webpacker"
-        assert_includes output, "webpacker:binstubs"
-        assert_includes output, "webpacker:check_binstubs"
-        assert_includes output, "webpacker:check_node"
-        assert_includes output, "webpacker:check_pnpm"
-        assert_includes output, "webpacker:clean"
-        assert_includes output, "webpacker:clobber"
-        assert_includes output, "webpacker:compile"
-        assert_includes output, "webpacker:env"
-        assert_includes output, "webpacker:install"
-        assert_includes output, "webpacker:install:angular"
-        assert_includes output, "webpacker:install:coffee"
-        assert_includes output, "webpacker:install:elm"
-        assert_includes output, "webpacker:install:erb"
-        assert_includes output, "webpacker:install:react"
-        assert_includes output, "webpacker:install:svelte"
-        assert_includes output, "webpacker:install:stimulus"
-        assert_includes output, "webpacker:install:typescript"
-        assert_includes output, "webpacker:install:vue"
-        assert_includes output, "webpacker:pnpm_install"
-        assert_includes output, "webpacker:verify_install"
-
-        assert_not_includes output, "webpacker:check_yarn"
-        assert_not_includes output, "webpacker:yarn_install"
-        assert_not_includes output, "yarn:install"
-      end
-
-      def test_check_pnpm_version
-        output = chdir_concurrent(test_path, "rake webpacker:check_pnpm 2>&1")
-        assert_not_includes output, "pnpm is not installed"
-        assert_not_includes output, "Webpacker requires pnpm"
-
-        assert_includes output, "Verifying pnpm version..."
-      end
-
-      def test_override_check_yarn_version
-        output = chdir_concurrent(test_path, "rake webpacker:check_yarn 2>&1")
-        assert_not_includes output, "pnpm is not installed"
-        assert_not_includes output, "Webpacker requires pnpm"
-
-        assert_includes output, "Verifying pnpm version..."
-      end
-
-      def test_pnpm_install_in_production_env
-        cmd = "bundle exec rake webpacker:pnpm_install"
-
-        chdir_concurrent(test_path, cmd, { NODE_ENV: :production }, { isolated: true }) do |_, temp|
-          assert_not_includes installed_node_modules(temp), "right-pad", "Expected only production dependencies to be installed"
-        end
-      end
-
-      def test_pnpm_install_in_test_env
-        assert_includes test_app_dev_dependencies, "right-pad"
-
-        cmd = "bundle exec rake webpacker:pnpm_install"
-
-        chdir_concurrent(test_path, cmd, { NODE_ENV: :test }, { isolated: true }) do |_, temp|
-          assert_includes installed_node_modules(temp), "right-pad", "Expected dev dependencies to be installed"
-        end
-      end
-
-      def test_yarn_install_alias_in_production_env
-        cmd = "bundle exec rake webpacker:yarn_install"
-
-        chdir_concurrent(test_path, cmd, { NODE_ENV: :production }, { isolated: true }) do |_, temp|
-          assert_not_includes installed_node_modules(temp), "right-pad", "Expected only production dependencies to be installed"
-        end
-      end
-
-      def test_yarn_install_alias_in_test_env
-        assert_includes test_app_dev_dependencies, "right-pad"
-
-        cmd = "bundle exec rake webpacker:yarn_install"
-
-        chdir_concurrent(test_path, cmd, { NODE_ENV: :test }, { isolated: true }) do |_, temp|
-          assert_includes installed_node_modules(temp), "right-pad", "Expected dev dependencies to be installed"
-        end
-      end
-
-      private
-
-      def test_path
-        File.expand_path("test_app", __dir__)
-      end
-
-      def test_app_dev_dependencies
-        package_json = File.expand_path("package.json", test_path)
-        JSON.parse(File.read(package_json))["devDependencies"]
-      end
-
-      def installed_node_modules(dir)
-        node_modules_path = File.expand_path("node_modules", dir)
-        Dir.entries(node_modules_path)
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require "test_helper"
+
+module Webpacker
+  module PNPM
+    class RakeTasksTest < Test
+      def test_rake_tasks
+        output = chdir_concurrent(test_path, "bundle exec rake --tasks")
+        assert_includes(output, "webpacker:check_pnpm")
+        assert_includes(output, "webpacker:pnpm_install")
+        assert_includes(output, "webpacker:env")
+
+        assert_not_includes(output, "webpacker:check_yarn")
+        assert_not_includes(output, "webpacker:yarn_install")
+        assert_not_includes(output, "yarn:install")
+        assert_not_includes(output, "webpacker:info")
+      end
+
+      def test_check_pnpm_version
+        output = chdir_concurrent(test_path, "rake webpacker:check_pnpm")
+        assert_not_includes(output, "pnpm is not installed")
+        assert_not_includes(output, "Webpacker requires pnpm")
+
+        assert_includes(output, "Verifying pnpm version...")
+      end
+
+      def test_override_check_yarn_version
+        output = chdir_concurrent(test_path, "rake webpacker:check_yarn")
+        assert_not_includes(output, "pnpm is not installed")
+        assert_not_includes(output, "Webpacker requires pnpm")
+
+        assert_includes(output, "Verifying pnpm version...")
+      end
+
+      def test_pnpm_install_in_production_env
+        cmd = "bundle exec rake webpacker:pnpm_install"
+        chdir_concurrent(test_path, cmd, { "NODE_ENV": "production" },
+                         { isolated: true }) do |temp|
+          assert_not_includes installed_node_modules(temp), "right-pad", <<~HEREDOC
+            Expected only production dependencies to be installed
+          HEREDOC
+        end
+      end
+
+      def test_pnpm_install_in_test_env
+        assert_includes(test_app_dev_dependencies, "right-pad")
+
+        cmd = "bundle exec rake webpacker:pnpm_install"
+        chdir_concurrent(test_path, cmd, { "NODE_ENV": "test" },
+                         { isolated: true }) do |temp|
+          assert_includes installed_node_modules(temp), "right-pad", <<~HEREDOC
+            Expected dev dependencies to be installed
+          HEREDOC
+        end
+      end
+
+      def test_yarn_install_alias_in_production_env
+        cmd = "bundle exec rake webpacker:yarn_install"
+        chdir_concurrent(test_path, cmd, { "NODE_ENV": "production" },
+                         { isolated: true }) do |temp|
+          assert_not_includes installed_node_modules(temp), "right-pad", <<~HEREDOC
+            Expected only production dependencies to be installed
+          HEREDOC
+        end
+      end
+
+      def test_yarn_install_alias_in_test_env
+        assert_includes(test_app_dev_dependencies, "right-pad")
+
+        cmd = "bundle exec rake webpacker:yarn_install"
+        chdir_concurrent(test_path, cmd, { "NODE_ENV": "test" },
+                         { isolated: true }) do |temp|
+          assert_includes installed_node_modules(temp), "right-pad", <<~HEREDOC
+            Expected dev dependencies to be installed
+          HEREDOC
+        end
+      end
+
+      private
+
+      def test_path
+        File.expand_path("test_app", __dir__)
+      end
+
+      def test_app_dev_dependencies
+        package_json = File.expand_path("package.json", test_path)
+        JSON.parse(File.read(package_json))["devDependencies"]
+      end
+
+      def installed_node_modules(dir)
+        node_modules_path = File.expand_path("node_modules", dir)
+        Dir.entries(node_modules_path)
+      end
+    end
+  end
+end

data/test/test_app/.gitignore

@@ -1,7 +1,7 @@
-/.bundle/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
+/.bundle/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
 /node_modules

data/test/test_app/Rakefile

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
-
-require_relative "config/application"
-
-Rails.application.load_tasks
+# frozen_string_literal: true
+
+require_relative "config/application"
+
+Rails.application.load_tasks

data/test/test_app/app/javascript/packs/application.js

@@ -1,10 +1,10 @@
-/* eslint no-console:0 */
-// This file is automatically compiled by Webpack, along with any other files
-// present in this directory. You're encouraged to place your actual application logic in
-// a relevant structure within app/javascript and only use these pack files to reference
-// that code so it'll be compiled.
-//
-// To reference this file, add <%= javascript_pack_tag 'application' %> to the appropriate
-// layout file, like app/views/layouts/application.html.erb
-
-console.log('"Hello Sanity" from webpacker-pnpm!')
+/* eslint no-console:0 */
+// This file is automatically compiled by Webpack, along with any other files
+// present in this directory. You're encouraged to place your actual application logic in
+// a relevant structure within app/javascript and only use these pack files to reference
+// that code so it'll be compiled.
+//
+// To reference this file, add <%= javascript_pack_tag 'application' %> to the appropriate
+// layout file, like app/views/layouts/application.html.erb
+
+console.log('"Hello Sanity" from webpacker-pnpm!')

data/test/test_app/app/javascript/packs/multi_entry.css

@@ -1,4 +1,4 @@
-/*
- * Dummy file #1 for Multi File Entry points: https://webpack.js.org/guides/entry-advanced/
- * This file must be named the same
+/*
+ * Dummy file #1 for Multi File Entry points: https://webpack.js.org/guides/entry-advanced/
+ * This file must be named the same
  */

data/test/test_app/app/javascript/packs/multi_entry.js

@@ -1,4 +1,4 @@
-/*
- * Dummy file #2 for Multi File Entry points: https://webpack.js.org/guides/entry-advanced/
- * This file must be named the same
- */
+/*
+ * Dummy file #2 for Multi File Entry points: https://webpack.js.org/guides/entry-advanced/
+ * This file must be named the same
+ */

data/test/test_app/bin/rails

@@ -1,6 +1,4 @@
-#!/usr/bin/env ruby.exe
-# frozen_string_literal: true
-
-APP_PATH = File.expand_path("../config/application", __dir__)
-require_relative "../config/boot"
-require "rails/commands"
+#!/usr/bin/env ruby.exe
+APP_PATH = File.expand_path('../config/application', __dir__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/test_app/bin/rake

@@ -1,6 +1,4 @@
-#!/usr/bin/env ruby.exe
-# frozen_string_literal: true
-
-require_relative "../config/boot"
-require "rake"
-Rake.application.run
+#!/usr/bin/env ruby.exe
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/test_app/bin/setup

@@ -1,27 +1,25 @@
-#!/usr/bin/env ruby.exe
-# frozen_string_literal: true
-
-require "fileutils"
-
-# path to your application root.
-APP_ROOT = File.expand_path("..", __dir__)
-
-def system!(*args)
-  system(*args) || abort("\n== Command #{args} failed ==")
-end
-
-FileUtils.chdir APP_ROOT do
-  # This script is a way to setup or update your development environment automatically.
-  # This script is idempotent, so that you can run it at anytime and get an expectable outcome.
-  # Add necessary setup steps to this file.
-
-  puts "== Installing dependencies =="
-  system! "gem install bundler --conservative"
-  system("bundle check") || system!("bundle install")
-
-  puts "\n== Removing old logs and tempfiles =="
-  system! "bin/rails log:clear tmp:clear"
-
-  puts "\n== Restarting application server =="
-  system! "bin/rails restart"
-end
+#!/usr/bin/env ruby.exe
+require 'fileutils'
+
+# path to your application root.
+APP_ROOT = File.expand_path('..', __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+FileUtils.chdir APP_ROOT do
+  # This script is a way to setup or update your development environment automatically.
+  # This script is idempotent, so that you can run it at anytime and get an expectable outcome.
+  # Add necessary setup steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

data/test/test_app/bin/webpack

@@ -1,14 +1,15 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-ENV["RAILS_ENV"] ||= ENV["RACK_ENV"] || "development"
-ENV["NODE_ENV"] ||= ENV["RAILS_ENV"]
-
-require "pathname"
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile", Pathname.new(__FILE__).realpath)
-
-require "bundler/setup"
-
-require "webpacker"
-require "webpacker/webpack_runner"
-Webpacker::WebpackRunner.run(ARGV)
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+ENV["RAILS_ENV"] ||= ENV["RACK_ENV"] || "development"
+ENV["NODE_ENV"] ||= ENV["RAILS_ENV"]
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+                                           Pathname.new(__FILE__).realpath)
+
+require "bundler/setup"
+
+require "webpacker"
+require "webpacker/webpack_runner"
+Webpacker::WebpackRunner.run(ARGV)

data/test/test_app/bin/webpack-dev-server

@@ -1,14 +1,15 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-ENV["RAILS_ENV"] ||= ENV["RACK_ENV"] || "development"
-ENV["NODE_ENV"] ||= ENV["RAILS_ENV"]
-
-require "pathname"
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile", Pathname.new(__FILE__).realpath)
-
-require "bundler/setup"
-
-require "webpacker"
-require "webpacker/dev_server_runner"
-Webpacker::DevServerRunner.run(ARGV)
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+ENV["RAILS_ENV"] ||= ENV["RACK_ENV"] || "development"
+ENV["NODE_ENV"] ||= ENV["RAILS_ENV"]
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+                                           Pathname.new(__FILE__).realpath)
+
+require "bundler/setup"
+
+require "webpacker"
+require "webpacker/dev_server_runner"
+Webpacker::DevServerRunner.run(ARGV)