shakapacker 7.0.3 → 7.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9451e388d4f6c2419456201c10b56e5f24ef5a1b6abaf82fb950187f16c4cbb
-  data.tar.gz: 9082cdaec1dffb060c1a903a3589373170741d0744b65c41d6d901669b77d614
+  metadata.gz: b52fbe18d6cc69e790f1432b93a8badee45c64229b7e0b5ad9bf6e7645c1c28c
+  data.tar.gz: 94ba2b7a48537e4b3ece200e2983975b444a340edff45b9af3544b1709375c38
 SHA512:
-  metadata.gz: bc8eb8a8b9b52b4a1a9c2a1bcb4ae6e24f59484ea97f660e030a5660b5c6b4d8b077f8e784fbf6f1bf032e5d89b0c26b7d5b421b8c2692747aafb9820e46971b
-  data.tar.gz: c3a7d20636ee49637516df81a72813f34f82dceb88ecd1dbc276071f6d44ce756326094d9b31feaf93d8d83325687af37eaead127b3f00e8cf25e9d65764be6f
+  metadata.gz: ade899e22f00c9863302d2a9aa7e58549d057b07be50d34d853751cabf59a9d318a637240734854059b352110b20245361ec7d427488166b4e481639b90cb380
+  data.tar.gz: 6364f8d109c008da994d01f7ad553472a90d5392511b796ba7286502d5f3b6969ad225cbd8e3364fb86da6f2dc5b19524631399eebae982b43558444cb886a0e

data/.github/workflows/dummy.yml

@@ -7,7 +7,9 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: '3.1.2'

data/.github/workflows/generator.yml

@@ -28,7 +28,9 @@ jobs:
       BUNDLE_GEMFILE: ${{ matrix.gemfile }}
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}

data/.github/workflows/jest.yml

@@ -13,9 +13,11 @@ jobs:
     runs-on: ${{ matrix.os }}
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
       - name: Use Node.js ${{ matrix.node }}
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node }}
           cache: yarn

data/.github/workflows/js-lint.yml

@@ -13,9 +13,11 @@ jobs:
     runs-on: ${{ matrix.os }}
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
       - name: Use Node.js ${{ matrix.node }}
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node }}
           cache: yarn

data/.github/workflows/rubocop.yml

@@ -12,7 +12,9 @@ jobs:
         ruby: ['2.7', '3.0']
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}

data/.github/workflows/ruby-backward-compatibility.yml

@@ -29,7 +29,9 @@ jobs:
       BUNDLE_GEMFILE: ${{ matrix.gemfile }}
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}

data/.github/workflows/ruby.yml

@@ -29,11 +29,13 @@ jobs:
       BUNDLE_GEMFILE: ${{ matrix.gemfile }}
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
 
       - name: Ruby specs
-        run: bundle exec rake run_spec:gem_bc
+        run: bundle exec rake run_spec:gem

data/CHANGELOG.md

@@ -9,6 +9,13 @@ Changes since last non-beta release.
 
 _Please add entries here for your pull requests that are not yet released._
 
+### Added
+- Support passing custom webpack config directly to `generateWebpackConfig` for merging [PR 343](https://github.com/shakacode/shakapacker/pull/343) by [G-Rath](https://github.com/g-rath)
+
+### Fixed
+- Use `NODE_OPTIONS` to enable Node-specific debugging flags [PR 350](https://github.com/shakacode/shakapacker/pull/350)
+- Add the boilplate `application.js` into `packs/` [PR 363](https://github.com/shakacode/shakapacker/pull/363)
+
 ## [v7.0.3] - July 7, 2023
 ### Fixed
 - Fixed commands execution for projects with space in absolute path [PR 322](https://github.com/shakacode/shakapacker/pull/322) by [kukicola](https://github.com/kukicola).

data/README.md

@@ -465,26 +465,40 @@ First, you don't _need_ to use Shakapacker's webpack configuration. However, the
 
 1. Your output files go to the right directory
 2. Your output includes a manifest, via package [`webpack-assets-manifest`](https://github.com/webdeveric/webpack-assets-manifest) that maps output names (your 'packs') to the fingerprinted versions, including bundle-splitting dependencies. That's the main secret sauce of Shakapacker!
+ 
+The webpack configuration used by Shakapacker lives in `config/webpack/webpack.config.js`; this makes it easy to customize the configuration beyond what's available in `config/shakapacker.yml` by giving you complete control of the final configuration. By default, this file exports the result of `generateWebpackConfig` which handles generating a webpack configuration based on `config/shakapacker.yml`.
 
-The most practical webpack configuration is to take the default from Shakapacker and then use [webpack-merge](https://github.com/survivejs/webpack-merge) to merge your customizations with the default. For example, suppose you want to add some `resolve.extensions`:
+The easiest way to modify this config is to pass your desired customizations to `generateWebpackConfig` which will use [webpack-merge](https://github.com/survivejs/webpack-merge) to merge them with the configuration generated from `config/shakapacker.yml`:
 
 ```js
-// use the new NPM package name, `shakapacker`.
-// merge is webpack-merge from https://github.com/survivejs/webpack-merge
+// config/webpack/webpack.config.js
+const { generateWebpackConfig } = require('shakapacker')
+
+const options = {
+  resolve: {
+      extensions: ['.css', '.ts', '.tsx']
+  }
+}
+
+// This results in a new object copied from the mutable global
+module.exports = generateWebpackConfig(options)
+```
+
+The `shakapacker` package also exports the `merge` function from [webpack-merge](https://github.com/survivejs/webpack-merge) to make it easier to do more advanced customizations:
+
+```js
+// config/webpack/webpack.config.js
 const { generateWebpackConfig, merge } = require('shakapacker')
 
-const baseWebpackConfig = generateWebpackConfig()
+const webpackConfig = generateWebpackConfig()
 
 const options = {
   resolve: {
-      extensions: ['.css', '.ts', '.tsx']
+    extensions: ['.css', '.ts', '.tsx']
   }
 }
 
-// Copy the object using merge b/c the baseClientWebpackConfig is a mutable global
-// If you want to use this object for client and server rendering configurations,
-// having a new object is essential.
-module.exports = merge({}, baseWebpackConfig, options)
+module.exports = merge(options, webpackConfig)
 ```
 
 This example is based on [an example project](https://github.com/shakacode/react_on_rails_tutorial_with_ssr_and_hmr_fast_refresh/blob/master/config/webpack/webpack.config.js)
@@ -513,12 +527,11 @@ Then `require` this file in your `config/webpack/webpack.config.js`:
 ```js
 // config/webpack/webpack.config.js
 // use the new NPM package name, `shakapacker`.
-const { generateWebpackConfig, merge } = require('shakapacker')
+const { generateWebpackConfig } = require('shakapacker')
 
-const webpackConfig = generateWebpackConfig()
 const customConfig = require('./custom')
 
-module.exports = merge(webpackConfig, customConfig)
+module.exports = generateWebpackConfig(customConfig)
 ```
 
 If you need access to configs within Shakapacker's configuration, you can import them like so:
@@ -616,12 +629,10 @@ Then modify the webpack config to use it as a plugin:
 
 ```js
 // config/webpack/webpack.config.js
-const { generateWebpackConfig, merge } = require("shakapacker");
-
-const webpackConfig = generateWebpackConfig()
+const { generateWebpackConfig } = require("shakapacker");
 const ForkTSCheckerWebpackPlugin = require("fork-ts-checker-webpack-plugin");
 
-module.exports = merge(webpackConfig, {
+module.exports = generateWebpackConfig({
   plugins: [new ForkTSCheckerWebpackPlugin()],
 });
 ```
@@ -638,9 +649,7 @@ Optionally, add the `CSS` extension to webpack config for easy resolution.
 
 ```js
 // config/webpack/webpack.config.js
-const { generateWebpackConfig, merge } = require('shakapacker')
-
-const webpackConfig = generateWebpackConfig()
+const { generateWebpackConfig } = require('shakapacker')
 
 const customConfig = {
   resolve: {
@@ -648,7 +657,7 @@ const customConfig = {
   }
 }
 
-module.exports = merge(webpackConfig, customConfig)
+module.exports = generateWebpackConfig(customConfig)
 ```
 
 To enable `PostCSS`, `Sass` or `Less` support, add `CSS` support first and

data/docs/troubleshooting.md

@@ -150,11 +150,9 @@ To silent these warnings, please update `config/webpack/webpack.config.js`:
 ```js
 const webpack = require('webpack')
 const { resolve } = require('path')
-const { generateWebpackConfig, merge } = require('shakapacker')
+const { generateWebpackConfig } = require('shakapacker')
 
-const webpackConfig = generateWebpackConfig();
-
-module.exports = merge(webpackConfig, {
+module.exports = generateWebpackConfig({
   plugins: [
     new webpack.ContextReplacementPlugin(
       /angular(\\|\/)core(\\|\/)(@angular|esm5)/,
@@ -201,11 +199,9 @@ Instead do:
 // config/webpack/webpack.config.js
 
 const webpack = require('webpack')
-const { generateWebpackConfig, merge } = require('shakapacker')
-
-const webpackConfig = generateWebpackConfig();
+const { generateWebpackConfig } = require('shakapacker')
 
-module.exports = merge(webpackConfig, {
+module.exports = generateWebpackConfig({
   plugins: [
     new webpack.ProvidePlugin({
       $: 'jquery',

data/docs/using_esbuild_loader.md

@@ -59,11 +59,9 @@ o do so, you need to modify your webpack configuration and use `ESBuildMinifyPlu
 Example:
 
 ```js
-const { generateWebpackConfig, merge } = require('shakapacker')
+const { generateWebpackConfig } = require('shakapacker')
 const { ESBuildMinifyPlugin } = require('esbuild-loader')
 
-const baseWebpackConfig = generateWebpackConfig()
-
 const options = {
   optimization: {
     minimizer: [
@@ -74,7 +72,7 @@ const options = {
   }
 }
 
-module.exports = merge({}, baseWebpackConfig, options)
+module.exports = generateWebpackConfig(options)
 ```
 
 For more details, see instructions at https://github.com/shakacode/shakapacker#webpack-configuration and https://github.com/privatenumber/esbuild-loader#js-minification-eg-terser.

data/lib/install/template.rb

@@ -14,8 +14,8 @@ if Dir.exist?(Shakapacker.config.source_path)
   say "The packs app source directory already exists"
 else
   say "Creating packs app source directory"
-  empty_directory "app/javascript"
-  copy_file "#{__dir__}/application.js", "app/javascript/application.js"
+  empty_directory "app/javascript/packs"
+  copy_file "#{__dir__}/application.js", "app/javascript/packs/application.js"
 end
 
 apply "#{__dir__}/binstubs.rb"

data/lib/shakapacker/deprecation_helper.rb

@@ -1,7 +1,7 @@
 require "thor"
 
 module Shakapacker
-  DEPRECATION_GUIDE_URL = "https://github.com/shakacode/shakapacker/docs/v7_upgrade.md"
+  DEPRECATION_GUIDE_URL = "https://github.com/shakacode/shakapacker/blob/master/docs/v7_upgrade.md"
   DEPRECATION_MESSAGE = <<~MSG
     DEPRECATION NOTICE:
 

data/lib/shakapacker/dev_server_runner.rb

@@ -66,6 +66,7 @@ module Shakapacker
         env = Shakapacker::Compiler.env
         env["SHAKAPACKER_CONFIG"] = @shakapacker_config
         env["WEBPACK_SERVE"] = "true"
+        env["NODE_OPTIONS"] = ENV["NODE_OPTIONS"] || ""
 
         cmd = if node_modules_bin_exist?
           ["#{@node_modules_bin_path}/webpack", "serve"]
@@ -83,7 +84,7 @@ module Shakapacker
         end
 
         if @argv.delete("--debug-shakapacker") || @argv.delete("--debug-webpacker")
-          cmd = [ "node", "--inspect-brk", "--trace-warnings" ] + cmd
+          env["NODE_OPTIONS"] = "#{env["NODE_OPTIONS"]} --inspect-brk --trace-warnings"
         end
 
         cmd += ["--config", @webpack_config]

data/lib/shakapacker/version.rb

@@ -1,4 +1,4 @@
 module Shakapacker
   # Change the version in package.json too, please!
-  VERSION = "7.0.3".freeze
+  VERSION = "7.1.0".freeze
 end

data/lib/shakapacker/version_checker.rb

@@ -91,7 +91,7 @@ module Shakapacker
         attr_reader :package_json
 
         def self.build
-          new(package_json_path, yarn_lock_path, package_lock_path)
+          new(package_json_path, yarn_lock_path, package_lock_path, pnpm_lock_path)
         end
 
         def self.package_json_path
@@ -106,10 +106,15 @@ module Shakapacker
           Rails.root.join("package-lock.json")
         end
 
-        def initialize(package_json, yarn_lock, package_lock)
+        def self.pnpm_lock_path
+          Rails.root.join("pnpm-lock.yaml")
+        end
+
+        def initialize(package_json, yarn_lock, package_lock, pnpm_lock)
           @package_json = package_json
           @yarn_lock = yarn_lock
           @package_lock = package_lock
+          @pnpm_lock = pnpm_lock
         end
 
         def raw
@@ -170,6 +175,12 @@ module Shakapacker
               return version unless version.nil?
             end
 
+            if File.exist?(@pnpm_lock)
+              version = from_pnpm_lock
+
+              return version unless version.nil?
+            end
+
             parsed_package_contents = JSON.parse(package_json_contents)
             parsed_package_contents.dig("dependencies", "shakapacker").to_s
           end
@@ -210,6 +221,28 @@ module Shakapacker
 
             version
           end
+
+          def from_pnpm_lock
+            require "yaml"
+
+            content = YAML.load_file(@pnpm_lock)
+
+            content.fetch("packages", {}).each do |key, value|
+              return value["version"] if value["name"] == "shakapacker"
+
+              parts = key.split("/")
+
+              return parts[2] if parts[1] == "shakapacker"
+              next unless parts[1].start_with?("shakapacker@")
+
+              _, version = parts[1].split("@")
+
+              return version[0, version.index("(")] if version.include?("(")
+              return version
+            end
+
+            nil
+          end
       end
   end
 end

data/lib/shakapacker/webpack_runner.rb

@@ -19,6 +19,7 @@ module Shakapacker
     def run
       env = Shakapacker::Compiler.env
       env["SHAKAPACKER_CONFIG"] = @shakapacker_config
+      env["NODE_OPTIONS"] = ENV["NODE_OPTIONS"] || ""
 
       cmd = if node_modules_bin_exist?
         ["#{@node_modules_bin_path}/webpack"]
@@ -36,15 +37,15 @@ module Shakapacker
       end
 
       if @argv.delete("--debug-shakapacker") || @argv.delete("--debug-webpacker")
-        cmd = ["node", "--inspect-brk"] + cmd
+        env["NODE_OPTIONS"] = "#{env["NODE_OPTIONS"]} --inspect-brk"
       end
 
       if @argv.delete "--trace-deprecation"
-        cmd = ["node", "--trace-deprecation"] + cmd
+        env["NODE_OPTIONS"] = "#{env["NODE_OPTIONS"]} --trace-deprecation"
       end
 
       if @argv.delete "--no-deprecation"
-        cmd = ["node", "--no-deprecation"] + cmd
+        env["NODE_OPTIONS"] = "#{env["NODE_OPTIONS"]} --no-deprecation"
       end
 
       # Webpack commands are not compatible with --config option.

data/package/__tests__/index.js

@@ -1,4 +1,5 @@
 const index = require('../index')
+const { generateWebpackConfig } = require("../index");
 
 describe('index', () => {
   test('exports webpack-merge v5 functions', () => {
@@ -19,4 +20,27 @@ describe('index', () => {
     expect(webpackConfig2).not.toHaveProperty('newKey')
     expect(webpackConfig2.output.path).not.toEqual('new value')
   })
+
+  test('webpackConfig merges extra config', () => {
+    const { generateWebpackConfig } = require('../index')
+
+    const webpackConfig = generateWebpackConfig({
+       newKey: 'new value',
+       output: {
+         path: 'new path'
+      }
+    })
+
+    expect(webpackConfig).toHaveProperty('newKey', 'new value')
+    expect(webpackConfig).toHaveProperty('output.path', 'new path')
+    expect(webpackConfig).toHaveProperty('output.publicPath', '/packs/')
+  })
+
+  test('webpackConfig errors if multiple configs are provided', () => {
+    const { generateWebpackConfig } = require('../index')
+
+    expect(() => generateWebpackConfig({}, {})).toThrow(
+      'use webpack-merge to merge configs before passing them to Shakapacker'
+    )
+  })
 })

data/package/index.d.ts

@@ -34,7 +34,7 @@ declare module 'shakapacker' {
 
   export const config: Config
   export const devServer: Record<string, unknown>
-  export function generateWebpackConfig(): Configuration
+  export function generateWebpackConfig(extraConfig?: Configuration): Configuration
   export const globalMutableWebpackConfig: Configuration
   export const baseConfig: Configuration
   export const env: Env

data/package/index.js

@@ -19,9 +19,15 @@ const globalMutableWebpackConfig = () => {
   return environmentConfig
 }
 
-const generateWebpackConfig = () => {
+const generateWebpackConfig = (extraConfig = {}, ...extraArgs) => {
+  if (extraArgs.length > 0) {
+    throw new Error(
+      'Only one extra config may be passed here - use webpack-merge to merge configs before passing them to Shakapacker'
+    )
+  }
+
   const environmentConfig = globalMutableWebpackConfig()
-  const immutable = webpackMerge.merge({}, environmentConfig)
+  const immutable = webpackMerge.merge({}, environmentConfig, extraConfig)
   return immutable
 }
 

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shakapacker",
-  "version": "7.0.3",
+  "version": "7.1.0",
   "description": "Use webpack to manage app-like JavaScript modules in Rails",
   "main": "package/index.js",
   "types": "package/index.d.ts",

data/spec/backward_compatibility_specs/compiler_strategy_spec.rb

@@ -2,17 +2,19 @@ require_relative "spec_helper_initializer"
 
 describe "Webpacker::CompilerStrategy" do
   describe "#from_config" do
-    it "returns and instance of MtimeStrategy when compiler_strategy is set to mtime" do
+    it "returns an instance of MtimeStrategy when compiler_strategy is set to mtime" do
       allow(Webpacker.config).to receive(:compiler_strategy).and_return("mtime")
+
       expect(Webpacker::CompilerStrategy.from_config).to be_an_instance_of(Webpacker::MtimeStrategy)
     end
 
-    it "returns and instance of DigestStrategy when compiler_strategy is set to digest" do
+    it "returns an instance of DigestStrategy when compiler_strategy is set to digest" do
       allow(Webpacker.config).to receive(:compiler_strategy).and_return("digest")
+
       expect(Webpacker::CompilerStrategy.from_config).to be_an_instance_of(Webpacker::DigestStrategy)
     end
 
-    it "raise exception for unknown compiler_strategy in the config file" do
+    it "raise an exception for unknown compiler_strategy in the config file" do
       expected_error_message = "Unknown strategy 'other'. Available options are 'mtime' and 'digest'."
       allow(Webpacker.config).to receive(:compiler_strategy).and_return("other")
 

data/spec/backward_compatibility_specs/configuration_spec.rb

@@ -14,36 +14,43 @@ describe "Webpacker::Configuration" do
 
     it "#source_path returns correct path" do
       source_path = File.expand_path File.join(File.dirname(__FILE__), "webpacker_test_app/app/packs").to_s
+
       expect(config.source_path.to_s).to eq source_path
     end
 
     it "#source_entry_path returns correct path" do
       source_entry_path = File.expand_path File.join(File.dirname(__FILE__), "webpacker_test_app/app/packs", "entrypoints").to_s
+
       expect(config.source_entry_path.to_s).to eq source_entry_path
     end
 
     it "#public_root_path returns correct path" do
       public_root_path = File.expand_path File.join(File.dirname(__FILE__), "webpacker_test_app/public").to_s
+
       expect(config.public_path.to_s).to eq public_root_path
     end
 
     it "#public_output_path returns correct path" do
       public_output_path = File.expand_path File.join(File.dirname(__FILE__), "webpacker_test_app/public/packs").to_s
+
       expect(config.public_output_path.to_s).to eq public_output_path
     end
 
     it "#public_manifest_path returns correct path" do
       public_manifest_path = File.expand_path File.join(File.dirname(__FILE__), "webpacker_test_app/public/packs", "manifest.json").to_s
+
       expect(config.public_manifest_path.to_s).to eq public_manifest_path
     end
 
     it "#manifest_path returns correct path" do
       manifest_path = File.expand_path File.join(File.dirname(__FILE__), "webpacker_test_app/public/packs", "manifest.json").to_s
+
       expect(config.manifest_path.to_s).to eq manifest_path
     end
 
     it "#cache_path returns correct path" do
       cache_path = File.expand_path File.join(File.dirname(__FILE__), "webpacker_test_app/tmp/webpacker").to_s
+
       expect(config.cache_path.to_s).to eq cache_path
     end
 
@@ -186,6 +193,7 @@ describe "Webpacker::Configuration" do
 
     it "#public_output_path returns correct path" do
       expected_public_output_path = File.expand_path File.join(File.dirname(__FILE__), "public/packs").to_s
+
       expect(config.public_output_path.to_s).to eq expected_public_output_path
     end
   end
@@ -199,6 +207,7 @@ describe "Webpacker::Configuration" do
 
     it "#manifest_path returns correct expected value" do
       expected_manifest_path = File.expand_path File.join(File.dirname(__FILE__), "webpacker_test_app/app/packs", "manifest.json").to_s
+
       expect(config.manifest_path.to_s).to eq expected_manifest_path
     end
   end
@@ -206,8 +215,8 @@ describe "Webpacker::Configuration" do
   context "with webpacker_precompile entry set to false" do
     describe "#webpacker_precompile?" do
       before :each do
-        ENV.delete("WEBPACKER_PRECOMPILE")
         ENV.delete("SHAKAPACKER_PRECOMPILE")
+        ENV.delete("WEBPACKER_PRECOMPILE")
       end
 
       let(:config) {
@@ -229,9 +238,8 @@ describe "Webpacker::Configuration" do
         expect(subject).to be true
       end
 
-      it "returns false with WEBPACKER_PRECOMPILE set to falsy value" do
-        # ENV["WEBPACKER_PRECOMPILE"] = "no"
-        ENV.delete("WEBPACKER_PRECOMPILE")
+      it "returns false with WEBPACKER_PRECOMPILE set to nil" do
+        ENV["SHAKAPACKER_PRECOMPILE"] = nil
         expect(subject).to be false
       end
     end