esbuild-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 68b88826751bb695c1ca6fc0ec1b516260bdcf9e9d2ffdb82d2aa9a6920c5de2
+  data.tar.gz: 94e6540dfa0c07d54531616d1b957fa47e2b2d0572f4e877c2cdea8fb2faf86e
+SHA512:
+  metadata.gz: aff716a47c4964fddbbef2082a72857e313de582280ff45ebdf10774d1a971a45d02615568a033b6b9f103c98c8fd8072ffeeb3fa01bd4f37e3d39eaa2356cd5
+  data.tar.gz: b82f71efcba827218a5904874680c5f16cc93f11ce5c1756c5a3ede6e6f6974189791101a8480a61985465cb951e60700b9e6bc04b1359ca4f0dc8b7866c2b38

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2021 Basecamp
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,23 @@
+# 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).
+
+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" %>`.
+
+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.
+
+That's it!
+
+You can tailor the configuration of esbuild through the build script in `package.json`. Or if you want to get fancy with plugins, you can setup an [external configuration](https://esbuild.github.io/getting-started/#build-scripts) to run through node.
+
+
+## Installation
+
+1. Add `esbuild-rails` to your Gemfile with `gem 'esbuild-rails'`
+2. Run `./bin/bundle install`
+3. Run `./bin/rails esbuild:install`
+
+
+## License
+
+esbuild for Rails is released under the [MIT License](https://opensource.org/licenses/MIT).

data/lib/esbuild/engine.rb

@@ -0,0 +1,4 @@
+module Esbuild
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/esbuild/version.rb

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

data/lib/esbuild-rails.rb

@@ -0,0 +1,5 @@
+module Esbuild
+end
+
+require "esbuild/version"
+require "esbuild/engine"

data/lib/install/application.js

@@ -0,0 +1 @@
+// Entrypoint for the esbuild command defined in package.json scripts

data/lib/install/install.rb

@@ -0,0 +1,28 @@
+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)
+
+if Rails.root.join(".gitignore").exist?
+  append_to_file ".gitignore", %(\n/app/assets/esbuilds\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
+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.)
+end
+
+unless (app_js_entrypoint_path = Rails.root.join("app/javascript/application.js")).exist?
+  say "Create default entrypoint in app/javascript/application.js"
+  empty_directory app_js_entrypoint_path.parent.to_s
+  copy_file "#{__dir__}/application.js", app_js_entrypoint_path
+end
+
+say "Create default package.json and install esbuild"
+copy_file "#{__dir__}/package.json", "package.json"
+run "npm i esbuild"

data/lib/install/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "myapp",
+  "private": "true",
+  "scripts": {
+    "build": "esbuild app/javascript/application.js  --outfile=app/assets/esbuilds/application.js --bundle",
+    "watch": "npm run build -- --watch"
+  }
+}

data/lib/tasks/esbuild/compile.rake

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

data/lib/tasks/esbuild/install.rake

@@ -0,0 +1,6 @@
+namespace :esbuild do
+  desc "Setup esbuild"
+  task :install do
+    system "#{RbConfig.ruby} ./bin/rails app:template LOCATION=#{File.expand_path("../../install/install.rb",  __dir__)}"
+  end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: esbuild-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David Heinemeier Hansson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-09-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+description: 
+email: david@loudthinking.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- lib/esbuild-rails.rb
+- lib/esbuild/engine.rb
+- lib/esbuild/version.rb
+- lib/install/application.js
+- lib/install/install.rb
+- lib/install/package.json
+- lib/tasks/esbuild/compile.rake
+- lib/tasks/esbuild/install.rake
+homepage: https://github.com/rails/esbuild-rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Bundle and transpile JavaScript in Rails with esbuild.
+test_files: []