webpacker-pnpm 1.2.1 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ccdea9b9cf8d7a874d90f5bb13f6f20f9229bfcc232085f8d48ec4fb657168e
-  data.tar.gz: bc53eb621ea514efaf2da1891a0e6dcc4c9dad43f217b923ddb479de705b3104
+  metadata.gz: 85df72b48e172802a711481f7f54ea75410cde46e7df8a68e2dd8f1772faa711
+  data.tar.gz: b82b39eb173396c7bb03b49a934a1e9811d2c82a9d608a7ef00ea33565424dca
 SHA512:
-  metadata.gz: c2091d6c417fcaf65e24bb54f8402001f049b7efa5e4d1bde7594a80f0f87fc5d1a97ea6272012042b3ee1f7980244b728c13b5bdc5ead9b1e69af7a3f4de3b4
-  data.tar.gz: 9932710c5d083577ad15eac9f9086da2355e810e58e84a5d5a4dbda7db9925f14da97c6d6f8c6070f8b33428ede8433ed3a30ddcd2bfd934034b6a32d6d0faff
+  metadata.gz: e121ebbbb865ba38282969ea40d278964ebfec79109e9287c90e2d8cc0898ceeef34a58cbc1906d341f032308f7958985183bfc4f0fc73a4a1ed3ffbd061ff3a
+  data.tar.gz: 95a7cf3b7e5b59e9db88aeacfedf98590e10cdf288029755925895107e06f6ec402292983533faf1cdd3d2058b870f8254bd8d9e21a9ebe23187e8817edb93a3

data/.github/FUNDING.yml

@@ -0,0 +1,3 @@
+# These are supported funding model platforms
+
+github: thearchitector

data/.github/workflows/ci.yaml

@@ -0,0 +1,51 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '2.4', '2.5', '2.6', '2.7' ]
+        gemfile: [ '5.2.x', '6.0.x' ]
+        exclude:
+          - ruby: '2.4'
+            gemfile: '6.0.x'
+    runs-on: ubuntu-latest
+    env:
+      BUNDLE_GEMFILE: ${{ github.workspace }}/gemfiles/Gemfile-rails.${{ matrix.gemfile }}
+    steps:
+    - uses: actions/checkout@v3
+    - name: Setup Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Setup Node
+      uses: actions/setup-node@v3
+      with:
+        node-version: 14
+    - name: Setup pnpm
+      uses: pnpm/action-setup@v2
+      id: pnpm-install
+      with:
+        version: 7
+        run_install: false
+    - name: Define pnpm cache
+      id: pnpm-cache
+      shell: bash
+      run: echo "STORE_PATH=$(pnpm store path)" >> $GITHUB_OUTPUT
+    - uses: actions/cache@v3
+      with:
+        path: ${{ steps.pnpm-cache.outputs.STORE_PATH }}
+        key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+        restore-keys: |
+          ${{ runner.os }}-pnpm-store-
+    - name: Check formatting and syntax
+      run: bundle exec rubocop
+    - name: Run tests
+      working-directory: ./test_app
+      run: |
+        pnpm i --frozen-lockfile --shamefully-hoist
+        bundle exec rake test

data/.gitignore

@@ -1,6 +1,4 @@
-/tmp/
-**/log
+.pnpm-store
+
 Gemfile.lock
-**/*.gem
-gemfiles/vendor
-.bundle
+*.gem

data/.rubocop.yml

@@ -1,7 +1,6 @@
 #
-# RuboCop is a Ruby static code analyzer and code formatter that tries to enforce many of
-# the guidelines outlined in the community Ruby and Rails
-# style guides.
+# RuboCop is a Ruby static code analyzer and code formatter that tries to enforce many
+# of the guidelines outlined in the community Ruby and Rails style guides.
 #
 # https://docs.rubocop.org/en/latest/
 # https://rubystyle.guide/
@@ -15,11 +14,30 @@ inherit_mode:
     - IgnoredMethods
     - AllowedMethods
 
-# cop-specific excludes are not inherited for some reason (likely a bug in RuboCop) so we
-# need to manually re-omit the intended files and directories.
+# cop-specific excludes are not inherited for some reason (likely a bug in RuboCop) so
+# we need to manually re-omit the intended files and directories.
 Layout/LineLength:
+  Max: 88
   Exclude:
     - "**/config/initializers/**/*"
 Style/MethodCallWithArgsParentheses:
   Exclude:
     - "**/Gemfile"
+
+# cops to backfill into practical pig
+Performance/AncestorsInclude:
+  Enabled: false
+Performance/BigDecimalWithNumericArgument:
+  Enabled: true
+Performance/RedundantSortBlock:
+  Enabled: true
+Performance/RedundantStringChars:
+  Enabled: true
+Performance/ReverseFirst:
+  Enabled: true
+Performance/SortReverse:
+  Enabled: true
+Performance/Squeeze:
+  Enabled: true
+Performance/StringInclude:
+  Enabled: true

data/CHANGELOG.md

@@ -1,63 +1,76 @@
-# 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.1] - 2020-05-16
-
-### Added
-
-- Informative error messages when pnpm is not installed.
-- Pessimistic gem dependency version specifications to avoid installation conflicts.
-- Full-length gem description.
-- Forced shameful hoisting of installed pnpm dependencies via `webpacker:pnpm_install`.
-- Practical Pig development dependency for external RuboCop linting.
-
-### Changed
-
-- Commented and adjusted RuboCop formatting rules to clarify design decisions.
-
-### Removed
-
-- Testing configs for bleeding-edge Rails.
-
-## [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.
+# 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.3] - 2023-01-14
+
+### Fixed
+
+- Actually fixed cross-version watched path compatibility.
+- The previous v1.2.2 fix passed tests due to bad tests. Improved the test suite for real-life usage.
+
+## [v1.2.2] - 2023-01-13
+
+### Fixed
+
+- Watched paths for cross-version compatibility. (credit: [HipsterBrown](https://github.com/thearchitector/webpacker-pnpm/pull/4))
+
+## [v1.2.1] - 2020-05-16
+
+### Added
+
+- Informative error messages when pnpm is not installed.
+- Pessimistic gem dependency version specifications to avoid installation conflicts.
+- Full-length gem description.
+- Forced shameful hoisting of installed pnpm dependencies via `webpacker:pnpm_install`.
+- Practical Pig development dependency for external RuboCop linting.
+
+### Changed
+
+- Commented and adjusted RuboCop formatting rules to clarify design decisions.
+
+### Removed
+
+- Testing configs for bleeding-edge Rails.
+
+## [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

@@ -1,8 +1,8 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-gemspec
-
-install_if -> { Gem.win_platform? } do
-  gem "tzinfo-data"
-end
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec
+
+install_if -> { Gem.win_platform? } do
+  gem "tzinfo-data"
+end

data/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2023, Elias Gabriel
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -1,37 +1,44 @@
-# webpacker-pnpm
-
-[![version](https://img.shields.io/gem/v/webpacker-pnpm?label=version&style=flat-square)](https://rubygems.org/gems/webpacker-pnpm)
-[![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)](https://rubygems.org/gems/webpacker-pnpm)
-[![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/), a better, smarter, and more efficient Node.js package manager. As a result, applications become less prone to dependency hell, more functional, more stable, and more flexible. And as an added bonus, dependency resolution times and `node_modules` folder sizes reduce to within reasonable ranges (not 45 seconds and 10 GiB).
-
-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) by Zoltan Kochan (<https://www.kochan.io/nodejs/why-should-we-use-pnpm>).
-
-## 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.
+# webpacker-pnpm
+
+[![version](https://img.shields.io/gem/v/webpacker-pnpm?label=version&style=flat-square)](https://rubygems.org/gems/webpacker-pnpm)
+[![status](https://img.shields.io/github/actions/workflow/status/thearchitector/webpacker-pnpm/ci.yaml?label=tests&style=flat-square)](https://travis-ci.org/github/thearchitector/webpacker-pnpm)
+[![downloads](https://img.shields.io/gem/dt/webpacker-pnpm?style=flat-square)](https://rubygems.org/gems/webpacker-pnpm)
+[![license](https://img.shields.io/github/license/thearchitector/webpacker-pnpm?style=flat-square)](LICENSE)
+[![Buy a tree](https://img.shields.io/badge/Treeware-%F0%9F%8C%B3-lightgreen?style=flat-square)](https://ecologi.com/eliasgabriel?r=6128126916bfab8bd051026c)
+
+`webpacker-pnpm` replaces Rails' Yarn environment with [pnpm](https://pnpm.io), a better, smarter, and more efficient Node.js package manager. As a result, applications become less prone to dependency hell, more functional, more stable, and more flexible. And as an added bonus, dependency resolution times and `node_modules` folder sizes reduce to within reasonable ranges (not 45 seconds and 10 GiB).
+
+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) by Zoltan Kochan (<https://www.kochan.io/nodejs/why-should-we-use-pnpm>).
+
+## Features
+
+- Production-ready
+- Drop-in replacement for Yarn
+- Supports Rails' Template API, including existing templates using Yarn
+- 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.io/installation).
+
+After installing `pnpm`, first add `webpacker-pnpm` to your app's `Gemfile`.
+
+```ruby
+gem "webpacker-pnpm"
+```
+
+Secondly, add the following line to your `./bin/webpack` so it looks like below (the order matters). This step is required as Webpacker spawns a new process isolated from the Rails server (and thus all auto-loaded patches) when compilation happens live.
+
+```ruby
+require "webpacker/webpack_runner"
+require "webpacker/pnpm/patches" if ENV["RAILS_ENV"] != "production"
+```
+
+> _If you know of an automatic way of achieving a similar result, please open an Issue or PR with your suggestion._
+
+## License
+
+This software is licensed under the [BSD 3-Clause License](LICENSE).
+
+This package is Treeware. If you use it in production, consider buying the world a tree to thank me for my work. By contributing to my forest, you’ll be creating employment for local families and restoring wildlife habitats.

data/bin/console

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

@@ -1,8 +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
+#!/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/lib/webpacker/pnpm/patches.rb

@@ -1,53 +1,83 @@
-# 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
+# frozen_string_literal: true
+
+require "webpacker/compiler"
+require "webpacker/webpack_runner"
+require "rails/generators"
+require "rails/engine"
+
+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
+        [
+          *configured_paths,
+          config.source_path_globbed,
+          "pnpm-lock.yaml", "package.json",
+          "config/webpack/**/*"
+        ].freeze
+      end
+
+      def configured_paths
+        if config.respond_to?(:additional_paths_globbed)
+          config.additional_paths_globbed
+        else
+          config.resolved_paths_globbed
+        end
+      end
+    end
+
+    Webpacker::WebpackRunner.class_eval do
+      def run
+        env = Webpacker::Compiler.env
+        env["WEBPACKER_CONFIG"] = @webpacker_config
+
+        cmd = if node_modules_bin_exist?
+                ["#{@node_modules_bin_path}/webpack"]
+              else
+                ["pnpm", "webpack"]
+              end
+
+        cmd = ["node", "--inspect-brk"] + cmd if @argv.include?("--debug-webpacker")
+
+        cmd += ["--config", @webpack_config] + @argv
+
+        Dir.chdir(@app_path) do
+          Kernel.exec(env, *cmd)
+        end
+      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