bridgetown-core 1.2.0 → 1.3.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 599f0ff57d4bac2146e5cacb12ccb8f2e7e02026815447c2db9cbf914ed9d3a2
-  data.tar.gz: be29cede2daa248b4db41bb6a7eaeebb7d3533b54a5cf891922b0762a6ca47e0
+  metadata.gz: 58cbef52cc9ace0226b8a2ba380589287678d686684bf4d81e5889a6d3ed25bc
+  data.tar.gz: 14a1a0f631574b0df1e9844660eeff2a6e5e50ad53b998991a3b9a636654a05f
 SHA512:
-  metadata.gz: 739ed852e60fabf0b6b2d352c8ce8993d4751a1f6cfec67c0bb7ed4cc5f0af41bb82fb8dc3eb34f5806a421bcec38e9050cd0fbcb50249a0482f5804e19a1d27
-  data.tar.gz: 97eea9cb28095624a8d47821f754df39790d8db46e62d79774371113c875fd914a796f3e445ad982e6f8de8e94d5babf7b8be1736c4bc93f3a9fe0a0f6862433
+  metadata.gz: 520791c7e08bdc24e4af37ac399bc0a2d73d939b8ea229188b162f90063b05e394e254dabfa7d529db2d41018bc2bf0fee62b5591a14961a2f88fd40d47a1ddc
+  data.tar.gz: d623c999cb2ceadcacbed1b1dfbdfd365dd3b705e5583037cb23398d0519301d0052e20b9005b3ab0ce75d0b8c6143abc46f352fbeec7313eef1c8864da6ec57

data/bridgetown-core.gemspec

@@ -31,26 +31,25 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version     = ">= 2.7.0"
 
-  s.add_runtime_dependency("activemodel",           [">= 6.0", "< 8.0"])
-  s.add_runtime_dependency("activesupport",         [">= 6.0", "< 8.0"])
-  s.add_runtime_dependency("addressable",           "~> 2.4")
-  s.add_runtime_dependency("amazing_print",         "~> 1.2")
-  s.add_runtime_dependency("colorator",             "~> 1.0")
-  s.add_runtime_dependency("erubi",                 "~> 1.9")
-  s.add_runtime_dependency("faraday",               "~> 1.0")
-  s.add_runtime_dependency("faraday_middleware",    "~> 1.0")
-  s.add_runtime_dependency("hash_with_dot_access",  "~> 1.2")
-  s.add_runtime_dependency("i18n",                  "~> 1.0")
-  s.add_runtime_dependency("kramdown",              "~> 2.1")
-  s.add_runtime_dependency("kramdown-parser-gfm",   "~> 1.0")
-  s.add_runtime_dependency("liquid",                "~> 5.0")
-  s.add_runtime_dependency("listen",                "~> 3.0")
-  s.add_runtime_dependency("rake",                  ">= 13.0")
-  s.add_runtime_dependency("roda",                  "~> 3.46")
-  s.add_runtime_dependency("rouge",                 "~> 3.0")
-  s.add_runtime_dependency("serbea",                "~> 1.0")
-  s.add_runtime_dependency("thor",                  "~> 1.1")
-  s.add_runtime_dependency("tilt",                  "~> 2.0")
-  s.add_runtime_dependency("webrick",               "~> 1.7")
-  s.add_runtime_dependency("zeitwerk",              "~> 2.5")
+  s.add_runtime_dependency("activemodel",               [">= 6.0", "< 8.0"])
+  s.add_runtime_dependency("activesupport",             [">= 6.0", "< 8.0"])
+  s.add_runtime_dependency("addressable",               "~> 2.4")
+  s.add_runtime_dependency("amazing_print",             "~> 1.2")
+  s.add_runtime_dependency("colorator",                 "~> 1.0")
+  s.add_runtime_dependency("erubi",                     "~> 1.9")
+  s.add_runtime_dependency("faraday",                   "~> 2.0")
+  s.add_runtime_dependency("faraday-follow_redirects",  "~> 0.3")
+  s.add_runtime_dependency("hash_with_dot_access",      "~> 1.2")
+  s.add_runtime_dependency("i18n",                      "~> 1.0")
+  s.add_runtime_dependency("kramdown",                  "~> 2.1")
+  s.add_runtime_dependency("kramdown-parser-gfm",       "~> 1.0")
+  s.add_runtime_dependency("liquid",                    "~> 5.0")
+  s.add_runtime_dependency("listen",                    "~> 3.0")
+  s.add_runtime_dependency("rake",                      ">= 13.0")
+  s.add_runtime_dependency("roda",                      "~> 3.46")
+  s.add_runtime_dependency("rouge",                     "~> 3.0")
+  s.add_runtime_dependency("serbea",                    "~> 1.0")
+  s.add_runtime_dependency("thor",                      "~> 1.1")
+  s.add_runtime_dependency("tilt",                      "~> 2.0")
+  s.add_runtime_dependency("zeitwerk",                  "~> 2.5")
 end

