bridgetown-core 2.0.0.beta2 → 2.0.0.beta4

data/lib/bridgetown-core/utils.rb

@@ -49,15 +49,12 @@ module Bridgetown
       deep_merge_hashes!(master_hash.dup, other_hash)
     end
 
-    # Merges a master hash with another hash, recursively.
+    # Merges a master hash with another hash, recursively. This code was lovingly stolen from
+    # some random gem: https://rubygems.org/gems/tartan Thanks to whoever made it.
     #
-    # master_hash - the "parent" hash whose values will be overridden
-    # other_hash  - the other hash whose values will be persisted after the merge
-    #
-    # This code was lovingly stolen from some random gem:
-    # http://gemjack.com/gems/tartan-0.1.1/classes/Hash.html
-    #
-    # Thanks to whoever made it.
+    # @param target [Hash] the "parent" hash whose values will be overridden
+    # @param overwrite [Hash] the other hash whose values will be persisted after the merge
+    # @return [Hash]
     def deep_merge_hashes!(target, overwrite)
       merge_values(target, overwrite)
       merge_default_proc(target, overwrite)
@@ -110,11 +107,9 @@ module Bridgetown
 
     # Parse a date/time and throw an error if invalid
     #
-    # input - the date/time to parse
-    # msg - (optional) the error message to show the user
-    #
-    # Returns the parsed date if successful, throws a FatalException
-    # if not
+    # @param input [String] the date/time to parse
+    # @param msg [String] the error message to show the user
+    # @return [Time] the parsed date if successful, throws a FatalException if not
     def parse_date(input, msg = "Input could not be parsed.")
       Time.parse(input).localtime
     rescue ArgumentError
@@ -140,35 +135,30 @@ module Bridgetown
       FrontMatter::Loaders::Ruby.header?(file)
     end
 
-    # Slugify a filename or title.
+    # Slugify a filename or title
     #
-    # string - the filename or title to slugify
-    # mode - how string is slugified
-    # cased - whether to replace all uppercase letters with their
-    # lowercase counterparts
+    # When mode is `none`, return the given string.
     #
-    # When mode is "none", return the given string.
-    #
-    # When mode is "raw", return the given string,
+    # When mode is `raw`, return the given string,
     # with every sequence of spaces characters replaced with a hyphen.
     #
-    # When mode is "default", "simple", or nil, non-alphabetic characters are
+    # When mode is `default`, `simple`, or `nil`, non-alphabetic characters are
     # replaced with a hyphen too.
     #
-    # When mode is "pretty", some non-alphabetic characters (._~!$&'()+,;=@)
+    # When mode is `pretty`, some non-alphabetic characters (`._~!$&'()+,;=@`)
     # are not replaced with hyphen.
     #
-    # When mode is "ascii", some everything else except ASCII characters
-    # a-z (lowercase), A-Z (uppercase) and 0-9 (numbers) are not replaced with hyphen.
+    # When mode is `ascii`, some everything else except ASCII characters
+    # `a-z` (lowercase), `A-Z` (uppercase) and `0-9` (numbers) are not replaced with hyphen.
     #
-    # When mode is "latin", the input string is first preprocessed so that
+    # When mode is `latin`, the input string is first preprocessed so that
     # any letters with accents are replaced with the plain letter. Afterwards,
-    # it follows the "default" mode of operation.
+    # it follows the `default` mode of operation.
     #
-    # If cased is true, all uppercase letters in the result string are
+    # If `cased` is `true`, all uppercase letters in the result string are
     # replaced with their lowercase counterparts.
     #
-    # Examples:
+    # @example
     #   slugify("The _config.yml file")
     #   # => "the-config-yml-file"
     #
@@ -184,7 +174,11 @@ module Bridgetown
     #   slugify("The _config.yml file", "latin")
     #   # => "the-config-yml-file"
     #
-    # Returns the slugified string.
+    # @param string [String] filename or title to slugify
+    # @param mode [String] how string is slugified
+    # @param cased [Boolean] whether to replace all uppercase letters with their
+    #   lowercase counterparts
+    # @return [String] the slugified string.
     def slugify(string, mode: nil, cased: false)
       mode ||= "default"
       return nil if string.nil?
