jsbundling-rails 1.0.3 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5a44be3ec3ce6c70cdea6a949eb1161de8d93fc862fea729d6c69fd75507540
-  data.tar.gz: 8ac2566fb564e1b0f7c705c923bdd4cf19db68559d2549690ce388057aa56100
+  metadata.gz: e87af17983ef465c2f92f63a3943df1ed2f1508eec23644f4134bdef5430ec27
+  data.tar.gz: de600a6cefeb7f190d1348f7edbe328d71fe13aeff2dd8903dcc4ff78a029a60
 SHA512:
-  metadata.gz: a1fc1a7e5b48df676886d33b078a44b261312867ab16257900881924908ff5a669d27859673ece993c194e923e9d8d085da2ac101ee29928f648941382b87be2
-  data.tar.gz: '059d18f58411a82e4e68f2b2484232bb4da9135e0dcbf00cd64fc239ade89ff7bdbaabe199bf1fd48fc69af57414d55e60912201fe004c23be4e928f16140d13'
+  metadata.gz: 06f0040b3476411f6bcb1bfcef1280763161c53a2dddb9087c180f31e8b360992dcb6191aa04c08755298d69b3f5671a5583a435b1a988b55fca2370a794958f
+  data.tar.gz: 18f37485ec256760ed0343d820da6798b6e2f358d4db3c9a653f4d95ccc961c11db4380c25add8d2e6776bcbc058e56229563c7d4fb261b53efc9f9f795335fb

data/README.md

@@ -8,9 +8,7 @@ Whenever the bundler detects changes to any of the JavaScript files in your proj
 
 When you deploy your application to production, the `javascript:build` task attaches to the `assets:precompile` task to ensure that all your package dependencies from `package.json` have been installed via yarn, and then runs `yarn build` to process all the entry points, as it would in development. The latter files are then picked up by the asset pipeline, digested, and copied into public/assets, as any other asset pipeline file.
 
