webpacker-pnpm 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9e0c39889bfdad4a14a2fc35250e7eaa33fd49bf48ecc082c44d1985884fbe89
+  data.tar.gz: 8f27fae2d742a2b4c27e0fa675480dda85771bfd120e283fa706c80ce7414fa5
+SHA512:
+  metadata.gz: 8715f49514245b10d8ed85169c5edadcb2ab8905880f9afdd273121835336c175dec087f05b639179024eeea4fc1745ca24c73d00c24fc92d06bbb85ab591d02
+  data.tar.gz: fd7a0f6cc602c9a7d4ba0a2689fc87feae4d7f93c470c9c5fc8b7f62cfd364fd3152839448150a58c523a0e516aa229eed3d9d07cc1083ed0b4ecaeb9938a5b8

data/.gitattributes

@@ -0,0 +1 @@
+* text=lf

data/.gitignore

@@ -0,0 +1,3 @@
+/tmp/
+/**/*.log
+Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,91 @@
+require: rubocop-rails
+AllCops:
+  Exclude:
+    - "node_modules/**/*"
+
+# disable length length checking, as it tends to make things worse in the majority
+# of cases. however, it is good practice keep lines <= 85 columns so they remain
+# readable.
+Layout/LineLength:
+  Enabled: false
+
+# disable documentation checking. many classes do not require top-level comments,
+# and their inclusion can actually obscure their function.
+Style/Documentation:
+  Enabled: false
+
+# functionalization is important, but the Rails' idiom for returning key-value
+# maps can raise a false alarm with the max line number (10). increase the value
+# to something more reasonable given the circumstances.
+Metrics/MethodLength:
+  Max: 20
+  ExcludedMethods:
+    - test_rake_tasks
+
+# if you're specifying access modifiers, it is likely intentional. force RuboCop
+# to trust your decision making.
+Lint/UselessAccessModifier:
+  Enabled: false
+
+# flag potential memory leaks, like when opening a file.
+Style/AutoResourceCleanup:
+  Enabled: true
+
+# single quotes are meant for single characters. double quotes are meant for
+# strings, which are arrays of multiple characters. there are a whole host of
+# other differences and functions; if you're creating a string, you nearly always
+# should use double quotes.
+#
+# https://en.wikipedia.org/wiki/Delimiter#Bracket_delimiters
+# Schwartz, Randal (2005). Learning Perl. ISBN 978-0-596-10105-3.
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+# flags methods that violate the default ABC magnitude (15). The ABC metric
+# quantizes the size of a method, and is calculated based on the number of
+# assignment operations, possible execution branches, and number of conditionals.
+#
+# https://en.wikipedia.org/wiki/ABC_Software_Metric
+Metrics/AbcSize:
+  Enabled: true
+  IgnoredMethods:
+    - test_rake_tasks
+    - chdir_concurrent
+
+# this simply doesn't work in a cross-platform development environment. Bit
+# flags across UNIX and Windows platforms are volatile, and thus there is no
+# way to ensure this passes besides explicitly granting execute permissions
+# in CI config (which would defeat the purpose).
+Lint/ScriptPermission:
+  Enabled: false
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Style/ExponentialNotation:
+  Enabled: true
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+
+Style/SlicingWithRange:
+  Enabled: true
+
+Style/RescueModifier:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,45 @@
+language: ruby
+os: linux
+dist: bionic
+before_install:
+  - gem install rubygems-update && update_rubygems
+  - yes | rvm @global do gem install bundler -v 2.1.4 || true
+rvm:
+  - 2.4.9
+  - 2.5.5
+  - 2.6.5
+  - 2.7.0
+  - ruby-head
+gemfile:
+  - gemfiles/Gemfile-rails.5.2.x
+  - gemfiles/Gemfile-rails.6.0.x
+  - gemfiles/Gemfile-rails-edge
+cache:
+  bundler: true
+  npm: false
+  yarn: false
+  directories:
+    - node_modules
+    - "~/.pnpm-store"
+
+install:
+  - bundle install --jobs 3 --retry 3
+  - nvm install 12
+  - node -v
+  - curl -L https://raw.githubusercontent.com/pnpm/self-installer/master/install.js | node
+  - pnpm config set store-dir ~/.pnpm-store
+  - pnpm install --frozen-lockfile
+script:
+  - bundle exec rubocop
+  - bundle exec rake test
+jobs:
+  allow_failures:
+    - gemfile: gemfiles/Gemfile-rails-edge
+    - rvm: ruby-head
+  exclude:
+    - rvm: 2.4.9
+      gemfile: gemfiles/Gemfile-rails-edge
+    - rvm: 2.5.5
+      gemfile: gemfiles/Gemfile-rails-edge
+    - rvm: 2.4.9
+      gemfile: gemfiles/Gemfile-rails.6.0.x