@@ -210,13 +204,13 @@ module Bridgetown
     end
 
     # Work the same way as Dir.glob but seperating the input into two parts
-    # ('dir' + '/' + 'pattern') to make sure the first part('dir') does not act
+    # (`'dir' + '/' + 'pattern'`) to make sure the first part(`'dir'`) does not act
     # as a pattern.
     #
-    # For example, Dir.glob("path[/*") always returns an empty array,
-    # because the method fails to find the closing pattern to '[' which is ']'
+    # For example, `Dir.glob("path[/*")` always returns an empty array,
+    # because the method fails to find the closing pattern to `[` which is `]`
     #
-    # Examples:
+    # @example
     #   safe_glob("path[", "*")
     #   # => ["path[/file1", "path[/file2"]
     #
@@ -226,12 +220,13 @@ module Bridgetown
     #   safe_glob("path", ["**", "*"])
     #   # => ["path[/file1", "path[/folder/file2"]
     #
-    # dir      - the dir where glob will be executed under
-    #           (the dir will be included to each result)
-    # patterns - the patterns (or the pattern) which will be applied under the dir
-    # flags    - the flags which will be applied to the pattern
-    #
-    # Returns matched pathes
+    # @param dir [String] the dir where glob will be executed under
+    #   (the dir will be included to each result)
+    # @param patterns [String, Array<String>] the patterns (or the pattern) which will be applied
+    #   under the dir
+    # @param flags [Integer] the flags which will be applied to the pattern,
+    #   a bitwise OR of the `File::FNM_XXX` constants
+    # @return [Array<String>] matched pathes
     def safe_glob(dir, patterns, flags = 0)
       return [] unless Dir.exist?(dir)
 
@@ -243,8 +238,8 @@ module Bridgetown
       end
     end
 
-    # Returns merged option hash for File.read of self.site (if exists)
-    # and a given param
+    # @return [Hash] merged option hash for `File.read` of `site` (if exists)
+    #   and a given param
     def merged_file_read_opts(site, opts)
       merged = (site ? site.file_read_opts : {}).merge(opts)
       if merged[:encoding] && !merged[:encoding].start_with?("bom|")
@@ -256,8 +251,10 @@ module Bridgetown
       merged
     end
 
-    # Returns a string that's been reindented so that Markdown's four+ spaces =
-    # code doesn't get triggered for nested Liquid components
+    # Provides a string that's been reindented so that Markdown's four+ spaces =
+    #   code doesn't get triggered for nested components
+    # @param input [String]
+    # @return [String]
     # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/PerceivedComplexity
     def reindent_for_markdown(input)
       lines = input.lines

data/lib/bridgetown-core/watcher.rb

@@ -159,9 +159,8 @@ module Bridgetown
 
     # Paths to ignore for the watch option
     #
-    # options - A Hash of options passed to the command
-    #
-    # Returns a list of relative paths from source that should be ignored
+    # @param options [Bridgetown::Configuration] options loaded from config and/or CLI
+    # @return [Array<String>] list of relative paths from source that should be ignored
     def listen_ignore_paths(options)
       source = Pathname.new(options["source"]).expand_path
       paths  = to_exclude(options)

data/lib/bridgetown-core.rb

@@ -35,7 +35,7 @@ require "yaml"
 require "bridgetown-foundation"
 
 # 3rd party
-require "active_support" # TODO: remove by the end of 2024
+require "active_support" # TODO: remove by the end of 2025
 require "active_support/core_ext/object/blank"
 require "active_support/core_ext/string/inflections"
 require "active_support/core_ext/string/output_safety"
@@ -54,8 +54,9 @@ I18n::Backend::Simple.include I18n::Backend::Fallbacks
 
 # Monkey patches:
 
+# @!visibility private
 module HashWithDotAccess
-  class Hash # :nodoc:
+  class Hash
     def to_liquid
       to_h.to_liquid
     end
@@ -76,7 +77,6 @@ module Bridgetown
   autoload :DefaultsReader,      "bridgetown-core/readers/defaults_reader"
   autoload :Deprecator,          "bridgetown-core/deprecator"
   autoload :EntryFilter,         "bridgetown-core/entry_filter"
