jsbundling-rails 0.1.6 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f033365241900785d685cec941c60f95bc277fd5cfdc3d890ef7eefce5dfb56
-  data.tar.gz: 19fcf6845a974aef5f3117be9b49d89c1b12feb939aca04630f76d67386eadef
+  metadata.gz: 6b3886c122782f8cee3ae39317eee237ffe67500f2b6e8e4d0e46192d3214c5b
+  data.tar.gz: ede0353d4327d3dff14c7f119271cc40883d76e7bb2fdaf442ba8b508e33961b
 SHA512:
-  metadata.gz: b11c77766dc06e798b6ef21c389e56622a99eefad0783ae9504fa79f38f3f5a04382d4dcfd07595af0b5c17622ea631280b23a6b7eb598032be60acd6492b4e0
-  data.tar.gz: ef6febf07270d97e17032ef5599eee322d61607188e1a2a9ad2319ab02322175f5f5db29ac1577246d72b02f8f1ea58f719cda64961ff82fea39c904d0ee8abc
+  metadata.gz: 989e1c975ed68bcbb5ed1beb7fdda1b46ec7f8dd764ebf1c0871300541bd651fe74aefd8ac5c4379e347141d7e21553052d03f0ac31e3e580e72d9acabe92daa
+  data.tar.gz: e17204a1e4e953ada58ccead4e26b4f636075592b97f12b0bba0644d55a54431086b1ca944855f679db5c200870869a4a838371517097d873f2b0dfa67fe4858

data/README.md