data/CHANGELOG.md

@@ -0,0 +1,45 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on Keep a Changelog (<https://keepachangelog.com/en/1.0.0/>). This project adheres to Semantic Versioning (<https://semver.org/spec/v2.0.0.html>).
+
+## [v1.2.0] - 2020-05-14
+
+### Added
+
+- Compatibility with Rails' Template API via command execution hooks and keyword substitution.
+- Support for existing Yarn Rake task dependence through task aliasing and redirection.
+- Additional Rake tasks to test injection and interception logic.
+- Utility method for concurrent and scoped `chdir` calls.
+
+### Changed
+
+- Gem dependencies to reflect up-to-date versions.
+- RuboCop formatting rules to support latest versions of Ruby.
+- Test application structure to allow application booting.
+- Rake task tests to utilize concurrent `chdir` calls.
+- Tests to support Rails <6.x `[bugfix]`.
+- Tests to support Ruby 2.4.9 `[bugfix]`.
+
+### Removed
+
+- Webpacker git submodule as method for replacing default Rails' rake tasks.
+- Dependence on a specific version of Webpacker.
+
+## [v1.1.0] - 2020-04-19
+
+### Changed
+
+- RuboCop formatting rules to more align with Rails' style guide.
+- TypeScript installation tasks based on Webpacker v5.1.0.
+- Rake tasks to extend ActiveSupport and utilize concurrent threading.
+
+## [v1.0.0] - 2020-04-17
+
+### Added
+
+- Gem specifications and foundational files, generated by Bundler v2.0.2, for defining a Ruby gem.
+- Hook into Rails' engine loader for conditional task loading.
+- Tasks replacing Yarn with pnpm for Webpacker v5.0.1, included as a submodule.
+- Test suite with dummy application.

data/Gemfile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec
+
+gem "rack-proxy", require: false
+gem "rails", ">= 5.2"
+gem "rake", ">= 12.3.3"
+gem "semantic_range", require: false
+
+install_if -> { Gem.win_platform? } do
+  gem "tzinfo-data"
+end
+
+group :test do
+  gem "minitest", ">= 5"
+end

data/README.md

@@ -0,0 +1,35 @@
+# webpacker-pnpm
+
+![version](https://img.shields.io/gem/v/webpacker-pnpm?label=version&style=flat-square)
+[![status](https://img.shields.io/travis/thearchitector/webpacker-pnpm?style=flat-square)](https://travis-ci.org/github/thearchitector/webpacker-pnpm)
+![downloads](https://img.shields.io/gem/dt/webpacker-pnpm?style=flat-square)
+[![license](https://img.shields.io/badge/license-CC--BY--NC--SA--4.0-green?style=flat-square)](https://creativecommons.org/licenses/by-nc-sa/4.0/)
+
+`webpacker-pnpm` replaces Rails' Yarn environment with [pnpm](https://pnpm.js.org/), which is a much smarter, efficient, and faster alternative Node.js package manager. You can read about the philosophy and technology behind `pnpm` in [this convincing blog post](https://www.kochan.io/nodejs/why-should-we-use-pnpm.html) by Zoltan Kochan, but in essence it reduces dependency resolution times and `node_modules` folder sizes to within reasonable ranges (not 30 seconds and 10 GiB).
+
+## Features
+
+- Production-ready
+- Drop-in seamless replacement for Yarn, no config required
+- Supports Rails' Template API, including existing templates using Yarn
+- Independent of official Webpacker versions
+- Provides code sanity without the migraines
+- Gives you more disk space
+
+## Installation
+
+In order to use `webpacker-pnpm`, you must install `pnpm`. The official instructions are [here](https://pnpm.js.org/en/installation), but all they say is to run the following command:
+
+```sh
+$ curl -L https://raw.githubusercontent.com/pnpm/self-installer/master/install.js | node
+```
+
+After installing `pnpm`, simply add `webpacker-pnpm` to your app's `Gemfile`. There is no need to worry about your official Webpacker gem version, as this gem should be version-agnostic.
+
+```ruby
+gem "webpacker-pnpm"
+```
+
+## License
+
+This work is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License. To view a copy of this license, visit <http://creativecommons.org/licenses/by-nc-sa/4.0/> or send a letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.

data/Rakefile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "webpacker/pnpm"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/gemfiles/Gemfile-rails-edge

@@ -0,0 +1,12 @@
+source "https://rubygems.org"
+
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+gemspec path: "../"
+
+gem "rails", github: "rails/rails"
+gem "arel", github: "rails/arel"
+gem "rake", ">= 11.1"
+gem "rack-proxy", require: false
+gem "minitest", "~> 5.0"
+gem "byebug"

data/gemfiles/Gemfile-rails.5.2.x

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+gemspec path: "../"
+
+gem "rails", "~> 5.2.0"
+gem "rake", ">= 11.1"
+gem "rack-proxy", require: false
+gem "minitest", "~> 5.0"
+gem "byebug"

data/gemfiles/Gemfile-rails.6.0.x

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+gemspec path: "../"
+
+gem "rails", "~> 6.0.0.rc2"
+gem "rake", ">= 11.1"
+gem "rack-proxy", require: false
+gem "minitest", "~> 5.0"
+gem "byebug"

data/lib/webpacker/pnpm.rb

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

data/lib/webpacker/pnpm/patches.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+require "webpacker/runner"
+require "webpacker/compiler"
+
+module Webpacker
+  module PNPM
+    # remove Yarn's lockfile from and add pnpm's lockfile to the default list of
+    # watched paths
+    Webpacker::Compiler.class_eval do
+      def default_watched_paths
+        [
+          *config.resolved_paths_globbed,
+          config.source_path_globbed,
+          "pnpm-lock.yaml", "package.json",
+          "config/webpack/**/*"
+        ].freeze
+      end
+    end
+
+    # intercept command execution via Thor to replace yarn with pnpm. this exists in
+    # order to patch existing Webpacker installation templates that make direct
+    # calls to install Yarn dependencies. as a result, this isn't a robust patch
+    Rails::Generators::Actions.module_eval do
+      def run(command, config = {})
+        cmd = command.to_s
+
+        if cmd.include?("yarn")
+          cmd.gsub!("yarn", "pnpm")
+          cmd.gsub!("--dev", "--save-dev")
+        end
+
+        super(cmd, config)
+      end
+    end
+
+    # intercept generic task loading to clear and alias Yarn tasks
+    Rails::Engine.class_eval do
+      alias_method :unfiltered_tasks, :load_tasks
+
+      def load_tasks(_app = self)
+        unfiltered_tasks
+        # rather than clear the tasks, alias them to the new pnpm tasks so
+        # that any external code will still run
+        Rake::Task["webpacker:check_yarn"].clear.enhance(["webpacker:check_pnpm"])
+        Rake::Task["webpacker:yarn_install"].clear.enhance(["webpacker:pnpm_install"])
+        Rake::Task["webpacker:info"].clear.enhance(["webpacker:env"])
+        Rake::Task["yarn:install"].clear.enhance(["webpacker:pnpm_install"])
+      end
+    end
+  end
+end

data/lib/webpacker/pnpm/railtie.rb

@@ -0,0 +1,24 @@
+# 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

data/lib/webpacker/pnpm/version.rb

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

data/lib/webpacker/tasks/check_pnpm.rake

@@ -0,0 +1,27 @@
+# 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

data/lib/webpacker/tasks/env.rake

@@ -0,0 +1,20 @@
+# 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

data/lib/webpacker/tasks/pnpm_install.rake

@@ -0,0 +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

data/test/rake_tasks_test.rb

@@ -0,0 +1,106 @@
+# 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

data/test/test_app/.gitignore

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

data/test/test_app/Rakefile

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

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

@@ -0,0 +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!')

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

@@ -0,0 +1,4 @@
+/*
+ * 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

@@ -0,0 +1,4 @@
+/*
+ * 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

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

data/test/test_app/bin/rake

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

data/test/test_app/bin/setup

@@ -0,0 +1,27 @@
+#!/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

data/test/test_app/bin/webpack

@@ -0,0 +1,14 @@
+#!/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

@@ -0,0 +1,14 @@
+#!/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)

data/test/test_app/config.ru

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# This file allows the `Rails.root` to be correctly determined.
+
+require_relative "config/environment"
+
+run Rails.application

data/test/test_app/config/application.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "action_controller/railtie"
+require "action_view/railtie"
+require "webpacker"
+require "webpacker/pnpm"
+
+module TestApp
+  class Application < ::Rails::Application
+    config.secret_key_base = "abcdef"
+    config.eager_load = true
+  end
+end

data/test/test_app/config/environment.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require_relative "application"
+
+Rails.backtrace_cleaner.remove_silencers!
+Rails.application.initialize!

data/test/test_app/config/webpack/environment.js

@@ -0,0 +1,3 @@
+const { environment } = require('@rails/webpacker')
+
+module.exports = environment

data/test/test_app/config/webpacker.yml

@@ -0,0 +1,96 @@
+# Note: You must restart bin/webpack-dev-server for changes to take effect
+
+default: &default
+  source_path: app/javascript
+  source_entry_path: packs
+  public_root_path: public
+  public_output_path: packs
+  cache_path: tmp/cache/webpacker
+  webpack_compile_output: false
+
+  # Additional paths webpack should lookup modules
+  # ['app/assets', 'engine/foo/app/assets']
+  resolved_paths: []
+
+  # Reload manifest.json on all requests so we reload latest compiled packs
+  cache_manifest: false
+
+  # Extract and emit a css file
+  extract_css: false
+
+  static_assets_extensions:
+    - .jpg
+    - .jpeg
+    - .png
+    - .gif
+    - .tiff
+    - .ico
+    - .svg
+
+  extensions:
+    - .vue
+    - .mjs
+    - .js
+    - .sass
+    - .scss
+    - .css
+    - .module.sass
+    - .module.scss
+    - .module.css
+    - .png
+    - .svg
+    - .gif
+    - .jpeg
+    - .jpg
+
+development:
+  <<: *default
+  compile: true
+
+  # Reference: https://webpack.js.org/configuration/dev-server/
+  dev_server:
+    https: false
+    host: localhost
+    port: 3035
+    public: localhost:3035
+    hmr: false
+    # Inline should be set to true if using HMR
+    inline: true
+    overlay: true
+    disable_host_check: true
+    use_local_ip: false
+    pretty: false
+
+test:
+  <<: *default
+  compile: true
+
+  # Compile test packs to a separate directory
+  public_output_path: packs-test
+
+production:
+  <<: *default
+
+  # Production depends on precompilation of packs prior to booting for performance.
+  compile: false
+
+  # Extract and emit a css file
+  extract_css: true
+
+  # Cache manifest.json for performance
+  cache_manifest: true
+
+staging:
+  <<: *default
+
+  # Production depends on precompilation of packs prior to booting for performance.
+  compile: false
+
+  # Extract and emit a css file
+  extract_css: true
+
+  # Cache manifest.json for performance
+  cache_manifest: true
+
+  # Compile staging packs to a separate directory
+  public_output_path: packs-staging

data/test/test_app/config/webpacker_public_root.yml

@@ -0,0 +1,19 @@
+# Note: You must restart bin/webpack-dev-server for changes to take effect
+
+default: &default
+  public_root_path: ../public
+
+development:
+  <<: *default
+  compile: true
+
+test:
+  <<: *default
+  compile: true
+  public_output_path: packs-test
+
+production:
+  <<: *default
+  compile: false
+  extract_css: true
+  cache_manifest: true

data/test/test_app/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "test_app",
+  "version": "1.0.0",
+  "main": "index.js",
+  "license": "CC-BY-NC-SA-4.0",
+  "private": true,
+  "dependencies": {
+    "left-pad": "^1.2.0"
+  },
+  "devDependencies": {
+    "right-pad": "^1.0.1"
+  }
+}

data/test/test_app/pnpm-lock.yaml

@@ -0,0 +1,20 @@
+dependencies:
+  left-pad: 1.3.0
+devDependencies:
+  right-pad: 1.0.1
+lockfileVersion: 5.1
+packages:
+  /left-pad/1.3.0:
+    deprecated: use String.prototype.padStart()
+    dev: false
+    resolution:
+      integrity: sha512-XI5MPzVNApjAyhQzphX8BkmKsKUxD4LdyK24iZeQGinBN9yTQT3bFlCBy/aVx2HrNcqQGsdot8ghrjyrvMCoEA==
+  /right-pad/1.0.1:
+    dev: true
+    engines:
+      node: '>= 0.10'
+    resolution:
+      integrity: sha1-jKCMLLtbVedNr6lr9/0aJ9VoyNA=
+specifiers:
+  left-pad: ^1.2.0
+  right-pad: ^1.0.1

data/test/test_app/public/packs/manifest.json

@@ -0,0 +1,31 @@
+{
+  "bootstrap.css": "/packs/bootstrap-c38deda30895059837cf.css",
+  "application.css": "/packs/application-dd6b1cd38bfa093df600.css",
+  "bootstrap.js": "/packs/bootstrap-300631c4f0e0f9c865bc.js",
+  "application.js": "/packs/application-k344a6d59eef8632c9d1.js",
+  "application.png": "/packs/application-k344a6d59eef8632c9d1.png",
+  "fonts/fa-regular-400.woff2": "/packs/fonts/fa-regular-400-944fb546bd7018b07190a32244f67dc9.woff2",
+  "media/images/image.jpg": "/packs/media/images/image-c38deda30895059837cf.jpg",
+  "media/images/nested/image.jpg": "/packs/media/images/nested/image-c38deda30895059837cf.jpg",
+  "media/images/mb-icon.png": "/packs/media/images/mb-icon-c38deda30895059837cf.png",
+  "media/images/nested/mb-icon.png": "/packs/media/images/nested/mb-icon-c38deda30895059837cf.png",
+  "entrypoints": {
+    "application": {
+      "js": [
+        "/packs/vendors~application~bootstrap-c20632e7baf2c81200d3.chunk.js",
+        "/packs/vendors~application-e55f2aae30c07fb6d82a.chunk.js",
+        "/packs/application-k344a6d59eef8632c9d1.js"
+      ],
+      "css": [
+        "/packs/1-c20632e7baf2c81200d3.chunk.css",
+        "/packs/application-k344a6d59eef8632c9d1.chunk.css"
+      ]
+    },
+    "hello_stimulus": {
+      "css": [
+        "/packs/1-c20632e7baf2c81200d3.chunk.css",
+        "/packs/hello_stimulus-k344a6d59eef8632c9d1.chunk.css"
+      ]
+    }
+  }
+}

data/test/test_helper.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require "rails"
+require "rails/test_help"
+require "etc"
+require "fileutils"
+require "open3"
+
+require_relative "test_app/config/environment"
+
+Rails.env = "production"
+Webpacker.instance = ::Webpacker::Instance.new
+
+module Webpacker
+  module PNPM
+    class Test < ActiveSupport::TestCase
+      # force test parallelization - this is not about test speed, it is about
+      # maximizing the likelihood of having tests fail by providing isolated
+      # execution threads. manually specify the number of workers, as by default
+      # Rails uses the number of physical, not logical, cores. Additionally,
+      # spawn threads rather than fork processes as Rails' DRb implementation
+      # only supports UNIX systems
+      Minitest.parallel_executor = Minitest::Parallel::Executor.new(Etc.nprocessors)
+      parallelize_me!
+
+      protected
+
+      # concurrent scoped chdir calls are not supported, as they can cause
+      # unforeseen and unpredictable bugs. instead, allow copying the desired
+      # directory to a temp directory before performing possible filesystem
+      # manipulations. opts are passed through to Open3::capture2e
+      def chdir_concurrent(dir, cmd, env = {}, opts = {})
+        # Process::spawn requires an env hash of strings
+        env.stringify_keys!
+        env.transform_values!(&:to_s)
+
+        env = ENV.to_h.merge(env)
+        isolated = opts.delete(:isolated)
+        output = nil
+
+        begin
+          # if we're want an isolated environment, copy the directory contents to
+          # a new temporary directory and change the working directory to it
+          if isolated
+            files = Dir[File.join(dir, "*")].reject do |f|
+              f.include?("node_modules")
+            end
+
+            dir = Dir.mktmpdir
+            FileUtils.cp_r(files, dir)
+          end
+
+          output, = Open3.capture2e(env, "cd #{dir} && #{cmd}", opts)
+          yield(output, dir) if block_given?
+        ensure
+          # make sure we remove the generated temp directory
+          FileUtils.remove_entry_secure(dir) if isolated
+        end
+
+        output
+      end
+    end
+  end
+end

data/webpacker-pnpm.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "webpacker/pnpm/version"
+
+Gem::Specification.new do |spec|
+  spec.name        = "webpacker-pnpm"
+  spec.version     = Webpacker::PNPM::VERSION
+  spec.authors     = ["Elias Gabriel"]
+  spec.email       = ["me@eliasfgabriel.com"]
+  spec.summary     = "Replaces Webpacker's Yarn environment with pnpm"
+  spec.homepage    = "https://github.com/thearchitector/webpacker-pnpm"
+  spec.license     = "CC-BY-NC-SA-4.0"
+
+  spec.metadata    = {
+    "homepage_uri" => spec.homepage,
+    "source_code_uri" => "https://github.com/thearchitector/webpacker-pnpm/tree/v#{Webpacker::PNPM::VERSION}",
+    "changelog_uri" => "https://github.com/thearchitector/webpacker-pnpm/blob/v#{Webpacker::PNPM::VERSION}/CHANGELOG.md"
+  }
+
+  spec.required_ruby_version = ">= 2.4.0"
+
+  spec.add_dependency "activesupport", ">= 5.2"
+  spec.add_dependency "rack-proxy", ">= 0.6.1"
+  spec.add_dependency "railties", ">= 5.2"
+  spec.add_dependency "semantic_range", ">= 2.3.0"
+  spec.add_dependency "webpacker", "~> 5.x"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "rubocop-rails"
+
+  spec.files       = `git ls-files`.split("\n")
+  spec.test_files  = `git ls-files -- test/*`.split("\n")
+end

metadata

@@ -0,0 +1,226 @@
+--- !ruby/object:Gem::Specification
+name: webpacker-pnpm
+version: !ruby/object:Gem::Version
+  version: 1.2.0
+platform: ruby
+authors:
+- Elias Gabriel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-05-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: rack-proxy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: semantic_range
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+- !ruby/object:Gem::Dependency
+  name: webpacker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.x
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.x
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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-rails
+  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:
+- me@eliasfgabriel.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitattributes"
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gemfiles/Gemfile-rails-edge
+- gemfiles/Gemfile-rails.5.2.x
+- gemfiles/Gemfile-rails.6.0.x
+- lib/webpacker/pnpm.rb
+- lib/webpacker/pnpm/patches.rb
+- lib/webpacker/pnpm/railtie.rb
+- lib/webpacker/pnpm/version.rb
+- lib/webpacker/tasks/check_pnpm.rake
+- lib/webpacker/tasks/env.rake
+- lib/webpacker/tasks/pnpm_install.rake
+- test/rake_tasks_test.rb
+- test/test_app/.gitignore
+- test/test_app/Rakefile
+- test/test_app/app/javascript/packs/application.js
+- test/test_app/app/javascript/packs/multi_entry.css
+- test/test_app/app/javascript/packs/multi_entry.js
+- test/test_app/bin/rails
+- test/test_app/bin/rake
+- test/test_app/bin/setup
+- test/test_app/bin/webpack
+- test/test_app/bin/webpack-dev-server
+- test/test_app/config.ru
+- test/test_app/config/application.rb
+- test/test_app/config/boot.rb
+- test/test_app/config/environment.rb
+- test/test_app/config/webpack/development.js
+- test/test_app/config/webpack/environment.js
+- test/test_app/config/webpacker.yml
+- test/test_app/config/webpacker_public_root.yml
+- test/test_app/package.json
+- test/test_app/pnpm-lock.yaml
+- test/test_app/public/packs/manifest.json
+- test/test_helper.rb
+- webpacker-pnpm.gemspec
+homepage: https://github.com/thearchitector/webpacker-pnpm
+licenses:
+- CC-BY-NC-SA-4.0
+metadata:
+  homepage_uri: https://github.com/thearchitector/webpacker-pnpm
+  source_code_uri: https://github.com/thearchitector/webpacker-pnpm/tree/v1.2.0
+  changelog_uri: https://github.com/thearchitector/webpacker-pnpm/blob/v1.2.0/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6.2
+signing_key: 
+specification_version: 4
+summary: Replaces Webpacker's Yarn environment with pnpm
+test_files:
+- test/rake_tasks_test.rb
+- test/test_app/.gitignore
+- test/test_app/Rakefile
+- test/test_app/app/javascript/packs/application.js
+- test/test_app/app/javascript/packs/multi_entry.css
+- test/test_app/app/javascript/packs/multi_entry.js
+- test/test_app/bin/rails
+- test/test_app/bin/rake
+- test/test_app/bin/setup
+- test/test_app/bin/webpack
+- test/test_app/bin/webpack-dev-server
+- test/test_app/config.ru
+- test/test_app/config/application.rb
+- test/test_app/config/boot.rb
+- test/test_app/config/environment.rb
+- test/test_app/config/webpack/development.js
+- test/test_app/config/webpack/environment.js
+- test/test_app/config/webpacker.yml
+- test/test_app/config/webpacker_public_root.yml
+- test/test_app/package.json
+- test/test_app/pnpm-lock.yaml
+- test/test_app/public/packs/manifest.json
+- test/test_helper.rb