-  # TODO: we have too many errors! This is silly
   autoload :Errors,              "bridgetown-core/errors"
   autoload :FrontMatter,         "bridgetown-core/front_matter"
   autoload :GeneratedPage,       "bridgetown-core/generated_page"
@@ -100,6 +100,7 @@ module Bridgetown
   autoload :Slot,                "bridgetown-core/slot"
   autoload :StaticFile,          "bridgetown-core/static_file"
   autoload :Transformable,       "bridgetown-core/concerns/transformable"
+  autoload :Viewable,            "bridgetown-core/concerns/viewable"
   autoload :Utils,               "bridgetown-core/utils"
   autoload :VERSION,             "bridgetown-core/version"
   autoload :Watcher,             "bridgetown-core/watcher"
@@ -132,10 +133,16 @@ module Bridgetown
 
     # Set up the Bridgetown execution environment before attempting to load any
     # plugins or gems prior to a site build
-    def begin!
+    def begin!(with_config: :preflight)
       ENV["RACK_ENV"] ||= environment
 
-      Bridgetown::Current.preloaded_configuration = Bridgetown::Configuration::Preflight.new
+      if with_config == :preflight
+        Bridgetown::Current.preloaded_configuration ||= Bridgetown::Configuration::Preflight.new
+      elsif with_config == :initializers &&
+          !Bridgetown::Current.preloaded_configuration.is_a?(Bridgetown::Configuration)
+        Bridgetown::Current.preloaded_configuration = Bridgetown.configuration
+      end
+
       Bridgetown::PluginManager.setup_bundler
     end
 
@@ -366,11 +373,23 @@ module Bridgetown
     #
     # @return [String] the path to the cached errors file
     def build_errors_path
-      File.join(
-        (Bridgetown::Current.site&.config || Bridgetown::Current.preloaded_configuration).root_dir,
-        ".bridgetown-cache",
-        "build_errors.txt"
-      )
+      site_config = Bridgetown::Current.site&.config || Bridgetown::Current.preloaded_configuration
+      File.join(site_config.root_dir, site_config.cache_dir, "build_errors.txt")
+    end
+
+    # This file gets touched each time there's a new build, which then triggers live reload
+    # in the browser.
+    #
+    # @see Bridgetown::Rack::Routes.setup_live_reload
+    # @return [String] the path to the empty file being watched
+    def live_reload_path
+      site_config = Bridgetown::Current.site&.config || Bridgetown::Current.preloaded_configuration
+      File.join(site_config.root_dir, site_config.cache_dir, "live_reload.txt")
+    end
+
+    def touch_live_reload_file(path = live_reload_path)
+      FileUtils.mkdir_p File.dirname(path)
+      FileUtils.touch path
     end
   end
 

data/lib/roda/plugins/bridgetown_server.rb

@@ -13,20 +13,15 @@ class Roda
 
         app.extend ClassMethods # we need to do this here because Roda hasn't done it yet
         app.plugin :initializers
-        app.plugin :method_override
-        app.plugin :all_verbs
-        app.plugin :hooks
         app.plugin :common_logger, Bridgetown::Rack::Logger.new($stdout), method: :info
         app.plugin :json
         app.plugin :json_parser
-        app.plugin :indifferent_params
-        app.plugin :cookies, path: "/"
         app.plugin :ssg, root: Bridgetown::Current.preloaded_configuration.destination
         app.plugin :not_found do
           output_folder = Bridgetown::Current.preloaded_configuration.destination
           File.read(File.join(output_folder, "404.html"))
         rescue Errno::ENOENT
-          "404 Not Found"
+          "<h1>404 Not Found</h1>"
         end
         app.plugin :exception_page
         app.plugin :error_handler do |e|
@@ -35,10 +30,10 @@ class Roda
           )
           next exception_page(e) if ENV.fetch("RACK_ENV", nil) == "development"
 
-          output_folder = Bridgetown::Current.preloaded_configuration.destination
+          output_folder = self.class.opts[:bridgetown_preloaded_config].destination
           File.read(File.join(output_folder, "500.html"))
         rescue Errno::ENOENT
