bridgetown-lit-renderer 2.1.0.beta2 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5ebf95cd7904248fbadc134cbf89053b21ad991f625ee767337219e48286367
-  data.tar.gz: 33ee760e46eb42fbc12f07c83614e86f9246c87580f48ed344a28c365ac58f85
+  metadata.gz: bd593342115c0ed9cf66b160b32765b6956c37c66abc1566760056f0ea495768
+  data.tar.gz: dfb9c7a7995b9e744dc8ab5186bc3b79dfd28924513be143cb82460b2b6aabe9
 SHA512:
-  metadata.gz: 515c90792dd3b3faad5f193ebbfa68eab4ef711962fb82582cac94efe4ec3bfd3029db95714f5d675b1df5b07b6057d467ab4ca425beae90c98cccd3e76a49fd
-  data.tar.gz: f0c6451c6eab9fd938235648af7938e9cb6ecbe017f5a281ff73839ac0a0f59a241c16d056641b7bdc514dec6f85cf5decd8e976ed904fedcb1d53d6a2bda8b8
+  metadata.gz: 97b1817825c5421610227b1b4bfbaf0b45f552ed33c60ee7323264d35f84b87ac82ea503bd538cd2ee533fca46608a2d0e12cc3e3e2ff02dfa459eb0914e23c0
+  data.tar.gz: a2c75fa91ef31d5cdf8f77f0092660d0cdfcf51680b380653033fb2a3ae28ba1defa4e02a3b4fc0ec478032b17be533708aab809224f2c8817c7ba403236b456

data/.github/workflows/ci.yml

@@ -19,13 +19,12 @@ jobs:
     - name: Set up Ruby and Yarn
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: "3.0"
+        ruby-version: "3.1"
         bundler-cache: true
     - uses: actions/setup-node@v2
       with:
-        node-version: '16'
-        cache: 'yarn'
+        node-version: '22'
     - name: Install NPM packages
-      run: yarn install
+      run: npm install
     - name: Run tests
       run: script/cibuild

data/CHANGELOG.md

