raindown 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee322a9f4df788bddfb51b6d669a7a676574620ecd1ce30e69a5682d49b8c88e
-  data.tar.gz: 2bb5f698d9c5e90f0c44271e4b1529512dab858dcd07beb04061ac8690a81bff
+  metadata.gz: 17711b42b7bfd45766f0ad743b58035648b99394031bde5a420e92f01918f8a3
+  data.tar.gz: 94753448785a4825b3e2745d0690db75d69b052d57c3ca2e185793b427fedbef
 SHA512:
-  metadata.gz: e550608449c87c693edef3c249472a89c62618de92941b81e135250462bbc74a062b61b2e025ea8666ff571b5057a25b67a13ed6fb385f304e500448f09a3034
-  data.tar.gz: a60db4e479d593ea779e93c3c683401519599ac0bf1d07f6f1e2a280634eff26b5f46167f27d5ce24fcd08f54660cb4051ed21e0c422951247a8f3d2c53938a7
+  metadata.gz: be61212919255c9018253757f33d02e6cae3ec7811276791fe06bfbdaad748ffe4f47abeac8aad807d5862a7b2bcb493a2d53bebfd30f9abcb820c7faffaf438
+  data.tar.gz: 50488661cf504f7fa1fc9963a9aff7a6ebefb755ba46e2b0e63413133ee4e5781e9d9b94f0ba7c3965d7759b453d95ea7254713cf5e5dce73df2e6299de89b71

data/lib/raindown/cli.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
+require 'fileutils'
 require 'trees'
 require_relative '../raindown'
+require_relative '../version'
 require_relative 'rewriter'
 require_relative 'watcher'
 
@@ -11,9 +13,13 @@ module Raindown
 
     USAGE = <<~TEXT
       Usage: raindown FILE [options]
+             raindown init [DIRECTORY]
 
       Renders FILE to HTML, then re-renders it every time it is saved.
 
+      Commands:
+        init [DIRECTORY]    Create a .raindown folder for the project's config and nodes (default: current directory)
+
       Options:
         -o, --output PATH   Write output to PATH instead of FILE.html beside FILE
         --once              Render once without watching, printing to stdout unless -o is given
@@ -22,8 +28,21 @@ module Raindown
         --bare              Allow bare directives like :toc in Markdown files
         -x, --execute       Run endpoint curl snippets that have no output yet
         -h, --help          Show this message
+        -v, --version       Show the version
+
+      Set RAINDOWN_DEBUG=1 to show where an error happened.
     TEXT
 
+    CONFIG = <<~YAML
+      # Raindown project settings. See https://raindown.dev/docs/config
+      #
+      # Show directives as HTML comments rather than in bold:
+      # hide_directives: true
+      #
+      # Leave code blocks unhighlighted, so the browser can highlight them instead:
+      # highlight_code: false
+    YAML
+
     OPTIONS = { output: ['-o :output', '--output :output'], bare: ['--bare'], execute: ['-x', '--execute'],
                 once: ['--once'], stdin: ['--stdin'] }.freeze
 
@@ -50,11 +69,34 @@ module Raindown
       end
     end
 
-    # The :path line would match a help flag as the file, so help is checked first.
+    # The :path line would match help, version and init as the file, so they're checked first.
     def self.run(argv)
       abort(USAGE) if argv.empty? || argv.intersect?(%w[-h --help])
+      return puts(VERSION) if argv.intersect?(%w[-v --version])
+      return init(argv[1]) if argv.first == 'init' && argv.size <= 2
 
       super || abort("Unknown arguments: #{argv.join(' ')}\n\n#{USAGE}")
+    rescue StandardError => e
+      report(e, path: argv.first)
+    end
+
+    # Shows an error in a file as one line, rather than a backtrace, unless RAINDOWN_DEBUG is set.
+    def self.report(error, path:)
+      raise error if ENV['RAINDOWN_DEBUG']
+
+      abort("raindown: #{path}: #{error.message}")
+    end
+
+    # Creates the .raindown folder that marks a project's root and holds its config.yml and nodes.
+    def self.init(directory = nil)
+      folder = File.join(directory || Dir.pwd, Nodes::FOLDER)
+      config = File.join(folder, Config::FILE)
+      return puts("#{config} already exists") if File.exist?(config)
+
+      FileUtils.mkdir_p(folder)
+      File.write(config, CONFIG)
+      puts "Created #{config}"
+      puts 'Put your own nodes in the same folder. See https://raindown.dev/docs/nodes'
     end
 
     class << self

data/lib/raindown/directives.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'erb'
+require 'cgi/escape'
 
 module Raindown
   # Content directives, like a node's directive and end tag or an endpoint's, are kept in the HTML:
@@ -22,7 +22,7 @@ module Raindown
     def render(html, hide: false)
       html.gsub(MARKER) do
         text = ::Regexp.last_match(1)
-        hide ? "<!-- #{text} -->" : "<p><strong>#{ERB::Util.html_escape(text)}</strong></p>"
+        hide ? "<!-- #{text} -->" : "<p><strong>#{CGI.escapeHTML(text.to_s)}</strong></p>"
       end
     end
   end