@@ -2,7 +2,9 @@
 
 Use [esbuild](https://esbuild.github.io), [rollup.js](https://rollupjs.org), or [Webpack](https://webpack.js.org) to bundle your JavaScript, then deliver it via the asset pipeline in Rails. This gem provides installers to get you going with the bundler of your choice in a new Rails application, and a convention to use `app/assets/builds` to hold your bundled output as artifacts that are not checked into source control (the installer adds this directory to `.gitignore` by default).
 
-You develop using this approach by running the bundler in watch mode in a terminal with `yarn build --watch` (and your Rails server in another, if you're not using something like [puma-dev](https://github.com/puma/puma-dev)). Whenever the bundler detects changes to any of the JavaScript files in your project, it'll bundle `app/javascript/application.js` into `app/assets/builds/application.js` (and all other entry points configured). You can refer to the build output in your layout using the standard asset pipeline approach with `<%= javascript_include_tag "application", defer: true %>`.
+You develop using this approach by running the bundler in watch mode in a terminal with `yarn build --watch` (and your Rails server in another, if you're not using something like [puma-dev](https://github.com/puma/puma-dev)). You can also use `./bin/dev`, which will start both the Rails server and the JS build watcher (along with a CSS build watcher, if you're also using `cssbundling-rails`).
+
+Whenever the bundler detects changes to any of the JavaScript files in your project, it'll bundle `app/javascript/application.js` into `app/assets/builds/application.js` (and all other entry points configured). You can refer to the build output in your layout using the standard asset pipeline approach with `<%= javascript_include_tag "application", defer: true %>`.
 
 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.
 
@@ -12,7 +14,7 @@ If your testing library of choice does not define a `test:prepare` Rake task, en
 
 That's it!
 
-You can configure your bundler options in the `build` script in `package.json` or via the installer-generated `rollup.config.js` for rollup.js or `webpack.config.json` for Webpack (esbuild does not have a default configuration format).
+You can configure your bundler options in the `build` script in `package.json` or via the installer-generated `rollup.config.js` for rollup.js or `webpack.config.json` for Webpack (esbuild does not have a default configuration format, and we don't intend to use esbuild as an API in order to hack around it).
 
 If you're already using [`webpacker`](https://github.com/rails/webpacker) and you're wondering if you should migrate to `jsbundling-rails`, have a look at [the high-level comparison](./docs/comparison_with_webpacker.md).
 
@@ -28,6 +30,17 @@ You must already have node and yarn installed on your system. You will also need
 Or, in Rails 7+, you can preconfigure your new application to use a specific bundler with `rails new myapp -j [esbuild|rollup|webpack]`.
 
 
+## FAQ
+
+### Is there a work-around for lack of glob syntax on Windows?
+
+The default build script for esbuild relies on the `app/javascript/*.*` glob pattern to compile multiple entrypoints automatically. This glob pattern is not available by default on Windows, so you need to change the build script in `package.json` to manually list the entrypoints you wish to compile.
+
+## Why does esbuild overwrite my application.css?
+
+If you [import CSS](https://esbuild.github.io/content-types/#css-from-js) in your application.js while using esbuild, you'll be creating both an `app/assets/builds/application.js` _and_ `app/assets/builds/application.css` file when bundling. The latter can conflict with the `app/assets/builds/application.js` produced by [cssbundling-rails](https://github.com/rails/cssbundling-rails). The solution is to either change the output file for esbuild (and the references for that) or for cssbundling. Both are specified in `package.json`. 
+
+
 ## License
 
 JavaScript Bundling for Rails is released under the [MIT License](https://opensource.org/licenses/MIT).

data/lib/install/dev

@@ -1,3 +1,9 @@
 #!/usr/bin/env bash
 
+if ! command -v foreman &> /dev/null
+then
+  echo "Installing foreman..."
+  gem install foreman
+fi
+
 foreman start -f Procfile.dev

data/lib/install/esbuild/install.rb

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

data/lib/install/install.rb

@@ -7,7 +7,8 @@ if (sprockets_manifest_path = Rails.root.join("app/assets/config/manifest.js")).
 end
 
 if Rails.root.join(".gitignore").exist?
-  append_to_file(".gitignore", %(\n/app/assets/builds/*\n!/app/assets/builds/.keep\n/node_modules\n))
+  append_to_file(".gitignore", %(\n/app/assets/builds/*\n!/app/assets/builds/.keep\n))
+  append_to_file(".gitignore", %(\n/node_modules\n))
 end
 
 if (app_layout_path = Rails.root.join("app/views/layouts/application.html.erb")).exist?
@@ -31,7 +32,7 @@ unless Rails.root.join("package.json").exist?
 end
 
 if Rails.root.join("Procfile.dev").exist?
-  append_to_file "Procfile.dev", "js: yarn build --watch"
+  append_to_file "Procfile.dev", "js: yarn build --watch\n"
 else
   say "Add default Procfile.dev"
   copy_file "#{__dir__}/Procfile.dev", "Procfile.dev"

data/lib/install/rollup/install.rb

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

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

@@ -5,7 +5,8 @@ export default {
   output: {
     file: "app/assets/builds/application.js",
     format: "es",
-    inlineDynamicImports: true
+    inlineDynamicImports: true,
+    sourcemap: true
   },
   plugins: [
     resolve()

data/lib/install/webpack/install.rb

@@ -3,4 +3,10 @@ copy_file "#{__dir__}/webpack.config.js", "webpack.config.js"
 run "yarn add webpack webpack-cli"
 
 say "Add build script"
-run %(npm set-script build "webpack --config webpack.config.js")
+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
+  run %(npm set-script build "#{build_script}")
+end

data/lib/install/webpack/webpack.config.js

@@ -1,13 +1,15 @@
 const path    = require("path")
-const webpack = require('webpack')
+const webpack = require("webpack")
 
 module.exports = {
   mode: "production",
+  devtool: "source-map",
   entry: {
     application: "./app/javascript/application.js"
   },
   output: {
     filename: "[name].js",
+    sourceMapFilename: "[name].js.map",
     path: path.resolve(__dirname, "app/assets/builds"),
   },
   plugins: [

data/lib/jsbundling/version.rb

@@ -1,3 +1,3 @@
 module Jsbundling
-  VERSION = "0.1.6"
+  VERSION = "0.2.0"
 end

data/lib/tasks/jsbundling/build.rake

@@ -1,7 +1,9 @@
 namespace :javascript do
   desc "Build your JavaScript bundle"
-  task :build do
-    system "yarn install && yarn build"
+  task build: [ "yarn:install" ] do
+    unless system "yarn build"
+      raise "jsbundling-rails: Command build failed, ensure yarn is installed and `yarn build` runs without errors"
+    end
   end
 end
 

data/lib/tasks/jsbundling/clean.rake

@@ -0,0 +1,8 @@
+namespace :javascript do
+  desc "Remove JavaScript builds"
+  task :clean do
+    rm_rf Dir["app/assets/builds/[^.]*.js"], verbose: false
+  end
+end
+
+Rake::Task["assets:clean"].enhance(["javascript:clean"])

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsbundling-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.0
 platform: ruby
 authors:
 - David Heinemeier Hansson
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-19 00:00:00.000000000 Z
+date: 2021-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -24,21 +24,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 6.0.0
-- !ruby/object:Gem::Dependency
-  name: sprockets-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.0.0
-description: 
+description:
 email: david@loudthinking.com
 executables: []
 extensions: []
@@ -60,12 +46,13 @@ files:
 - lib/jsbundling/engine.rb
 - lib/jsbundling/version.rb
 - lib/tasks/jsbundling/build.rake
+- lib/tasks/jsbundling/clean.rake
 - lib/tasks/jsbundling/install.rake
 homepage: https://github.com/rails/jsbundling-rails
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -80,8 +67,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Bundle and transpile JavaScript in Rails with esbuild, rollup.js, or Webpack.
 test_files: []