esbuild-rails 0.1.0 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68b88826751bb695c1ca6fc0ec1b516260bdcf9e9d2ffdb82d2aa9a6920c5de2
-  data.tar.gz: 94e6540dfa0c07d54531616d1b957fa47e2b2d0572f4e877c2cdea8fb2faf86e
+  metadata.gz: bef9049287a92769cfe3fd83b58b7f3a4786c99cf5eb1e282afbc96585733b4a
+  data.tar.gz: 15c8ead90aa291b6d5bbf1a495f7f92f6dbf6173dfa8016d5a2a9229f18ed8e5
 SHA512:
-  metadata.gz: aff716a47c4964fddbbef2082a72857e313de582280ff45ebdf10774d1a971a45d02615568a033b6b9f103c98c8fd8072ffeeb3fa01bd4f37e3d39eaa2356cd5
-  data.tar.gz: b82f71efcba827218a5904874680c5f16cc93f11ce5c1756c5a3ede6e6f6974189791101a8480a61985465cb951e60700b9e6bc04b1359ca4f0dc8b7866c2b38
+  metadata.gz: 14ecd25d2e85ab98eecb18ec7686e49e74e33444f30808a290bba7551ee5ef1bb1fb1d13848d1bb5baea992db2371a47e2205e61ce428aca562518f4541cbab7
+  data.tar.gz: 3b7d99522da45bd89a72b3d126c7c292cd74528b723c35dc56d1b03905d10f7fea291adcd297541f7997bbc3168b013a19d0db03264a581bec3cdf5b9eb52814

data/README.md

@@ -1,10 +1,12 @@
 # esbuild for Rails
 
-Use [esbuild](https://esbuild.github.io) to bundle your JavaScript and deliver it via the asset pipeline in Rails. This gem provides an installer to get you going with esbuild in a new Rails application, and a convention to use `app/assets/esbuilds` to hold your bundled output as artifacts that are not checked into source control (the installer adds this directory to `.gitignore` by default).
+Use [esbuild](https://esbuild.github.io) to bundle your JavaScript, then deliver it via the asset pipeline in Rails. This gem provides an installer to get you going with esbuild 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 esbuild in watch mode in a terminal with `npm run watch` (and your Rails server in another, if you're not using something like [puma-dev](https://github.com/puma/puma-dev). Whenever esbuild detects changes to any of the JavaScript files in your project, it'll bundle `app/javascript/application.js` into `app/assets/esbuilds/javascript.js`. You can refer to the build output in your layout using the standard asset pipeline approach with `<%= javascript_include_tag "application" %>`.
+You develop using this approach by running esbuild 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 esbuild detects changes to any of the JavaScript files in your project, it'll bundle `app/javascript/application.js` into `app/assets/builds/javascript.js` (and all other entry points placed in the root of `app/javascript`). You can refer to the build output in your layout using the standard asset pipeline approach with `<%= javascript_include_tag "application" %>`.
 
-When you deploy your application to production, esbuild attaches to the `assets:precompile` task to ensure that all your package dependencies from `package.json` have been installed via npm, and then runs `npm run build` to process `app/javascript/application.js` into `app/assets/esbuilds/javascript.js`. The latter file is then picked up by the asset pipeline, digested, and copied into public/assets, as any other asset pipeline file.
+When you deploy your application to production, esbuild attaches to the `assets:precompile` task to ensure that all your package dependencies from `package.json` have been installed via npm, 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 esbuild attaches to the `test:prepare` task to ensure the JavaScript has been compiled 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`).
 
 That's it!
 
@@ -13,10 +15,19 @@ You can tailor the configuration of esbuild through the build script in `package
 
 ## Installation
 
+You must already have node and yarn installed on your system. Then:
+
 1. Add `esbuild-rails` to your Gemfile with `gem 'esbuild-rails'`
 2. Run `./bin/bundle install`
 3. Run `./bin/rails esbuild:install`
 
+Or, in Rails 7+, you can preconfigure your new application to use esbuild with `rails new myapp -j esbuild`.
+
+
+## The sister gem to rollupjs-rails
+
+This gem is almost identical in setup and purpose to [`rollupjs-rails`](https://github.com/rails/rollupjs-rails), which follows the same conventions, but uses [rollup.js](https://rollupjs.org) instead.
+
 
 ## License
 

data/lib/esbuild/version.rb

@@ -1,3 +1,3 @@
 module Esbuild
-  VERSION = "0.1.0"
+  VERSION = "0.1.4"
 end

data/lib/install/install.rb

@@ -1,17 +1,16 @@
-say "Compile into app/assets/esbuilds"
-directory "#{__dir__}/esbuilds", "app/assets/esbuilds"
-append_to_file "app/assets/config/manifest.js", %(//= link_tree ../esbuilds .js\n)
+say "Compile into app/assets/builds"
+empty_directory "app/assets/builds"
+keep_file "app/assets/builds"
+append_to_file "app/assets/config/manifest.js", %(//= link_tree ../builds .js\n)
 
 if Rails.root.join(".gitignore").exist?
-  append_to_file ".gitignore", %(\n/app/assets/esbuilds\n)
+  append_to_file ".gitignore", %(\n/app/assets/builds\n)
 end
 
 if (app_layout_path = Rails.root.join("app/views/layouts/application.html.erb")).exist?
   say "Add esbuild include tag in application layout"
-  insert_into_file app_layout_path.to_s, before: /\s*<\/head>/ do <<-HTML
-\n    <%= javascript_include_tag "application", "data-track-turbo": "true", defer: true %>
-HTML
-  end
+  insert_into_file app_layout_path.to_s, 
+    %(\n    <%= javascript_include_tag "application", "data-track-turbo": "true", defer: true %>), before: /\s*<\/head>/
 else
   say "Default application.html.erb is missing!", :red
   say %(        Add <%= javascript_include_tag "application", "data-track-turbo": "true", defer: true %> within the <head> tag in your custom layout.)
@@ -25,4 +24,4 @@ end
 
 say "Create default package.json and install esbuild"
 copy_file "#{__dir__}/package.json", "package.json"
-run "npm i esbuild"
+run "yarn add esbuild"

data/lib/install/package.json

@@ -2,7 +2,6 @@
   "name": "myapp",
   "private": "true",
   "scripts": {
-    "build": "esbuild app/javascript/application.js  --outfile=app/assets/esbuilds/application.js --bundle",
-    "watch": "npm run build -- --watch"
+    "build": "esbuild app/javascript/*.* --bundle --outdir=app/assets/builds"
   }
 }

data/lib/tasks/esbuild/compile.rake

@@ -1,8 +1,9 @@
 namespace :esbuild do
-  desc "Compile using esbuild with npm run build"
+  desc "Compile using esbuild with yarn build"
   task :compile do
-    system "npm install && npm run build"
+    system "yarn install && yarn build"
   end
 end
 
 Rake::Task["assets:precompile"].enhance(["esbuild:compile"])
+Rake::Task["test:prepare"].enhance(["esbuild:compile"])

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: esbuild-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.4
 platform: ruby
 authors:
 - David Heinemeier Hansson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-02 00:00:00.000000000 Z
+date: 2021-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails