bridgetown-core 2.0.0.beta2 → 2.0.0.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad323d78c36221049d27482e186a24793c5e52b478e913b778ba0d8809658990
-  data.tar.gz: dfc80b46023d5f28e38f2116e62676f579d175f1fcca023c46bb921298c99dc7
+  metadata.gz: 6f521946dedcb0f22d30ef1ca8be0aa3c2f1eb967dfc629f0da7c1640ddfba1e
+  data.tar.gz: 2f6479875ecc1f3271d20e4b1626c8bff8e305f8e5cb82fa49d6676b786b4495
 SHA512:
-  metadata.gz: b0a025a6629018fc3cd5687f6675aee4ce0f4ef0edb740c35b1ba45f1f77df3fc6bb85b658d52a469d9b7f2e83820efcb636a9e062d1b196372fb8cb0b3b447e
-  data.tar.gz: a7af845632eda73b48f00fe07863f2b90f287e35402239203be296808aa5ae57d41fb3e8a498882254ed3407022f5f88d0895e0e81d59d861f83794f6bdbef76
+  metadata.gz: 4036965b0db3c36e648dd4e80cd2656d4aeb03619a37530e6145bf84dbcd6f46eda5ccbaa051f3c605922b72618a4ebdd2de6e2d14962f441afad0ed6bb40a8d
+  data.tar.gz: 86b1e921da1dbaf594760f5269d47517ff54498bba74ff721f82d0963308f694a0452715a5b875da963fc29e9074a4221b84e4887aaa36dd6847491d9df0e501

data/.rubocop.yml

@@ -43,3 +43,6 @@ Style/OpenStructUse:
 Style/StringConcatenation:
   Exclude:
     - test/test_apply_command.rb
+
+Style/SafeNavigationChainLength:
+  Enabled: false

data/bridgetown-core.gemspec

@@ -52,7 +52,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency("rouge",                     [">= 3.0", "< 5.0"])
   s.add_runtime_dependency("serbea",                    "~> 2.1")
   s.add_runtime_dependency("signalize",                 "~> 1.3")
-  s.add_runtime_dependency("streamlined",               ">= 0.5.2")
+  s.add_runtime_dependency("streamlined",               ">= 0.6.0")
   s.add_runtime_dependency("thor",                      "~> 1.1")
   s.add_runtime_dependency("tilt",                      "~> 2.0")
   s.add_runtime_dependency("zeitwerk",                  "~> 2.5")

data/lib/bridgetown-core/cache.rb

@@ -33,8 +33,6 @@ module Bridgetown
 
       # Compare the current config to the cached config
       # If they are different, clear all caches
-      #
-      # Returns nothing.
       def clear_if_config_changed(config)
         config = config.inspect
         cache = Bridgetown::Cache.new "Bridgetown::Cache"
@@ -49,8 +47,6 @@ module Bridgetown
       private
 
       # Delete all cached items from all caches
-      #
-      # Returns nothing.
       def delete_cache_files
         FileUtils.rm_rf(@cache_dir) if disk_cache_enabled
       end
@@ -60,9 +56,7 @@ module Bridgetown
 
     # Get an existing named cache, or create a new one if none exists
     #
-    # name - name of the cache
-    #
-    # Returns nothing.
+    # @param name [String] name of the cache
     def initialize(name)
       @cache = Bridgetown::Cache.base_cache[name] ||= {}
       @name = name.gsub(%r![^\w\s-]!, "-")
@@ -77,7 +71,7 @@ module Bridgetown
     # Retrieve a cached item
     # Raises if key does not exist in cache
     #
-    # Returns cached value
+    # @return [Object] cached value
     def [](key)
       return @cache[key] if @cache.key?(key)
 
@@ -88,8 +82,6 @@ module Bridgetown
     end
 
     # Add an item to cache
-    #
-    # Returns nothing.
     def []=(key, value)
       @cache[key] = value
       return unless disk_cache_enabled?
@@ -112,8 +104,6 @@ module Bridgetown
     end
 
     # Remove one particular item from the cache
-    #
-    # Returns nothing.
     def delete(key)
       @cache.delete(key)
       File.delete(path_to(hash(key))) if disk_cache_enabled?
@@ -121,7 +111,7 @@ module Bridgetown
 
     # Check if `key` already exists in this cache
     #
-    # Returns true if key exists in the cache, false otherwise
+    # @return [Boolean] true if key exists in the cache, false otherwise
     def key?(key)
       # First, check if item is already cached in memory
       return true if @cache.key?(key)
@@ -153,14 +143,11 @@ module Bridgetown
     end
 
     # Remove all this caches items from disk
-    #
-    # Returns nothing.
     def delete_cache_files
       FileUtils.rm_rf(path_to) if disk_cache_enabled?
     end
 
     # Load `path` from disk and return the result.
-    # This MUST NEVER be called in Safe Mode
     # rubocop:disable Security/MarshalLoad
     def load(path)
       raise unless disk_cache_enabled?
@@ -173,9 +160,6 @@ module Bridgetown
     # rubocop:enable Security/MarshalLoad
 
     # Given a path and a value, save value to disk at path.
-    # This should NEVER be called in Safe Mode
-    #
-    # Returns nothing.
     def dump(path, value)
       return unless disk_cache_enabled?
 

data/lib/bridgetown-core/cleaner.rb

@@ -17,9 +17,9 @@ module Bridgetown
 
     private
 
-    # Private: The list of files and directories to be deleted during cleanup process
+    # The list of files and directories to be deleted during cleanup process
     #
-    # Returns an Array of the file and directory paths
+    # @return [Array<String>] file and directory paths
     def obsolete_files
       out = (existing_files - new_files - new_dirs + replaced_files).to_a
       Bridgetown::Hooks.trigger :clean, :on_obsolete, out
@@ -27,10 +27,9 @@ module Bridgetown
       out
     end
 
-    # Private: The list of existing files, apart from those included in
-    # keep_files and hidden files.
+    # The list of existing files, apart from those included in keep_files and hidden files
     #
-    # Returns a Set with the file paths
+    # @return [Set<String>] file paths
     def existing_files
       files = Set.new
       regex = keep_file_regex
@@ -45,9 +44,9 @@ module Bridgetown
       files
     end
 
-    # Private: The list of files to be created when site is built.
+    # The list of files to be created when site is built.
     #
-    # Returns a Set with the file paths
+    # @return [Set<String>] file paths
     def new_files
       @new_files ||= Set.new.tap do |files|
         site.each_site_file do |item|
@@ -60,17 +59,17 @@ module Bridgetown
       end
     end
 
-    # Private: The list of directories to be created when site is built.
+    # The list of directories to be created when site is built.
     # These are the parent directories of the files in #new_files.
     #
-    # Returns a Set with the directory paths
+    # @return [Set<String>] directory paths
     def new_dirs
       @new_dirs ||= new_files.flat_map { |file| parent_dirs(file) }.to_set
     end
 
-    # Private: The list of parent directories of a given file
+    # The list of parent directories of a given file
     #
-    # Returns an Array with the directory paths
+    # @return [Array<String>] directory paths
     def parent_dirs(file)
       parent_dir = File.dirname(file)
       if parent_dir == site.dest
@@ -80,29 +79,28 @@ module Bridgetown
       end
     end
 
-    # Private: The list of existing files that will be replaced by a directory
-    # during build
+    # The list of existing files that will be replaced by a directory during build
     #
-    # Returns a Set with the file paths
+    # @return [Set<String>] file paths
     def replaced_files
       new_dirs.select { |dir| File.file?(dir) }.to_set
     end
 
-    # Private: The list of directories that need to be kept because they are
+    # The list of directories that need to be kept because they are
     # parent directories of files specified in keep_files
     #
-    # Returns a Set with the directory paths
+    # @return [Set<String>] directory paths
     def keep_dirs
       site.config.keep_files.flat_map { |file| parent_dirs(site.in_dest_dir(file)) }.to_set
     end
 
-    # Private: Creates a regular expression from the config's keep_files array
+    # Creates a regular expression from the config's keep_files array
     #
-    # Examples
+    # @example
     #   ['.git','.svn'] with site.dest "/myblog/_site" creates
     #   the following regex: /\A\/myblog\/_site\/(\.git|\/.svn)/
     #
-    # Returns the regular expression
+    # @return [Regexp]
     def keep_file_regex
       %r!\A#{Regexp.quote(site.dest)}/(#{Regexp.union(site.config.keep_files).source})!
     end

data/lib/bridgetown-core/collection.rb

@@ -400,7 +400,7 @@ module Bridgetown
 
     def model_id_from_relative_path(model_relative_path, manifest: nil)
       scheme = manifest ? "plugin" : "repo"
-      id = +"#{scheme}://#{label}.collection/"
+      id = "#{scheme}://#{label}.collection/"
       id += "#{manifest.origin}/" if manifest
       id += Addressable::URI.escape(model_relative_path).gsub("#", "%23")
       id

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

@@ -66,11 +66,7 @@ module Bridgetown
           build_site(config_options)
         end
 
-        # TODO: remove this logic…I can't find "detach" anywhere
-        if config_options.fetch("detach", false)
-          Bridgetown.logger.info "Auto-regeneration:",
-                                 "disabled when running server detached."
-        elsif config_options.fetch("watch", false)
+        if config_options.fetch("watch", false)
           watch_site(config_options)
         else
           Bridgetown.logger.info "Auto-regeneration:", "disabled. Use --watch to enable."
@@ -79,11 +75,9 @@ module Bridgetown
 
       protected
 
-      # Build your Bridgetown site.
+      # Build your Bridgetown site
       #
-      # options - A Hash of options passed to the command or loaded from config
-      #
-      # Returns nothing.
+      # @param options [Bridgetown::Configuration] options loaded from config and/or CLI
       def build_site(config_options)
         t = Time.now
         display_folder_paths(config_options)
@@ -97,27 +91,22 @@ module Bridgetown
                                           "#{(Time.now - t).ceil(2)} seconds."
       end
 
-      # Watch for file changes and rebuild the site.
-      #
-      # options - A Hash of options passed to the command or loaded from config
+      # Watch for file changes and rebuild the site
       #
-      # Returns nothing.
+      # @param options [Bridgetown::Configuration] options loaded from config and/or CLI
       def watch_site(config_options)
         Bridgetown::Watcher.watch(@site, config_options)
       end
 
       # Display the source and destination folder paths
       #
-      # options - A Hash of options passed to the command
-      #
-      # Returns nothing.
+      # @param options [Bridgetown::Configuration] options loaded from config and/or CLI
       def display_folder_paths(config_options)
         source = File.expand_path(config_options["source"])
         destination = File.expand_path(config_options["destination"])
         Bridgetown.logger.info "Environment:", Bridgetown.environment.cyan
         Bridgetown.logger.info "Source:", source
         Bridgetown.logger.info "Destination:", destination
-        # TODO: work with arrays
         return unless config_options["plugins_dir"].is_a?(String)
 
         plugins_dir = File.expand_path(config_options["plugins_dir"])

data/lib/bridgetown-core/commands/concerns/actions.rb

@@ -116,6 +116,10 @@ module Bridgetown
         run "#{Bridgetown::PluginManager.package_manager} #{Bridgetown::PluginManager.package_manager_install_command} #{package_details}" # rubocop:disable Layout
       end
 
+      def remove_npm_package(package_details)
+        run "#{Bridgetown::PluginManager.package_manager} #{Bridgetown::PluginManager.package_manager_uninstall_command} #{package_details}" # rubocop:disable Layout
+      end
+
       def apply_from_url(url)
         apply transform_automation_url(url.dup)
       end

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

@@ -1,16 +1,17 @@
-const build = require("./config/esbuild.defaults.js")
+import build from "./config/esbuild.defaults.js"
 
 // You can customize this as you wish, perhaps to add new esbuild plugins.
 //
 // ```
-// const path = require("path")
-// const esbuildCopy = require('esbuild-plugin-copy').default
+// import { copy } from 'esbuild-plugin-copy'
+// 
 // const esbuildOptions = {
 //   plugins: [
-//     esbuildCopy({
+//     copy({
+//       resolveFrom: 'cwd',
 //       assets: {
-//         from: [path.resolve(__dirname, 'node_modules/somepackage/files/*')],
-//         to: [path.resolve(__dirname, 'output/_bridgetown/somepackage/files')],
+//         from: ['./node_modules/somepackage/files/*')],
+//         to: ['./output/_bridgetown/somepackage/files')],
 //       },
 //       verbose: false
 //     }),

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