@@ -7,6 +7,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [3.0.0] - 2025-09-15
+
+- Bridgetown 2.0 support
+- Convert build script to ESM
+- Update various dependencies
+- Remove DSD polyfill (it's available in all browsers now)
+
 ## [2.1.0.beta2] - 2023-06-18
 
 - Bug fixes based on QA

data/Gemfile

@@ -3,7 +3,7 @@
 source "https://rubygems.org"
 gemspec
 
-gem "bridgetown", ENV["BRIDGETOWN_VERSION"] if ENV["BRIDGETOWN_VERSION"]
+gem "bridgetown", ENV.fetch("BRIDGETOWN_VERSION", "2.0.0.beta6")
 
 group :test do
   gem "minitest"

data/README.md

@@ -9,26 +9,26 @@ This [Bridgetown](https://www.bridgetownrb.com) plugin provides you with an easy
 
 ## Documentation
 
-**[The official documentation is now available on the Bridgetown website.](https://edge.bridgetownrb.com/docs/components/lit)**
+**[The official documentation is now available on the Bridgetown website.](https://www.bridgetownrb.com/docs/components/lit)**
 
 [Check out the demo site repo.](https://github.com/bridgetownrb/lit-renderer-example)
 
 ## Installation
 
-Starting in Bridgetown v1.1, you can install this plugin via a bundled configuration:
+You should likely install this plugin via its bundled configuration:
 
 ```shell
 $ bin/bridgetown configure lit
 ```
 
-For a manual installation overview (Bridgetown 1.2+):
+However, for a manual installation overview (Bridgetown 1.2+):
 
 Run this command to add this plugin to your site's Gemfile, along with JavaScript packages for Lit and SSR support:
 
 ```shell
 $ bundle add bridgetown-lit-renderer
 
-$ yarn add lit bridgetown-lit-renderer
+$ npm i lit bridgetown-lit-renderer
 ```
 
 Then add the initializer to your configuration in `config/initializers.rb`:
@@ -37,13 +37,11 @@ Then add the initializer to your configuration in `config/initializers.rb`:
 init :"bridgetown-lit-renderer"
 ```
 
-(For Bridgetown 1.1 or earlier, [read these instructions](https://github.com/bridgetownrb/bridgetown-lit-renderer/tree/v2.0.0.beta3).)
-
 Create a file in `config/lit-ssr.config.js` with the following:
 
 ```js
-const build = require("bridgetown-lit-renderer/build")
-const { plugins } = require("./esbuild-plugins.js")
+import build from "../../../src/build.mjs"
+import { plugins } from "./esbuild-plugins.js"
 
 const esbuildOptions = { plugins }
 
@@ -54,16 +52,14 @@ and `config/esbuild-plugins.js`:
 
 ```js
 // You can add esbuild plugins here you wish to share between the frontend bundles and Lit SSR:
-module.exports = {
-  plugins: []
-}
+export const plugins = []
 ```
 
 and if you're using esbuild for your Bridgetown site, modify `esbuild.config.js``:
 
 ```js
 // at the top of your file:
-const { plugins } = require("./config/esbuild-plugins.js")
+import { plugins } from "./config/esbuild-plugins.js"
 
 const esbuildOptions = {
   // other options
@@ -126,7 +122,7 @@ you should be doing this:
 <% end %>
 ```
 
-**Disabling hydration?** If for some reason you can't permit a `hydrate-root` element to wrap a Lit code block, you can pass a `hydrate_root: false` argument to the `lit` helper. This breaks hydration however, and likewise the [Declarative Shadow DOM (DSD)](https://web.dev/declarative-shadow-dom/) polyfill won't be loaded. (Currently DSD is only supported natively in Chromium-based browsers such as Chrome, Edge, and Brave.) It will thus be up to you to manage those features as you see fit.
+**Disabling hydration?** If for some reason you can't permit a `hydrate-root` element to wrap a Lit code block, you can pass a `hydrate_root: false` argument to the `lit` helper. This breaks hydration however, and likewise the [Declarative Shadow DOM (DSD)](https://web.dev/declarative-shadow-dom/) polyfill won't be loaded. It will thus be up to you to manage those features as you see fit.
 
 ## Testing
 

data/bridgetown-lit-renderer.gemspec

@@ -16,12 +16,12 @@ Gem::Specification.new do |spec|
   end
   spec.test_files    = spec.files.grep(%r!^test/!)
   spec.require_paths = ["lib"]
-  spec.metadata      = { "yarn-add"              => "bridgetown-lit-renderer@#{BridgetownLitRenderer::VERSION.sub(".beta", "-beta")}",
+  spec.metadata      = { "npm_add"              => "bridgetown-lit-renderer@#{BridgetownLitRenderer::VERSION.sub(".beta", "-beta")}",
                          "rubygems_mfa_required" => "true", }
 
-  spec.required_ruby_version = ">= 2.7.0"
+  spec.required_ruby_version = ">= 3.1"
 
-  spec.add_dependency "bridgetown", ">= 1.3.0.beta2", "< 2.0"
+  spec.add_dependency "bridgetown", ">= 2.0.0.beta6"
   spec.add_dependency "random-port", ">= 0.5"
 
   spec.add_development_dependency "bundler"

data/lib/bridgetown-lit-renderer/builder.rb

@@ -21,7 +21,7 @@ module BridgetownLitRenderer
       process_tag = ->(tag, attributes, code) do
         valid_tag = tag.to_s.tr("_", "-")
         segments = ["<#{valid_tag}"]
-        attributes.each do |attr, _|
+        attributes.each_key do |attr|
           attr = attr.to_s.tr("_", "-")
           segments << %( #{attr}="${data.#{attr}}")
         end

data/lib/bridgetown-lit-renderer/renderer.rb

@@ -95,11 +95,13 @@ module BridgetownLitRenderer
       output = call_http_server("const data = #{data.to_json}; #{built_code}")
 
       if output == "SCRIPT NOT VALID!"
+        # rubocop:disable Bridgetown/InsecureHeredoc
         output = <<~HTML
           <ssr-error style="display:block; padding:0.3em 0.5em; color:white; background:maroon; font-weight:bold">
             Lit SSR error in #{entry}, see logs
           </ssr-error>
         HTML
+        # rubocop:enable Bridgetown/InsecureHeredoc
         cache.delete(cache_key)
       end
 

data/lib/bridgetown-lit-renderer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BridgetownLitRenderer
-  VERSION = "2.1.0.beta2"
+  VERSION = "3.0.0"
 end