-          "500 Internal Server Error"
+          "<h1>500 Internal Server Error</h1>"
         end
 
         # TODO: there may be a better way to do this, see `exception_page_css` instance method
@@ -123,9 +118,12 @@ class Roda
             hook_result = instance_exec(&self.class.opts[:root_hook]) if self.class.opts[:root_hook]
             next hook_result if hook_result
 
-            status, headers, body = self.class.opts[:ssg_server].serving(
-              request, File.join(self.class.opts[:ssg_root], "index.html")
-            )
+            root_file = [
+              File.join(self.class.opts[:ssg_root], "index.html"),
+              File.expand_path("generic_index.html", __dir__),
+            ].find { File.exist?(_1) }
+
+            status, headers, body = self.class.opts[:ssg_server].serving(request, root_file)
             response_headers = response.headers
             response_headers.replace(headers)
 
@@ -133,7 +131,7 @@ class Roda
           rescue StandardError => e
             Bridgetown.logger.debug("Root handler error: #{e.message}")
             response.status = 500
-            "<p>ERROR: cannot find <code>index.html</code> in the output folder.</p>"
+            "<p>ERROR: cannot serve the root <code>index</code> file.</p>"
           end
         end
 
@@ -158,21 +156,11 @@ class Roda
           scope.initialize_bridgetown_context
           scope.initialize_bridgetown_root
 
-          # Run the static file server
-          ssg
-
-          # There are two different code paths depending on if there's a site `base_path` configured
-          if Bridgetown::Current.preloaded_configuration.base_path == "/"
+          base_path = Bridgetown::Current.preloaded_configuration.base_path.delete_prefix("/")
+          on(base_path.empty? ? true : base_path) do
+            ssg # static file server
             Bridgetown::Rack::Routes.load_all scope
-            return
           end
-
-          # Support custom base_path configurations
-          on(Bridgetown::Current.preloaded_configuration.base_path.delete_prefix("/")) do
-            Bridgetown::Rack::Routes.load_all scope
-          end
-
-          nil
         end
       end
     end

data/lib/roda/plugins/bridgetown_ssr.rb

@@ -13,13 +13,31 @@ class Roda
         alias_method :site, :bridgetown_site
       end
 
-      def self.load_dependencies(app)
-        app.plugin :custom_block_results
+      def self.load_dependencies(app, opts = { sessions: false })
+        app.plugin :all_verbs
+        app.plugin :cookies, path: "/"
+        app.plugin :indifferent_params
+        app.plugin :method_override
+        app.plugin :route_csrf
 
         # This lets us return callable objects directly in Roda response blocks
+        app.plugin :custom_block_results
         app.handle_block_result(Bridgetown::RodaCallable) do |callable|
-          callable.(self)
+          request.send :block_result_body, callable.(self)
+        end
+
+        return unless opts[:sessions]
+
+        secret_key = ENV.fetch("RODA_SECRET_KEY", nil)
+        unless secret_key
+          raise Bridgetown::Errors::InvalidConfigurationError,
+                "The Roda sessions plugin can't find a valid secret. Run " \
+                "`bin/bridgetown secret' and put the key in your ENV as the " \
+                "RODA_SECRET_KEY variable"
         end
+
+        app.plugin :sessions, secret: secret_key
+        app.plugin :flashier
       end
 
       def self.configure(app, _opts = {}, &)

data/lib/roda/plugins/flashier.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+class Roda
+  module RodaPlugins
+    module Flashier
+      module FlashHashAdditions
+        def info
+          self["info"]
+        end
+
+        def info=(val)
+          self["info"] = val
+        end
+
+        def alert
+          self["alert"]
+        end
+
+        def alert=(val)
+          self["alert"] = val
+        end
+      end
+
+      module FlashHashIndifferent
+        def []=(key, val)
+          @next[key.to_s] = val
+        end
+      end
+
+      module FlashNowHashIndifferent
+        def []=(key, val)
+          super(key.to_s, val)
+        end
+
+        def [](key)
+          super(key.to_s)
+        end
+      end
+
+      def self.load_dependencies(app)
+        require "roda/plugins/flash"
+
+        Roda::RodaPlugins::Flash::FlashHash.include FlashHashAdditions, FlashHashIndifferent
+        Roda::RodaPlugins::Flash::FlashHash.class_eval do
+          def initialize(hash = {})
+            super(hash || {})
+            now.singleton_class.include FlashHashAdditions, FlashNowHashIndifferent
+            @next = {}
+          end
+        end
+        app.plugin :flash
+      end
+    end
+
+    register_plugin :flashier, Flashier
+  end
+end