@@ -16,19 +16,19 @@ const autogeneratedBridgetownConfig = {
   "islandsDir": "_islands"
 }
 
-const path = require("path")
-const fsLib = require("fs")
+import path from "path"
+import fsLib from "fs"
 const fs = fsLib.promises
-const { pathToFileURL, fileURLToPath } = require("url")
-const glob = require("glob")
-const postcss = require("postcss")
-const postCssImport = require("postcss-import")
-const readCache = require("read-cache")
+import { pathToFileURL, fileURLToPath } from "url"
+import { glob } from "glob"
+import postcss from "postcss"
+import postCssImport from "postcss-import"
+import readCache from "read-cache"
 
 // Detect if an NPM package is available
 const moduleAvailable = name => {
   try {
-    require.resolve(name)
+    import.meta.resolve(name)
     return true
   } catch (e) { }
   return false
@@ -43,7 +43,7 @@ const generateSourceMappingURL = sourceMap => {
 // Import Sass if available
 let sass
 if (moduleAvailable("sass")) {
-  sass = require("sass")
+  sass = (await import("sass")).default
 }
 
 // Glob plugin derived from:
@@ -288,9 +288,9 @@ const bridgetownConfigured = (bridgetownConfig, outputFolder) => {
 }
 
 // Load the PostCSS config from postcss.config.js or whatever else is a supported location/format
-const postcssrc = require("postcss-load-config")
+const postcssrc = (await import("postcss-load-config")).default
 
-module.exports = async (esbuildOptions, ...args) => {
+export default async (esbuildOptions, ...args) => {
   let outputFolder;
   if (typeof esbuildOptions === "string") { // legacy syntax where first argument is output folder
     outputFolder = esbuildOptions
@@ -313,11 +313,12 @@ module.exports = async (esbuildOptions, ...args) => {
   esbuildOptions.plugins.push(bridgetownPreset(bridgetownConfig))
   if (esbuildOptions.bridgetownConfig) delete esbuildOptions.bridgetownConfig
 
-  const esbuild = require("esbuild")
+  const esbuild = (await import("esbuild")).default
   const entryPoints = esbuildOptions.entryPoints || ["./frontend/javascript/index.js"]
   if (esbuildOptions.entryPoints) delete esbuildOptions.entryPoints
 
   const islands = glob.sync(`./${bridgetownConfig.source}/${bridgetownConfig.islandsDir}/*.{js,js.rb}`).map(item => `./${item}`)
+  const islandsAsObject = islands.reduce((obj, str) => obj[str] = str, {})
 
   esbuild.context({
     bundle: true,
@@ -339,7 +340,7 @@ module.exports = async (esbuildOptions, ...args) => {
     minify: process.argv.includes("--minify"),
     sourcemap: true,
     target: "es2020",
-    entryPoints: [...entryPoints, ...islands],
+    entryPoints: Array.isArray(entryPoints) ? [...entryPoints, ...islands] : {...entryPoints, ...islandsAsObject},
     entryNames: "[dir]/[name].[hash]",
     outdir: path.join(process.cwd(), `${bridgetownConfig.destination}/_bridgetown/static`),
     publicPath: "/_bridgetown/static",

data/lib/bridgetown-core/commands/esbuild/migrate-from-webpack.rb

@@ -25,7 +25,7 @@ unless Bridgetown.environment.test?
     confirm = ask "\nThe following packages will be removed: \n\n#{packages_to_remove.join("\n")}\n\nWould you like to continue? [Yn]"
     return unless confirm.casecmp?("Y")
 
-    run "yarn remove #{packages_to_remove.join(" ")}"
+    remove_npm_package packages_to_remove.join(" ")
   end
 end
 

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

@@ -2,8 +2,22 @@
 
 template "esbuild.defaults.js.erb", "config/esbuild.defaults.js", force: true
 copy_file "jsconfig.json"
-say "🎉 esbuild configuration updated successfully!"
+
+unless File.read("package.json").include?('"type": "module"')
+  insert_into_file "package.json",
+                   after: '"private": true,' do
+    <<-JS.chomp
+
+  "type": "module",
+    JS
+  end
+end
+
+gsub_file "postcss.config.js", "module.exports =", "export default"
+gsub_file "esbuild.config.js", 'const build = require("./config/esbuild.defaults.js")',
+          'import build from "./config/esbuild.defaults.js"'
+add_npm_package "esbuild@latest glob@latest" unless Bridgetown.env.test?
+
+say "\n🎉 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."
-say "⚠️ Don't forget to update the esbuild version in your `package.json` file to \"^0.20.2\""
-say "and run `npm install`!"

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

@@ -3,7 +3,7 @@
 module Bridgetown
   module Commands
     class Esbuild < Thor::Group
-      include Thor::Actions
+      include Thor::Actions, Bridgetown::Commands::Actions
       extend Summarizable
 
       Registrations.register do

data/lib/bridgetown-core/component.rb

@@ -94,7 +94,7 @@ module Bridgetown
 
       def path_for_errors
         File.basename(component_template_path)
-      rescue RuntimeError
+      rescue RuntimeError, TypeError
         source_location
       end
     end

data/lib/bridgetown-core/concerns/layout_placeable.rb

@@ -4,7 +4,7 @@ module Bridgetown
   module LayoutPlaceable
     # Determine whether the file should be placed into layouts.
     #
-    # Returns false if the document is an asset file or if the front matter
+    # @return [Boolean] false if the document is an asset file or if the front matter
     #   specifies `layout: none`
     def place_in_layout?
       no_layout?.!

data/lib/bridgetown-core/concerns/publishable.rb

@@ -3,6 +3,8 @@
 module Bridgetown
   module Publishable
     # Whether the resource is published or not, as indicated in YAML front-matter
+    #
+    # @return [Boolean]
     def published?
       !(data.key?("published") && data["published"] == false)
     end

data/lib/bridgetown-core/concerns/site/content.rb

@@ -27,6 +27,7 @@ class Bridgetown::Site
     end
 
     # Returns the contents of the site metadata file or a blank hash
+    #
     # @return [HashWithDotAccess::Hash] Returns a hash of site metadata
     def metadata
       signals["site_metadata"] ||= HashWithDotAccess::Hash.new
@@ -49,7 +50,6 @@ class Bridgetown::Site
     #
     # @return [HashWithDotAccess::Hash{String, Symbol => Collection}] A Hash
     #   containing a collection name-to-instance pairs.
-    #
     # @return [HashWithDotAccess::Hash] Returns a blank hash if no items found
     def collections
       @collections ||= collection_names.each_with_object(
@@ -60,6 +60,7 @@ class Bridgetown::Site
     end
 
     # An array of collection names.
+    #
     # @return [Array<String>] an array of collection names from the configuration,
     #   or an empty array if the `config["collections"]` key is not set.
     def collection_names
@@ -84,6 +85,7 @@ class Bridgetown::Site
     end
 
     # Get all loaded resources.
+    #
     # @return [Array<Bridgetown::Resource::Base>] an array of resources
     def resources
       collections.each_with_object(Set.new) do |(_, collection), set|
@@ -112,6 +114,7 @@ class Bridgetown::Site
     end
 
     # Loads and memoizes the parsed frontend bundler manifest file (if available)
+    #
     # @return [Hash]
     def frontend_manifest
       @frontend_manifest ||= begin

data/lib/bridgetown-core/concerns/site/extensible.rb

@@ -4,6 +4,7 @@ class Bridgetown::Site
   module Extensible
     # Load necessary libraries, plugins, converters, and generators.
     # This is only ever run once for the lifecycle of the site object.
+    #
     # @see Converter
     # @see Generator
     # @see PluginManager
@@ -16,6 +17,7 @@ class Bridgetown::Site
     end
 
     # Run all Generators.
+    #
     # @see Generator
     # @return [void]
     def generate
@@ -34,6 +36,7 @@ class Bridgetown::Site
     end
 
     # Get the implementation for the given Converter class.
+    #
     # @param klass [Class] The Class of the Converter to fetch.
     # @return [Converter] Returns the {Converter}
     #   instance implementing the given `Converter` class.
@@ -46,7 +49,8 @@ class Bridgetown::Site
 
     # Create an array of instances of the subclasses of the class
     #   passed in as argument.
-    # @param klass [Class] - class which is the parent of the subclasses.
+    #
+    # @param klass [Class] class which is the parent of the subclasses.
     # @return [Array<Converter, Generator>] Returns an array of instances of
     #   subclasses of `klass`.
     def instantiate_subclasses(klass)
@@ -56,6 +60,7 @@ class Bridgetown::Site
     end
 
     # Shorthand for registering a site hook via {Bridgetown::Hooks}
+    #
     # @param event [Symbol] name of the event (`:pre_read`, `:post_render`, etc.)
     # @yield the block will be called when the event is triggered
     # @yieldparam site the site which triggered the event hook

data/lib/bridgetown-core/concerns/site/fast_refreshable.rb

@@ -10,15 +10,16 @@ class Bridgetown::Site
       @fast_refresh_ordering = 0
       full_abort = false
       found_gen_pages = false
-      paths.each do |path|
-        res = resources.find do |resource|
+      paths.each do |path| # rubocop:todo Metrics
+        found_res = resources.select do |resource|
           resource.id.start_with?("repo://") && in_source_dir(resource.relative_path) == path
         end
 
         layouts_to_reload = Set.new
-        locate_resource_layouts_and_partials_for_fash_refresh(path, layouts_to_reload) unless res
+        locate_resource_layouts_and_partials_for_fash_refresh(path, layouts_to_reload) unless
+          found_res.any?
 
-        locate_components_for_fast_refresh(path) unless res
+        locate_components_for_fast_refresh(path) unless found_res.any?
 
         pages = locate_layouts_and_pages_for_fast_refresh(path, layouts_to_reload)
 
@@ -27,21 +28,22 @@ class Bridgetown::Site
             self, layout.instance_variable_get(:@base), layout.name
           )
         end
-        liquid_renderer.reset unless layouts_to_reload.empty?
-        next unless res || !pages.empty?
+        next unless found_res.any? || pages.any?
 
-        unless pages.empty?
+        if pages.any?
           found_gen_pages = true
           mark_original_page_resources_for_fast_refresh(pages)
           next
         end
 
-        res.prepare_for_fast_refresh!.tap { full_abort = true unless _1 }
-        next unless res.collection.data?
+        found_res.each do |res|
+          res.prepare_for_fast_refresh!.tap { full_abort = true unless _1 }
+          next unless res.collection.data?
 
-        res.collection.merge_data_resources.each do |k, v|
-          data[k] = v
-          signals[k] = v
+          res.collection.merge_data_resources.each do |k, v|
+            data[k] = v
+            signals[k] = v
+          end
         end
       end
 
@@ -60,6 +62,7 @@ class Bridgetown::Site
 
       Bridgetown::Hooks.trigger :site, :fast_refresh, self
 
+      liquid_renderer.reset
       transform_resources_for_fast_refresh(marked_resources, found_gen_pages)
       transform_generated_pages_for_fast_refresh
 
@@ -134,7 +137,11 @@ class Bridgetown::Site
     end
 
     def transform_resources_for_fast_refresh(marked_resources, found_gen_pages)
-      marked_resources.each { _1.transform!.write }
+      marked_resources.each do |res|
+        render_with_locale(res) do
+          res.transform!.write
+        end
+      end
       number_of_resources = marked_resources.length
       number_of_resources += 1 if found_gen_pages
       Bridgetown.logger.info(

data/lib/bridgetown-core/concerns/site/localizable.rb

@@ -3,6 +3,7 @@
 class Bridgetown::Site
   module Localizable
     # Returns the current and/or default configured locale
+    #
     # @return String
     def locale
       @locale ||= begin
@@ -16,6 +17,7 @@ class Bridgetown::Site
     end
 
     # Sets the current locale for the site
+    #
     # @param new_locale [String] for example: "en" for English, "es" for Spanish
     def locale=(new_locale)
       I18n.locale = @locale = new_locale.to_sym

data/lib/bridgetown-core/concerns/site/processable.rb

@@ -3,6 +3,7 @@
 class Bridgetown::Site
   module Processable
     # Reset, Read, Generate, Render, Cleanup, Process, and Write this Site to output.
+    #
     # @return [void]
     # @see #reset
     # @see #read
@@ -67,6 +68,7 @@ class Bridgetown::Site
     end
 
     # Read data from disk and load it into internal memory.
+    #
     # @return [void]
     def read
       Bridgetown::Hooks.trigger :site, :pre_read, self