data/lib/bridgetown-core/collection.rb

@@ -282,7 +282,7 @@ module Bridgetown
       if model_is_multi_locale?(model, model_relative_path)
         # If the model specifies a locales key, use that to determine the
         # the locale of each resource, otherwise fall back to `site.config.available_locales`
-        locales = model.locales || site.config.available_locales
+        locales = model.attributes[:locales] || site.config.available_locales
 
         locales.each do |locale|
           model.locale = locale.to_sym

data/lib/bridgetown-core/commands/build.rb

@@ -48,6 +48,9 @@ module Bridgetown
 
         if !Bridgetown.env.production? &&
             !config_options[:skip_frontend] && config_options["using_puma"]
+          if Bridgetown::Utils.frontend_bundler_type(config_options[:root_dir]) == :esbuild
+            Bridgetown::Utils.update_esbuild_autogenerated_config config_options
+          end
           require "rake"
           Rake.with_application do |rake|
             rake.load_rakefile

data/lib/bridgetown-core/commands/console.rb

@@ -16,7 +16,6 @@ module Bridgetown
       I18n.reload! # make sure any locale files get read again
       Bridgetown::Hooks.trigger :site, :pre_reload, site
       Bridgetown::Hooks.clear_reloadable_hooks
-      site.plugin_manager.reload_plugin_files
       site.loaders_manager.reload_loaders
       Bridgetown::Hooks.trigger :site, :post_reload, site
 

data/lib/bridgetown-core/commands/esbuild/esbuild.config.js

@@ -24,13 +24,23 @@ const outputFolder = "output"
 // You can also support custom base_path deployments via changing `publicPath`.
 //
 // ```
-// const esbuildOptions = { publicPath: "/my_subfolder/_bridgetown/static" }
+// const esbuildOptions = {
+//   publicPath: "/my_subfolder/_bridgetown/static",
+//   ...
+// }
 // ```
 
 /**
  * @typedef { import("esbuild").BuildOptions } BuildOptions
  * @type {BuildOptions}
  */
-const esbuildOptions = {}
+const esbuildOptions = {
+  plugins: [
+    // add new plugins here...
+  ],
+  globOptions: {
+    excludeFilter: /\.(dsd|lit)\.(css|js)$/
+  }
+}
 
 build(outputFolder, esbuildOptions)

data/lib/bridgetown-core/commands/esbuild/esbuild.defaults.js.erb

@@ -8,6 +8,14 @@
 //
 // Shipped with Bridgetown v<%= Bridgetown::VERSION %>
 
+// DO NOT MANUALLY EDIT THIS CONFIGURATION:
+const autogeneratedBridgetownConfig = {
+  "source": "src",
+  "destination": "output",
+  "componentsDir": "_components",
+  "islandsDir": "_islands"
+}
+
 const path = require("path")
 const fsLib = require("fs")
 const fs = fsLib.promises