data/lib/roda/plugins/generic_index.html

@@ -0,0 +1,127 @@
+<!doctype html>
+<html>
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Bridgetown has loaded</title>
+    <style>
+      html {
+        font-family: system-ui, -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Oxygen, Ubuntu, Cantarell, 'Open Sans', 'Helvetica Neue', sans-serif;
+      }
+      a:link, a:visited {
+        color: rgb(30,40,38);
+      }
+      header {
+        margin-block: 2rem;
+      }
+      main {
+        margin-block: 2rem;
+        margin-inline: auto;
+        max-inline-size: 70ch;
+      }
+    </style>
+  </head>
+  <body>
+    <header style="text-align: center">
+      <svg aria-label="Bridgetown" width="300" viewBox="0 0 1863 572" version="1.1" xmlns="http://www.w3.org/2000/svg" style="display: inline-block; fill-rule:evenodd;clip-rule:evenodd;stroke-linejoin:round;stroke-miterlimit:2;">
+        <g transform="matrix(1,0,0,1,-1520.67,-710.833)">
+            <g transform="matrix(4.16667,0,0,4.16667,0,0)">
+                <g transform="matrix(1,0,0,1,374.543,268.081)">
+                    <path d="M0,13.784C1.387,13.784 2.283,12.968 2.283,11.664C2.283,10.48 1.387,9.502 0,9.502L-3.629,9.502L-3.629,13.784L0,13.784ZM-0.775,4.404C0.611,4.404 1.591,3.466 1.591,2.12C1.591,0.856 0.611,-0.122 -0.775,-0.122L-3.629,-0.122L-3.629,4.404L-0.775,4.404ZM-9.583,-5.342L0.286,-5.342C4.363,-5.342 7.626,-2.324 7.626,1.508C7.626,3.792 6.687,5.22 4.975,6.524L4.975,6.606C7.504,8.4 8.563,10.114 8.563,12.642C8.563,16.026 5.873,19.126 1.224,19.126L-9.583,19.126L-9.583,-5.342Z" style="fill:rgb(30,40,38);fill-rule:nonzero;"/>
+                </g>
+            </g>
+            <g transform="matrix(4.16667,0,0,4.16667,0,0)">
+                <g transform="matrix(1,0,0,1,404.955,276.605)">
+                    <path d="M0,-3.264C1.345,-3.264 2.242,-4.65 2.242,-6.078C2.242,-7.504 1.182,-8.77 -0.165,-8.77L-4.813,-8.77L-4.813,-3.264L0,-3.264ZM-10.808,-13.866L-0.571,-13.866C4.688,-13.866 8.114,-10.686 8.114,-6.078C8.114,-1.796 5.954,0.61 2.323,1.508L8.931,10.602L1.427,10.602L-4.813,1.468L-4.813,10.602L-10.808,10.602L-10.808,-13.866Z" style="fill:rgb(30,40,38);fill-rule:nonzero;"/>
+                </g>
+            </g>
+            <g transform="matrix(4.16667,0,0,4.16667,0,0)">
+                <g transform="matrix(1,0,0,1,0,76.979)">
+                    <rect x="424.149" y="185.76" width="5.995" height="24.468" style="fill:rgb(30,40,38);"/>
+                </g>
+            </g>
+            <g transform="matrix(4.16667,0,0,4.16667,0,0)">
+                <g transform="matrix(1,0,0,1,450.609,268.203)">
+                    <path d="M0,13.54C3.834,13.54 6.77,10.848 6.77,6.728C6.77,2.936 4.201,-0.04 0,-0.04L-2.406,-0.04L-2.406,13.54L0,13.54ZM-8.401,-5.464L0.123,-5.464C7.341,-5.464 12.928,-0.164 12.928,6.728C12.928,13.254 7.953,19.004 0.123,19.004L-8.401,19.004L-8.401,-5.464Z" style="fill:rgb(30,40,38);fill-rule:nonzero;"/>
+                </g>
+            </g>
+            <g transform="matrix(4.16667,0,0,4.16667,0,0)">
+                <g transform="matrix(1,0,0,1,485.832,288.024)">
+                    <path d="M0,-26.101C4.527,-26.101 7.667,-24.429 10.236,-21.819L6.076,-17.985C4.404,-19.495 2.325,-20.433 0,-20.433C-4.364,-20.433 -7.177,-17.171 -7.177,-13.051C-7.177,-8.525 -3.956,-5.668 0.122,-5.668C4.404,-5.668 6.484,-8.035 6.646,-10.401L-0.326,-10.401L-0.326,-15.579L13.132,-15.579L13.132,-13.255C13.132,-6.037 8.89,0 0,0C-7.748,0 -13.254,-5.75 -13.254,-13.051C-13.254,-20.351 -7.748,-26.101 0,-26.101" style="fill:rgb(30,40,38);fill-rule:nonzero;"/>
+                </g>
+            </g>
+            <g transform="matrix(4.16667,0,0,4.16667,0,0)">
+                <g transform="matrix(1,0,0,1,507.961,287.207)">
+                    <path d="M0,-24.468L16.191,-24.468L16.191,-19.168L5.995,-19.168L5.995,-14.762L15.417,-14.762L15.417,-9.542L5.995,-9.542L5.995,-5.138L16.64,-5.138L16.64,0L0,0L0,-24.468Z" style="fill:rgb(30,40,38);fill-rule:nonzero;"/>
+                </g>
+            </g>
+            <g transform="matrix(4.16667,0,0,4.16667,0,0)">
+                <g transform="matrix(1,0,0,1,539.963,281.907)">
+                    <path d="M0,-13.868L-5.464,-13.868L-5.464,-19.168L11.583,-19.168L11.583,-13.868L6.036,-13.868L6.036,5.3L0,5.3L0,-13.868Z" style="fill:rgb(30,40,38);fill-rule:nonzero;"/>
+                </g>
+            </g>
+            <g transform="matrix(4.16667,0,0,4.16667,0,0)">
+                <g transform="matrix(1,0,0,1,574.253,267.591)">
+                    <path d="M0,14.765C4.322,14.765 7.095,11.5 7.095,7.383C7.095,3.263 4.322,0 0,0C-4.364,0 -7.096,3.263 -7.096,7.383C-7.096,11.5 -4.364,14.765 0,14.765M0,-5.668C7.707,-5.668 13.172,0.082 13.172,7.383C13.172,14.683 7.707,20.433 0,20.433C-7.749,20.433 -13.173,14.683 -13.173,7.383C-13.173,0.082 -7.749,-5.668 0,-5.668" style="fill:rgb(30,40,38);fill-rule:nonzero;"/>
+                </g>
+            </g>
+            <g transform="matrix(4.16667,0,0,4.16667,0,0)">
+                <g transform="matrix(1,0,0,1,595.415,288.023)">
+                    <path d="M0,-25.284L6.28,-25.284L11.216,-13.744L14.192,-21.41L15.683,-25.284L18.842,-25.284L20.489,-21.412L23.735,-13.784L28.221,-25.284L34.461,-25.284L24.266,0L23.449,0L17.413,-14.11L11.583,0L10.808,0L0,-25.284Z" style="fill:rgb(30,40,38);fill-rule:nonzero;"/>
+                </g>
+            </g>
+            <g transform="matrix(4.16667,0,0,4.16667,0,0)">
+                <g transform="matrix(1,0,0,1,639.899,287.207)">
+                    <path d="M0,-24.468L6.322,-24.468L15.825,-9.95L15.825,-24.468L21.779,-24.468L21.779,0L15.539,0L5.995,-14.558L5.995,0L0,0L0,-24.468Z" style="fill:rgb(30,40,38);fill-rule:nonzero;"/>
+                </g>
+            </g>
+            <g transform="matrix(4.16667,0,0,4.16667,0,0)">
+                <g transform="matrix(1,0,0,1,724.324,209.37)">
+                    <path d="M0,29.41C-72.335,-66.167 -179.131,-55.549 -222.588,25.781C-227.373,34.738 -221.818,40.631 -219.109,39.985C-214.298,38.838 -197.926,32.314 -192.966,30.318C-190.894,29.485 -189.207,25.502 -187.375,21.877C-150.071,-51.956 -100.392,-60.124 -29.16,95.577C-32.607,77.837 -25.455,57.889 -2.274,37.237C0.394,34.86 2.589,32.831 0,29.41" style="fill:rgb(58,109,98);fill-rule:nonzero;"/>
+                </g>
+            </g>
+            <g transform="matrix(4.16667,0,0,4.16667,0,0)">
+                <g transform="matrix(0.249711,-0.96832,-0.96832,-0.249711,486.176,197.302)">
+                    <path d="M-12.21,-30.272C-28.365,-22.83 -44.336,-18.635 -46.819,-29.09C-48.223,-18.969 -9.68,-0.335 -12.21,21.62C-12.329,22.654 -10.713,22.914 -10.274,21.97C-1.487,3.05 -6.95,-23.042 -12.21,-30.272" style="fill:rgb(58,109,98);fill-rule:nonzero;"/>
+                </g>
+            </g>
+            <g transform="matrix(4.16667,0,0,4.16667,0,0)">
+                <g transform="matrix(1,0,0,1,810.402,309.68)">
+                    <path d="M0,-88.196C1.54,-88.196 2.104,-85.899 0.603,-85.55C-30.253,-78.37 -43.813,-48.307 -44.559,-31.561C-44.807,-26.006 -49.573,-25.025 -55.084,-22.473C-61.232,-19.625 -90.024,-7.312 -100.946,-3.404C-106.293,-1.49 -114.206,0.003 -114.576,-8.251C-116.052,-41.137 -81.521,-88.199 0,-88.196" style="fill:rgb(58,109,98);fill-rule:nonzero;"/>
+                </g>
+            </g>
+            <g transform="matrix(4.16667,0,0,4.16667,0,0)">
+                <g transform="matrix(-126.776,-126.776,-126.776,126.776,684.306,302.422)">
+                    <path d="M0.982,0.451C0.969,0.497 0.927,0.51 0.915,0.489C0.908,0.475 0.904,0.461 0.922,0.407C1.064,-0.03 0.945,-0.409 -0,-0.064C0.038,-0.102 0.068,-0.161 0.081,-0.234C0.45,-0.351 0.717,-0.297 0.868,-0.146C1.006,-0.008 1.047,0.21 0.982,0.451Z" style="fill:url(#_Linear1);fill-rule:nonzero;"/>
+                </g>
+            </g>
+            <g transform="matrix(4.16667,0,0,4.16667,0,0)">
+                <g transform="matrix(0,-49.0052,-49.0052,0,756.207,273.884)">
+                    <path d="M1,-0.813C0.989,-0.345 0.777,0.495 0.044,0.821C0.016,0.833 -0.014,0.798 0.007,0.775C0.271,0.479 0.447,0.027 0.429,-0.27C0.429,-0.28 0.427,-0.288 0.436,-0.292C0.61,-0.373 0.828,-0.554 0.969,-0.821C0.977,-0.837 1,-0.831 1,-0.814L1,-0.813Z" style="fill:url(#_Linear2);fill-rule:nonzero;"/>
+                </g>
+            </g>
+            <g transform="matrix(4.16667,0,0,4.16667,0,0)">
+                <g transform="matrix(30.5248,-8.50108,-8.50108,-30.5248,478.044,231.713)">
+                    <path d="M0.489,-0.516C0.521,-0.344 0.815,-0.062 1.05,0.111C0.884,0.153 0.635,0.169 0.489,0.081C0.474,0.152 0.308,0.424 0.152,0.616C0.317,0.306 0.438,-0.424 0.489,-0.516Z" style="fill:url(#_Linear3);fill-rule:nonzero;"/>
+                </g>
+            </g>
+        </g>
+        <defs>
+            <linearGradient id="_Linear1" x1="0" y1="0" x2="1" y2="0" gradientUnits="userSpaceOnUse" gradientTransform="matrix(1,0,0,-1,0,0.100447)"><stop offset="0" style="stop-color:rgb(58,109,98);stop-opacity:1"/><stop offset="0.95" style="stop-color:rgb(44,73,73);stop-opacity:1"/><stop offset="1" style="stop-color:rgb(44,73,73);stop-opacity:1"/></linearGradient>
+            <linearGradient id="_Linear2" x1="0" y1="0" x2="1" y2="0" gradientUnits="userSpaceOnUse" gradientTransform="matrix(1,0,0,-1,0,-0.00347458)"><stop offset="0" style="stop-color:rgb(58,109,98);stop-opacity:1"/><stop offset="0.95" style="stop-color:rgb(44,73,73);stop-opacity:1"/><stop offset="1" style="stop-color:rgb(44,73,73);stop-opacity:1"/></linearGradient>
+            <linearGradient id="_Linear3" x1="0" y1="0" x2="1" y2="0" gradientUnits="userSpaceOnUse" gradientTransform="matrix(-0.268287,-0.963339,-0.963339,0.268287,0.634136,0.481664)"><stop offset="0" style="stop-color:rgb(58,109,98);stop-opacity:1"/><stop offset="0.95" style="stop-color:rgb(44,73,73);stop-opacity:1"/><stop offset="1" style="stop-color:rgb(44,73,73);stop-opacity:1"/></linearGradient>
+        </defs>
+    </svg>
+    <h1>The server has booted successfully.</h1>
+    </header>
+
+    <main>
+      <p>However, it seems like the <code>index</code> file is missing from your source folder.</p>
+
+      <p>If you add a file like <code>index.erb</code> or <code>index.md</code> to your source folder,
+      you'll be able to see that instead of this generic message.</p>
+
+      <p>Still stuck? <a href="https://www.bridgetownrb.com/community">Our developer community may be able to lend you a hand</a>. Good luck!</p>
+    </main>
+  </body>
+</html>