data/lib/raindown/node_blocks.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'lowkey'
+
 require_relative 'code_blocks'
 require_relative 'directives'
 require_relative 'front_matter'
@@ -131,13 +133,12 @@ module Raindown
       text.scan(PROP).to_h { |name, value| [name.to_sym, value(value, variables)] }
     end
 
+    # A value, like 'text', 3, true, nil or :draft, or else a variable, like author.name.
     def value(value, variables)
-      case value
-      when /\A(["']).*\1\z/ then value[1..-2]
-      when /\A-?\d+\z/ then value.to_i
-      when /\A-?\d+\.\d+\z/ then value.to_f
-      when 'true', 'false' then value == 'true'
-      else Variables.value(variables, value)
+      Lowkey::ValueParser.parse(value) do
+        next value[1..-2] if value.match?(/\A(["']).*\1\z/)
+
+        Variables.value(variables, value)
       end
     end
   end

data/lib/raindown/toc.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
-require 'erb'
-require 'nokogiri'
+require 'cgi/escape'
 
 require_relative 'node'
 
@@ -9,6 +8,12 @@ module Raindown
   # The node behind toc: and :toc, a table of contents of the document's headings.
   # A project can replace it with its own TOC node in .raindown, like "class TOC < Raindown::TOC".
   class TOC < Node
+    # A heading with an id, in the HTML that Commonmarker and Raindown's components write, like <h2 id="setup">.
+    HEADING = %r{<h([1-6])\b[^>]*?\bid=(?:"([^"]*)"|'([^']*)'|([^\s>]+))[^>]*>(.*?)</h\1\s*>}mi
+    # Comments and scripts can hold heading tags that aren't in the page.
+    IGNORED = %r{<!--.*?-->|<script\b.*?</script\s*>}mi
+    TAG = /<[^>]*>/
+
     def replace(document:, metadata: nil, bare: false)
       headings = headings(markdown: document, metadata:, bare:)
       return '' if headings.empty?
@@ -23,7 +28,7 @@ module Raindown
     # With the document's final HTML, the headings include ones its components render.
     def render(document:, html: nil, metadata: nil, bare: false)
       items = headings(markdown: document, html:, metadata:, bare:).map do |heading|
-        "<li class='h#{heading[:level]}'><a href='##{heading[:id]}'>#{ERB::Util.html_escape(heading[:text])}</a></li>"
+        "<li class='h#{heading[:level]}'><a href='##{heading[:id]}'>#{CGI.escapeHTML(heading[:text])}</a></li>"
       end
 
       <<~HTML
@@ -42,8 +47,8 @@ module Raindown
     def headings(markdown:, html: nil, metadata: nil, bare: false)
       html ||= Fragments.collect { Raindown.assembled(markdown:, metadata: metadata || NoMetadata, bare:) }
 
-      Nokogiri::HTML(html).css(HEADINGS).map do |heading|
-        { level: heading.name[1].to_i, text: heading.text.strip, id: heading['id'] }
+      html.gsub(IGNORED, '').scan(HEADING).map do |level, *ids, content|
+        { level: level.to_i, text: CGI.unescapeHTML(content.gsub(TAG, '')).strip, id: CGI.unescapeHTML(ids.compact.first) }
       end
     end
   end

data/lib/raindown/watcher.rb

@@ -19,8 +19,10 @@ module Raindown
 
       $stdout.sync = true
 
-      rewrite
-      render
+      safely do
+        rewrite
+        render
+      end
       puts "Watching #{path} for changes (writing to #{output})..."
 
       listener.start
@@ -35,14 +37,26 @@ module Raindown
 
       Listen.to(directory) do |modified, added, _removed|
         next unless (modified + added).any? { |f| File.basename(f) == filename }
-        # Formatting saves the file again, and that change triggers the render.
-        next if rewrite
 
-        render
-        puts "Re-rendered #{path} -> #{output}"
+        safely do
+          # Formatting saves the file again, and that change triggers the render.
+          next if rewrite
+
+          render
+          puts "Re-rendered #{path} -> #{output}"
+        end
       end
     end
 
+    # An error in the file is shown rather than stopping the watcher, so it can be fixed and saved again.
+    def safely
+      yield
+    rescue StandardError => e
+      raise if ENV['RAINDOWN_DEBUG']
+
+      warn "raindown: #{path}: #{e.message}"
+    end
+
     # The files' metadata is loaded again each time, so new and renamed files are listed.
     def rewrite
       Rewriter.update(path:, bare:, execute:, metadata: Pages.for(path))

data/lib/raindown.rb

@@ -35,9 +35,6 @@ module Raindown
     def self.list(**) = []
   end
 
-  # Headings with an id, which are the ones a table of contents links to.
-  HEADINGS = 'h1[id], h2[id], h3[id], h4[id], h5[id], h6[id]'
-
   module_function
 
   # Directives show in bold and code is highlighted, unless the file's project changes them in .raindown/config.yml.

data/lib/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Raindown
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: raindown
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - maedi
 bindir: bin
 cert_chain: []
-date: 2026-10-20 00:00:00.000000000 Z
+date: 2026-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: antlers
@@ -80,21 +80,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: lownode
+  name: lowkey
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.7.0
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: lownode
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="