@@ -41,7 +49,7 @@ if (moduleAvailable("sass")) {
 // Glob plugin derived from:
 // https://github.com/thomaschaaf/esbuild-plugin-import-glob
 // https://github.com/xiaohui-zhangxh/jsbundling-rails/commit/b15025dcc20f664b2b0eb238915991afdbc7cb58
-const importGlobPlugin = () => ({
+const importGlobPlugin = (options, bridgetownConfig) => ({
   name: "import-glob",
   setup: (build) => {
     build.onResolve({ filter: /\*/ }, async (args) => {
@@ -49,7 +57,9 @@ const importGlobPlugin = () => ({
         return; // Ignore unresolvable paths
       }
 
-      const adjustedPath = args.path.replace(/^bridgetownComponents\//, "../../src/_components/")
+      const adjustedPath = args.path
+        .replace(/^\$components\/\*\*/, `../../${bridgetownConfig.source}/${bridgetownConfig.componentsDir}/**`)
+        .replace(/^bridgetownComponents\//, `../../${bridgetownConfig.source}/${bridgetownConfig.componentsDir}/`) // legacy
 
       return {
         path: adjustedPath,
@@ -64,7 +74,11 @@ const importGlobPlugin = () => ({
     build.onLoad({ filter: /.*/, namespace: "import-glob" }, async (args) => {
       const files = glob.sync(args.pluginData.path, {
         cwd: args.pluginData.resolveDir,
-      }).sort()
+      })
+        .filter(module => options.excludeFilter ? !options.excludeFilter.test(module) : true)
+        .sort()
+        .map(module => module.replace(`../../${bridgetownConfig.source}/${bridgetownConfig.componentsDir}/`, "$components/"))
+        .map(module => module.match(/^[a-zA-Z0-9]/) ? `./${module}` : module)
 
       const importerCode = `
         ${files
@@ -72,7 +86,7 @@ const importGlobPlugin = () => ({
           .join(';')}
         const modules = {${files
           .map((module, index) => `
-            "${module.replace("../../src/_components/", "")}": module${index},`)
+            "${module.replace("$components/", "")}": module${index},`)
           .join("")}
         };
         export default modules;
@@ -187,7 +201,7 @@ const sassPlugin = (options) => ({
 })
 
 // Set up defaults and generate frontend bundling manifest file
-const bridgetownPreset = (outputFolder) => ({
+const bridgetownPreset = (bridgetownConfig) => ({
   name: "bridgetownPreset",
   async setup(build) {
     // Ensure any imports anywhere starting with `/` are left verbatim
@@ -210,8 +224,10 @@ const bridgetownPreset = (outputFolder) => ({
       const manifest = {}
       const entrypoints = []
 
-      // We don't need `frontend/` cluttering up everything
-      const stripPrefix = (str) => str.replace(/^frontend\//, "")
+      // Clean up entrypoint naming
+      const stripPrefix = (str) => str
+        .replace(/^frontend\//, "")
+        .replace(RegExp(String.raw`^${bridgetownConfig.source}\/${bridgetownConfig.islandsDir}\/`), "islands/")
 
       // For calculating the file size of bundle output
       const fileSize = (path) => {
@@ -220,11 +236,12 @@ const bridgetownPreset = (outputFolder) => ({
         return (size / Math.pow(1024, i)).toFixed(2) * 1 + ['B', 'KB', 'MB', 'GB', 'TB'][i]
       }
 
+      const pathShortener = new RegExp(String.raw`^${bridgetownConfig.destination}\/_bridgetown\/static\/`, "g")
+
       // Let's loop through all the various outputs
       for (const key in result.metafile.outputs) {
         const value = result.metafile.outputs[key]
         const inputs = Object.keys(value.inputs)
-        const pathShortener = new RegExp(`^${outputFolder}\\/_bridgetown\\/static\\/`, "g")
         const outputPath = key.replace(pathShortener, "")
 
         if (value.entryPoint) {
@@ -256,23 +273,43 @@ const bridgetownPreset = (outputFolder) => ({
   }
 })
 
+const bridgetownConfigured = (bridgetownConfig, outputFolder) => {
+  bridgetownConfig = {...autogeneratedBridgetownConfig, ...bridgetownConfig}
+  if (outputFolder) bridgetownConfig.destination = outputFolder
+
+  return bridgetownConfig
+}
+
 // Load the PostCSS config from postcss.config.js or whatever else is a supported location/format
 const postcssrc = require("postcss-load-config")
 
-module.exports = async (outputFolder, esbuildOptions) => {
+module.exports = async (esbuildOptions) => {
+  let outputFolder;
+  if (typeof esbuildOptions === "string") { // legacy syntax where first argument is output folder
+    esbuildOptions = arguments[1]
+    outputFolder = arguments[0]
+  }
+  const bridgetownConfig = bridgetownConfigured(esbuildOptions.bridgetownConfig, outputFolder)
+
   esbuildOptions.plugins = esbuildOptions.plugins || []
   // Add the PostCSS & glob plugins to the top of the plugin stack
   const postCssConfig = await postcssrc()
   esbuildOptions.plugins.unshift(importPostCssPlugin(postCssConfig, esbuildOptions.postCssPluginConfig || {}))
   if (esbuildOptions.postCssPluginConfig) delete esbuildOptions.postCssPluginConfig
-  esbuildOptions.plugins.unshift(importGlobPlugin())
+  // Add the Glob plugin
+  esbuildOptions.plugins.unshift(importGlobPlugin(esbuildOptions.globOptions || {}, bridgetownConfig))
+  if (esbuildOptions.globOptions) delete esbuildOptions.globOptions
   // Add the Sass plugin
   esbuildOptions.plugins.push(sassPlugin(esbuildOptions.sassOptions || {}))
+  if (esbuildOptions.sassOptions) delete esbuildOptions.sassOptions
   // Add the Bridgetown preset
-  esbuildOptions.plugins.push(bridgetownPreset(outputFolder))
+  esbuildOptions.plugins.push(bridgetownPreset(bridgetownConfig))
+  if (esbuildOptions.bridgetownConfig) delete esbuildOptions.bridgetownConfig
 
-  // esbuild, take it away!
-  require("esbuild").build({
+  const esbuild = require("esbuild")
+  const islands = glob.sync(`./${bridgetownConfig.source}/${bridgetownConfig.islandsDir}/*.{js,js.rb}`).map(item => `./${item}`)
+
+  esbuild.context({
     bundle: true,
     loader: {
       ".jpg": "file",
@@ -285,16 +322,25 @@ module.exports = async (outputFolder, esbuildOptions) => {
       ".eot": "file",
     },
     resolveExtensions: [".tsx", ".ts", ".jsx", ".js", ".css", ".scss", ".sass", ".json", ".js.rb"],
-    nodePaths: ["frontend/javascript", "frontend/styles"],
-    watch: process.argv.includes("--watch"),
     minify: process.argv.includes("--minify"),
     sourcemap: true,
-    target: "es2016",
-    entryPoints: ["./frontend/javascript/index.js"],
+    target: "es2020",
+    entryPoints: ["./frontend/javascript/index.js", ...islands],
     entryNames: "[dir]/[name].[hash]",
-    outdir: path.join(process.cwd(), `${outputFolder}/_bridgetown/static`),
+    outdir: path.join(process.cwd(), `${bridgetownConfig.destination}/_bridgetown/static`),
     publicPath: "/_bridgetown/static",
     metafile: true,
     ...esbuildOptions,
+  }).then(context => {
+    if (process.argv.includes("--watch")) {
+      // Enable watch mode
+      context.watch()
+    } else {
+      // Build once and exit if not in watch mode
+      context.rebuild().then(result => {
+        context.dispose()
+      })
+    }
+    process.on('SIGINT', () => process.exit())
   }).catch(() => process.exit(1))
 }

data/lib/bridgetown-core/commands/esbuild/jsconfig.json

@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "baseUrl": ".",
+    "paths": {
+        "$styles/*": ["./frontend/styles/*"],
+        "$javascript/*": ["./frontend/javascript/*"],
+        "$components/*": ["./src/_components/*"]
+    }
+  }, 
+}

data/lib/bridgetown-core/commands/esbuild/setup.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
 
 template "esbuild.defaults.js.erb", "config/esbuild.defaults.js"
+copy_file "jsconfig.json"
 copy_file "esbuild.config.js", force: true

data/lib/bridgetown-core/commands/esbuild/update.rb

@@ -1,4 +1,7 @@
 # frozen_string_literal: true
 
 template "esbuild.defaults.js.erb", "config/esbuild.defaults.js", force: true
+copy_file "jsconfig.json"
 say "🎉 esbuild configuration updated successfully!"
+say "You may need to add `$styles/` to the front of your main CSS imports."
+say "See https://www.bridgetownrb.com/docs/frontend-assets#esbuild-setup for details."

data/lib/bridgetown-core/commands/new.rb

@@ -80,6 +80,8 @@ module Bridgetown
         after_install new_site_path, args.join(" "), options
       rescue ArgumentError => e
         say_status :alert, e.message, :red
+      ensure
+        self.class.created_site_dir = nil # reset afterwards, otherwise hanging tmp dirs in test
       end
 
       protected

data/lib/bridgetown-core/configuration/configuration_dsl.rb

@@ -49,7 +49,7 @@ module Bridgetown
         priority: Bridgetown::Hooks::DEFAULT_PRIORITY,
         &block
       )
-        Bridgetown::Hooks.register_one(owner, event, priority: priority, &block)
+        Bridgetown::Hooks.register_one(owner, event, priority: priority, reloadable: false, &block)
       end
 
       def source_manifest(**kwargs)

data/lib/bridgetown-core/configuration.rb

@@ -33,8 +33,8 @@ module Bridgetown
       "collections_dir"            => "",
       "cache_dir"                  => ".bridgetown-cache",
       "layouts_dir"                => "_layouts",
-      "data_dir"                   => "_data",
       "components_dir"             => "_components",
+      "islands_dir"                => "_islands",
       "partials_dir"               => "_partials",
       "collections"                => {},
       "taxonomies"                 => {
@@ -44,7 +44,6 @@ module Bridgetown
       "eager_load_paths"           => [],
       "autoloader_collapsed_paths" => [],
       "additional_watch_paths"     => [],
-      "plugins_use_zeitwerk"       => true,
 
       # Handling Reading
       "include"                    => [".htaccess", "_redirects", ".well-known"],
@@ -335,30 +334,32 @@ module Bridgetown
         self[:source] = File.expand_path(self[:source], self[:root_dir])
         self[:destination] = File.expand_path(self[:destination], self[:root_dir])
 
-        if self[:plugins_use_zeitwerk]
-          autoload_paths.unshift({
-            path: self[:plugins_dir],
-            eager: true,
-          })
-        end
+        autoload_paths.unshift({
+          path: self[:plugins_dir],
+          eager: true,
+        })
+        autoload_paths.unshift({
+          path: File.expand_path(self[:islands_dir], self[:source]),
+          eager: true,
+        })
       end
 
       autoload_paths.map! do |load_path|
         if load_path.is_a?(Hash)
-          expanded = File.expand_path(load_path[:path], root_dir)
+          expanded = File.expand_path(load_path[:path], self[:root_dir])
           self[:eager_load_paths] << expanded if load_path[:eager]
           next expanded
         end
 
-        File.expand_path(load_path, root_dir)
+        File.expand_path(load_path, self[:root_dir])
       end
 
       autoloader_collapsed_paths.map! do |collapsed_path|
-        File.expand_path(collapsed_path, root_dir)
+        File.expand_path(collapsed_path, self[:root_dir])
       end
 
       additional_watch_paths.map! do |collapsed_path|
-        File.expand_path(collapsed_path, root_dir)
+        File.expand_path(collapsed_path, self[:root_dir])
       end
 
       self

data/lib/bridgetown-core/configurations/is-land.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+say_status "is-land", "Installing <is-land>..."
+
+run "yarn add @11ty/is-land"
+
+javascript_import do
+  <<~JS
+    import "@11ty/is-land/is-land.js"
+    import "@11ty/is-land/is-land-autoinit.js"
+  JS
+end
+
+say_status "is-land", "<is-land> is now configured!"
+say 'For further reading, check out "https://www.bridgetownrb.com/docs/islands"', :blue

data/lib/bridgetown-core/configurations/lit/lit-components-entry.js

@@ -1 +1 @@
-import components from "bridgetownComponents/**/*.{lit.js,lit.js.rb}"
+import components from "$components/**/*.{lit.js,lit.js.rb}"

data/lib/bridgetown-core/configurations/lit.rb

@@ -11,9 +11,9 @@ end
 
 say_status :lit, "Installing Lit + SSR Plugin..."
 
-add_gem "bridgetown-lit-renderer"
+add_gem "bridgetown-lit-renderer", version: "2.1.0.beta1"
 
-run "yarn add lit esbuild-plugin-lit-css bridgetown-lit-renderer"
+run "yarn add lit esbuild-plugin-lit-css bridgetown-lit-renderer@2.1.0-beta1"
 
 copy_file in_templates_dir("lit-ssr.config.js"), "config/lit-ssr.config.js"
 copy_file in_templates_dir("lit-components-entry.js"), "config/lit-components-entry.js"
@@ -27,45 +27,13 @@ insert_into_file "esbuild.config.js",
   JS
 end
 
-found_match = false
-gsub_file "esbuild.config.js", %r{const esbuildOptions = {}\n} do |_match|
-  found_match = true
-
-  <<~JS
-    const esbuildOptions = {
-      plugins: [...plugins],
-      // Uncomment the following to opt into `.global.css` & `.lit.css` nomenclature.
-      // Read https://www.bridgetownrb.com/docs/components/lit#sidecar-css-files for documentation.
-      /*
-      postCssPluginConfig: {
-        filter: /(?:index|\\.global)\\.css$/,
-      },
-      */
-    }
+insert_into_file "esbuild.config.js",
+                 after: "  plugins: [" do
+  <<-JS
+    plugins: [...plugins],
   JS
 end
 
-unless found_match
-  insert_into_file "esbuild.config.js",
-                   after: 'const { plugins } = require("./config/esbuild-plugins.js")' do
-    <<~JS
-
-      // TODO: You will manually need to move any plugins below you wish to share with
-      // Lit SSR into the `config/esbuild-plugins.js` file.
-      // Then add `...plugins` as an item in your plugins array.
-      //
-      // You might also want to include the following in your esbuild config to opt into
-      // `.global.css` & `.lit.css` nomenclature.
-      // Read https://www.bridgetownrb.com/docs/components/lit#sidecar-css-files for documentation.
-      /*
-      postCssPluginConfig: {
-        filter: /(?:index|\\.global)\\.css$/,
-      },
-      */
-    JS
-  end
-end
-
 copy_file in_templates_dir("happy-days.lit.js"), "src/_components/happy-days.lit.js"
 
 javascript_import do
@@ -74,24 +42,11 @@ javascript_import do
   JS
 end
 
-insert_into_file "frontend/javascript/index.js",
-                 before: 'import components from "bridgetownComponents/**/*.{js,jsx,js.rb,css}"' do
-  <<~JS
-    // To opt into `.global.css` & `.lit.css` nomenclature, change the `css` extension below to `global.css`.
-    // Read https://www.bridgetownrb.com/docs/components/lit#sidecar-css-files for documentation.
-  JS
-end
-
 add_initializer :"bridgetown-lit-renderer"
 
-if found_match
-  say_status :lit, "Lit is now configured!"
-  say_status :lit,
-             "The `config/esbuild-plugins.js` file will let you add full-stack plugins in future."
-else
-  say_status :lit, "Lit is just about configured!"
-  say_status :lit, "You will need to edit `esbuild.config.js` to finish setting up the plugin."
-end
+say_status :lit, "Lit is now configured!"
+say_status :lit,
+           "The `config/esbuild-plugins.js` file will let you add full-stack plugins in future."
 
 say "Check out the example `happy-days.lit.js` file in `src/_components`", :blue
 say 'For further reading, check out "https://www.bridgetownrb.com/docs/components/lit"', :blue

data/lib/bridgetown-core/configurations/purgecss.rb

@@ -31,7 +31,7 @@ create_builder "purgecss.rb" do
             manifest = JSON.parse(File.read(manifest_file))
 
             if Bridgetown::Utils.frontend_bundler_type == :esbuild
-              css_file = manifest["styles/index.css"].split("/").last
+              css_file = (manifest["styles/index.css"] || manifest["styles/index.scss"]).split("/").last
               css_path = ["output", "_bridgetown", "static", css_file].join("/")
             else
               css_file = manifest["main.css"].split("/").last

data/lib/bridgetown-core/configurations/ruby2js/ruby2js.rb

@@ -0,0 +1,10 @@
+# See docs on Ruby2JS options here: https://www.ruby2js.com/docs/options
+
+preset
+
+filter :camelCase
+filter :lit
+
+eslevel 2022
+
+autoexports :default

data/lib/bridgetown-core/configurations/ruby2js.rb

@@ -11,57 +11,29 @@ end
 
 say_status :ruby2js, "Installing Ruby2JS..."
 
+add_gem "ruby2js"
 run "yarn add -D @ruby2js/esbuild-plugin"
 
-found_match = false
-gsub_file "esbuild.config.js", %r{const esbuildOptions = {}\n} do |_match|
-  found_match = true
-
+insert_into_file "esbuild.config.js",
+                 after: 'const build = require("./config/esbuild.defaults.js")' do
   <<~JS
-    const ruby2js = require("@ruby2js/esbuild-plugin")
 
-    const esbuildOptions = {
-      plugins: [
-        // See docs on Ruby2JS options here: https://www.ruby2js.com/docs/options
-        ruby2js({
-          eslevel: 2022,
-          autoexports: "default",
-          filters: ["camelCase", "functions", "lit", "esm", "return"]
-        })
-      ]
-    }
+    const ruby2js = require("@ruby2js/esbuild-plugin")
   JS
 end
 
-unless found_match
-  insert_into_file "esbuild.config.js",
-                   after: 'const build = require("./config/esbuild.defaults.js")' do
-    <<~JS
-
-      const ruby2js = require("@ruby2js/esbuild-plugin")
-
-      // TODO: Uncomment and move the following into your plugins array:
-      //
-      //  ruby2js({
-      //    eslevel: 2022,
-      //    autoexports: "default",
-      //    filters: ["camelCase", "functions", "lit", "esm", "return"]
-      //  })
-      //
-      // See docs on Ruby2JS options here: https://www.ruby2js.com/docs/options
-
-    JS
-  end
+insert_into_file "esbuild.config.js",
+                 after: "  plugins: [" do
+  <<-JS
+    ruby2js(),
+  JS
 end
 
+copy_file in_templates_dir("ruby2js.rb"), "config/ruby2js.rb"
 copy_file in_templates_dir("hello_world.js.rb"), "src/_components/hello_world.js.rb"
 
-if found_match
-  say_status :ruby2js, "Ruby2JS is now configured!"
-else
-  say_status :ruby2js, "Ruby2JS is just about configured!"
-  say_status :ruby2js, "You will need to edit `esbuild.config.js` to finish setting up the plugin."
-end
+say_status :ruby2js, "Ruby2JS is now configured!"
 
 say "Check out the example `hello_world.js.rb` file in `src/_components`", :blue
+say "Ruby2JS configuration options are saved in `config/ruby2js.rb`", :blue
 say 'For further reading, check out "https://www.ruby2js.com"', :blue

data/lib/bridgetown-core/configurations/turbo.rb

@@ -3,6 +3,7 @@
 say_status :turbo, "Installing Turbo..."
 
 run("yarn add @hotwired/turbo")
+run("yarn add turbo-shadow")
 
 say_status :turbo, 'Adding Turbo to "frontend/javascript/index.js"...', :magenta
 
@@ -10,11 +11,17 @@ javascript_import do
   <<~JS
     import * as Turbo from "@hotwired/turbo"
 
-    // Uncomment the line below to add transition animations when Turbo navigates.
-    // We recommend adding <meta name="turbo-cache-control" content="no-preview" />
-    // to your HTML head if you turn on transitions. Use data-turbo-transition="false"
-    // on your <main> element for pages where you don't want any transition animation.
-    //
+    /**
+     * Adds support for declarative shadow DOM. Requires your HTML <head> to include:
+     * `<meta name="turbo-cache-control" content="no-cache" />`
+     */
+    import * as TurboShadow from "turbo-shadow"
+
+    /**
+     * Uncomment the line below to add transition animations when Turbo navigates.
+     * Use data-turbo-transition="false" on your <main> element for pages where
+     * you don't want any transition animation.
+     */
     // import "./turbo_transitions.js"
   JS
 end
@@ -22,5 +29,8 @@ end
 copy_file in_templates_dir("turbo_transitions.js"), "frontend/javascript/turbo_transitions.js"
 
 say_status :turbo, "Turbo successfully added!", :magenta
-say_status :turbo, "Take a look in your index.js file for optional animation setup.", :blue
-say_status :turbo, 'For further reading, check out "https://turbo.hotwired.dev/"', :blue
+say_status :turbo, "For declarative shadow DOM support, you will need to update", :blue
+say_status :turbo, "your HTML <head> to add the following code:", :blue
+say %(<meta name="turbo-cache-control" content="no-cache" />)
+say_status :turbo, "Check out your index.js file for optional animation setup.", :blue
+say_status :turbo, 'For further reading, visit "https://turbo.hotwired.dev/"', :blue