-This also happens in testing where the bundler attaches to the `test:prepare` task to ensure the JavaScript has been bundled before testing commences. (Note that this currently only applies to rails `test:*` tasks (like `test:all` or `test:controllers`), not "rails test", as that doesn't load `test:prepare`).
-
-If your testing library of choice does not define a `test:prepare` Rake task, ensure that your test suite runs `javascript:build` to bundle JavaScript before testing commences.
+This also happens in testing where the bundler attaches to the `test:prepare` task to ensure the JavaScript has been bundled before testing commences. If your testing library of choice does not call the `test:prepare` Rake task, ensure that your test suite runs `javascript:build` to bundle JavaScript before testing commences.
 
 That's it!
 
@@ -22,10 +20,15 @@ If you want to use webpack features like [code splitting](https://webpack.js.org
 
 ## Installation
 
-You must already have node and yarn installed on your system. You will also need npx version 7.1.0 or later. Then:
+You must already have node and yarn installed on your system. You will also need npx version 7.1.0 or later. Then run:
+
+```
+./bin/bundle add jsbundling-rails
+```
 
-1. Run `./bin/bundle add jsbundling-rails`
-2. Run `./bin/rails javascript:install:[esbuild|rollup|webpack]`
+```
+./bin/rails javascript:install:[esbuild|rollup|webpack]
+```
 
 Or, in Rails 7+, you can preconfigure your new application to use a specific bundler with `rails new myapp -j [esbuild|rollup|webpack]`.
 
@@ -45,11 +48,13 @@ If you [import CSS](https://esbuild.github.io/content-types/#css-from-js) in you
 Suppose you have an image `app/javascript/images/example.png` that you need to reference in frontend code built with esbuild.
 
 1. Create the image at `app/javascript/images/example.png`.
-1. In `package.json`, under `"scripts"` and `"build"`, add the option `--loader:.png=file` to the esbuild script, which instructs esbuild to copy png files to the build directory.
-1. When esbuild runs, it will copy the png file to something like `app/assets/builds/example-5SRKKTLZ.png`.
+1. In `package.json`, under `"scripts"` and `"build"`, add the additional arguments:
+    * `--loader:.png=file` This instructs esbuild to copy png files to the build directory.
+    * `--asset-names=[name]-[hash].digested` This tells esbuild to append `.digested` to the file name so that sprockets or propshaft will not append an additional digest hash to the file.
+1. When esbuild runs, it will copy the png file to something like `app/assets/builds/example-5SRKKTLZ.digested.png`.
 1. In frontend code, the image is available for import by its original name: `import Example from "../images/example.png"`.
 1. The image itself can now be referenced by its imported name, e.g. in React, `<img src={Example} />`.
-1. The path of the image resolves to `/assets/example-5SRKKTLZ.png`, which is served by the asset pipeline.
+1. The path of the image resolves to `/assets/example-5SRKKTLZ.digested.png`, which is served by the asset pipeline.
 
 ## License
 

data/lib/install/Procfile.dev

@@ -1,2 +1,2 @@
-web: bin/rails server -p 3000
+web: unset PORT && env RUBY_DEBUG_OPEN=true bin/rails server
 js: yarn build --watch

data/lib/install/dev

@@ -1,9 +1,8 @@
-#!/usr/bin/env bash
+#!/usr/bin/env sh
 
-if ! foreman version &> /dev/null
-then
+if ! gem list foreman -i --silent; then
   echo "Installing foreman..."
   gem install foreman
 fi
 
-foreman start -f Procfile.dev "$@"
+exec foreman start -f Procfile.dev "$@"

data/lib/install/esbuild/install.rb

@@ -2,11 +2,15 @@ say "Install esbuild"
 run "yarn add esbuild"
 
 say "Add build script"
-build_script = "esbuild app/javascript/*.* --bundle --sourcemap --outdir=app/assets/builds --public-path=assets"
+build_script = "esbuild app/javascript/*.* --bundle --sourcemap --outdir=app/assets/builds --public-path=/assets"
 
-if (`npx -v`.to_f < 7.1 rescue "Missing")
-  say %(Add "scripts": { "build": "#{build_script}" } to your package.json), :green
-else
+case `npx -v`.to_f
+when 7.1...8.0
   run %(npm set-script build "#{build_script}")
   run %(yarn build)
+when (8.0..)
+  run %(npm pkg set scripts.build="#{build_script}")
+  run %(yarn build)
+else
+  say %(Add "scripts": { "build": "#{build_script}" } to your package.json), :green
 end

data/lib/install/rollup/install.rb

@@ -3,11 +3,15 @@ copy_file "#{__dir__}/rollup.config.js", "rollup.config.js"
 run "yarn add rollup @rollup/plugin-node-resolve"
 
 say "Add build script"
-build_script = "rollup -c rollup.config.js"
+build_script = "rollup -c --bundleConfigAsCjs rollup.config.js"
 
-if (`npx -v`.to_f < 7.1 rescue "Missing")
-  say %(Add "scripts": { "build": "#{build_script}" } to your package.json), :green
-else
+case `npx -v`.to_f
+when 7.1...8.0
   run %(npm set-script build "#{build_script}")
   run %(yarn build)
+when (8.0..)
+  run %(npm pkg set scripts.build="#{build_script}")
+  run %(yarn build)
+else
+  say %(Add "scripts": { "build": "#{build_script}" } to your package.json), :green
 end

data/lib/install/rollup/rollup.config.js

@@ -4,7 +4,7 @@ export default {
   input: "app/javascript/application.js",
   output: {
     file: "app/assets/builds/application.js",
-    format: "es",
+    format: "iife",
     inlineDynamicImports: true,
     sourcemap: true
   },

data/lib/install/webpack/install.rb

@@ -5,9 +5,13 @@ run "yarn add webpack webpack-cli"
 say "Add build script"
 build_script = "webpack --config webpack.config.js"
 
-if (`npx -v`.to_f < 7.1 rescue "Missing")
-  say %(Add "scripts": { "build": "#{build_script}" } to your package.json), :green
-else
+case `npx -v`.to_f
+when 7.1...8.0
   run %(npm set-script build "#{build_script}")
   run %(yarn build)
+when (8.0..)
+  run %(npm pkg set scripts.build="#{build_script}")
+  run %(yarn build)
+else
+  say %(Add "scripts": { "build": "#{build_script}" } to your package.json), :green
 end

data/lib/jsbundling/version.rb

@@ -1,3 +1,3 @@
 module Jsbundling
-  VERSION = "1.0.3"
+  VERSION = "1.1.2"
 end

data/lib/tasks/jsbundling/build.rake

@@ -1,10 +1,18 @@
 namespace :javascript do
+  desc "Install JavaScript dependencies"
+  task :install do
+    unless system "yarn install"
+      raise "jsbundling-rails: Command install failed, ensure yarn is installed"
+    end
+  end
+
   desc "Build your JavaScript bundle"
-  task :build do
-    unless system "yarn install && yarn build"
-      raise "jsbundling-rails: Command build failed, ensure yarn is installed and `yarn build` runs without errors"
+  build_task = task :build do
+    unless system "yarn build"
+      raise "jsbundling-rails: Command build failed, ensure `yarn build` runs without errors"
     end
   end
+  build_task.prereqs << :install unless ENV["SKIP_YARN_INSTALL"]
 end
 
 if Rake::Task.task_defined?("assets:precompile")
@@ -13,6 +21,8 @@ end
 
 if Rake::Task.task_defined?("test:prepare")
   Rake::Task["test:prepare"].enhance(["javascript:build"])
+elsif Rake::Task.task_defined?("spec:prepare")
+  Rake::Task["spec:prepare"].enhance(["javascript:build"])
 elsif Rake::Task.task_defined?("db:test:prepare")
   Rake::Task["db:test:prepare"].enhance(["javascript:build"])
 end

data/lib/tasks/jsbundling/clobber.rake

@@ -1,7 +1,7 @@
 namespace :javascript do
   desc "Remove JavaScript builds"
   task :clobber do
-    rm_rf Dir["app/assets/builds/[^.]*.{js,js.map}"], verbose: false
+    rm_rf Dir["app/assets/builds/**/[^.]*.{js,js.map}"], verbose: false
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsbundling-rails
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.2
 platform: ruby
 authors:
 - David Heinemeier Hansson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-19 00:00:00.000000000 Z
+date: 2023-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -67,7 +67,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.14
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Bundle and transpile JavaScript in Rails with esbuild, rollup.js, or Webpack.