data/lib/roda/plugins/ssg.rb

@@ -5,7 +5,7 @@ require "rack/files"
 
 class Roda
   module RodaPlugins
-    # This is a simplifed and modified variant of Roda's Public core plugin. It adds additional
+    # This is a simplified and modified variant of Roda's Public core plugin. It adds additional
     # functionality so that you can host an entire static site through Roda. What's necessary for
     # this to work is handling "pretty" URLs, aka:
     #
@@ -29,6 +29,7 @@ class Roda
           path = PARSER.unescape(real_remaining_path)
           return if path.include?("\0")
 
+          # @type [Rack::Files]
           server = roda_class.opts[:ssg_server]
           path = File.join(server.root, *segments_for_path(path))
 
@@ -40,7 +41,7 @@ class Roda
           halt [status, response_headers, body]
         end
 
-        # TODO: this could be refactored a bit
+        # TODO: this could be refactored a bit for clarity
         def segments_for_path(path) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
           segments = []
 

data/lib/site_template/config/initializers.rb

@@ -68,6 +68,8 @@ Bridgetown.configure do |config|
   #
   # init :ssr
   #
+  # Add `sessions: true` if you need to use session data, flash, etc.
+  #
 
   # Uncomment to use file-based dynamic template routing via Roda (make sure you
   # uncomment the gem dependency in your `Gemfile` as well):

data/lib/site_template/package.json.erb

@@ -1,6 +1,7 @@
 {
   "name": "<%= @site_name %>",
   "version": "1.0.0",
+  "type": "module",
   "private": true,
   "scripts": {
     "esbuild": "node esbuild.config.js --minify",

data/lib/site_template/postcss.config.js.erb

@@ -1,4 +1,4 @@
-module.exports = {
+export default {
   plugins: {
     'postcss-flexbugs-fixes': {},
     'postcss-preset-env': {