docyard 1.0.2 → 1.1.0

data/lib/docyard/ui.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module Docyard
+  module UI
+    CODES = {
+      red: 31,
+      green: 32,
+      yellow: 33,
+      cyan: 36,
+      bold: 1,
+      dim: 2
+    }.freeze
+
+    class << self
+      attr_writer :enabled
+
+      def enabled?
+        return @enabled unless @enabled.nil?
+
+        @enabled = determine_color_support
+      end
+
+      def reset!
+        @enabled = nil
+      end
+
+      def red(text)
+        wrap(text, CODES[:red])
+      end
+
+      def green(text)
+        wrap(text, CODES[:green])
+      end
+
+      def yellow(text)
+        wrap(text, CODES[:yellow])
+      end
+
+      def cyan(text)
+        wrap(text, CODES[:cyan])
+      end
+
+      def bold(text)
+        wrap(text, CODES[:bold])
+      end
+
+      def dim(text)
+        wrap(text, CODES[:dim])
+      end
+
+      def success(text)
+        wrap(text, CODES[:green], CODES[:bold])
+      end
+
+      def error(text)
+        wrap(text, CODES[:red], CODES[:bold])
+      end
+
+      def warning(text)
+        wrap(text, CODES[:yellow])
+      end
+
+      private
+
+      def wrap(text, *codes)
+        return text.to_s unless enabled?
+
+        prefix = codes.map { |c| "\e[#{c}m" }.join
+        "#{prefix}#{text}\e[0m"
+      end
+
+      def determine_color_support # rubocop:disable Naming/PredicateMethod
+        return false if ENV.key?("NO_COLOR")
+        return false unless $stdout.tty?
+
+        true
+      end
+    end
+  end
+end

data/lib/docyard/utils/logging.rb

@@ -64,9 +64,13 @@ module Docyard
       def format_message(severity, msg)
         case severity
         when "DEBUG"
-          "[DEBUG] #{msg}\n"
+          "#{UI.dim('[DEBUG]')} #{msg}\n"
         when "INFO"
           "#{msg}\n"
+        when "WARN"
+          "#{UI.warning('[WARN]')} #{msg}\n"
+        when "ERROR"
+          "#{UI.error('[ERROR]')} #{msg}\n"
         else
           "[#{severity}] #{msg}\n"
         end

data/lib/docyard/utils/text_formatter.rb

@@ -11,12 +11,6 @@ module Docyard
           .map(&:capitalize)
           .join(" ")
       end
-
-      def self.slugify(string)
-        string.downcase
-          .gsub(/\s+/, "-")
-          .gsub(/[^a-z0-9-]/, "")
-      end
     end
   end
 end

data/lib/docyard/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Docyard
-  VERSION = "1.0.2"
+  VERSION = "1.1.0"
 end

data/lib/docyard.rb

@@ -3,6 +3,8 @@
 require_relative "docyard/version"
 require_relative "docyard/constants"
 require_relative "docyard/errors"
+require_relative "docyard/diagnostic"
+require_relative "docyard/ui"
 require_relative "docyard/utils/logging"
 
 require_relative "docyard/utils/text_formatter"
@@ -37,5 +39,7 @@ require_relative "docyard/build/asset_bundler"
 require_relative "docyard/build/file_copier"
 require_relative "docyard/build/sitemap_generator"
 
+require_relative "docyard/doctor"
+
 module Docyard
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: docyard
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Sanif Himani
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-01-23 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cssminify
@@ -164,20 +163,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
-- !ruby/object:Gem::Dependency
-  name: tty-progressbar
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.18'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.18'
 description: Generate beautiful documentation sites from Markdown
 email:
 - sanifhimani92@gmail.com
@@ -199,6 +184,8 @@ files:
 - lib/docyard/build/root_fallback_generator.rb
 - lib/docyard/build/sitemap_generator.rb
 - lib/docyard/build/static_generator.rb
+- lib/docyard/build/step_runner.rb
+- lib/docyard/build/validator.rb
 - lib/docyard/builder.rb
 - lib/docyard/cli.rb
 - lib/docyard/components/aliases.rb
@@ -244,15 +231,46 @@ files:
 - lib/docyard/config.rb
 - lib/docyard/config/analytics_resolver.rb
 - lib/docyard/config/branding_resolver.rb
-- lib/docyard/config/key_validator.rb
 - lib/docyard/config/logo_detector.rb
 - lib/docyard/config/schema.rb
+- lib/docyard/config/schema/definition.rb
+- lib/docyard/config/schema/sections.rb
+- lib/docyard/config/schema/simple_sections.rb
 - lib/docyard/config/section.rb
-- lib/docyard/config/validation_helpers.rb
+- lib/docyard/config/type_validators.rb
 - lib/docyard/config/validator.rb
-- lib/docyard/config/validators/navigation.rb
-- lib/docyard/config/validators/section.rb
 - lib/docyard/constants.rb
+- lib/docyard/diagnostic.rb
+- lib/docyard/diagnostic_context.rb
+- lib/docyard/doctor.rb
+- lib/docyard/doctor/code_block_checker.rb
+- lib/docyard/doctor/component_checker.rb
+- lib/docyard/doctor/component_checkers/abbreviation_checker.rb
+- lib/docyard/doctor/component_checkers/badge_checker.rb
+- lib/docyard/doctor/component_checkers/base.rb
+- lib/docyard/doctor/component_checkers/callout_checker.rb
+- lib/docyard/doctor/component_checkers/cards_checker.rb
+- lib/docyard/doctor/component_checkers/code_group_checker.rb
+- lib/docyard/doctor/component_checkers/details_checker.rb
+- lib/docyard/doctor/component_checkers/icon_checker.rb
+- lib/docyard/doctor/component_checkers/image_attrs_checker.rb
+- lib/docyard/doctor/component_checkers/space_after_colons_checker.rb
+- lib/docyard/doctor/component_checkers/steps_checker.rb
+- lib/docyard/doctor/component_checkers/tabs_checker.rb
+- lib/docyard/doctor/component_checkers/tooltip_checker.rb
+- lib/docyard/doctor/component_checkers/unknown_type_checker.rb
+- lib/docyard/doctor/config_checker.rb
+- lib/docyard/doctor/config_fixer.rb
+- lib/docyard/doctor/content_checker.rb
+- lib/docyard/doctor/file_scanner.rb
+- lib/docyard/doctor/image_checker.rb
+- lib/docyard/doctor/link_checker.rb
+- lib/docyard/doctor/markdown_fixer.rb
+- lib/docyard/doctor/orphan_checker.rb
+- lib/docyard/doctor/reporter.rb
+- lib/docyard/doctor/sidebar_checker.rb
+- lib/docyard/doctor/sidebar_fixer.rb
+- lib/docyard/editor_launcher.rb
 - lib/docyard/errors.rb
 - lib/docyard/initializer.rb
 - lib/docyard/navigation/breadcrumb_builder.rb
@@ -281,7 +299,9 @@ files:
 - lib/docyard/search/pagefind_support.rb
 - lib/docyard/server/asset_handler.rb
 - lib/docyard/server/dev_server.rb
+- lib/docyard/server/error_overlay.rb
 - lib/docyard/server/file_watcher.rb
+- lib/docyard/server/page_diagnostics.rb
 - lib/docyard/server/pagefind_handler.rb
 - lib/docyard/server/preview_server.rb
 - lib/docyard/server/rack_application.rb
@@ -318,6 +338,7 @@ files:
 - lib/docyard/templates/assets/css/components/theme-toggle.css
 - lib/docyard/templates/assets/css/components/tooltip.css
 - lib/docyard/templates/assets/css/components/video.css
+- lib/docyard/templates/assets/css/error-overlay.css
 - lib/docyard/templates/assets/css/landing.css
 - lib/docyard/templates/assets/css/layout.css
 - lib/docyard/templates/assets/css/main.css
@@ -326,7 +347,7 @@ files:
 - lib/docyard/templates/assets/css/typography.css
 - lib/docyard/templates/assets/css/variables.css
 - lib/docyard/templates/assets/favicon.svg
-- lib/docyard/templates/assets/fonts/Inter-Variable.ttf
+- lib/docyard/templates/assets/fonts/Inter-Variable.woff2
 - lib/docyard/templates/assets/js/components/abbreviation.js
 - lib/docyard/templates/assets/js/components/banner.js
 - lib/docyard/templates/assets/js/components/code-block.js
@@ -337,12 +358,14 @@ files:
 - lib/docyard/templates/assets/js/components/heading-anchor.js
 - lib/docyard/templates/assets/js/components/lightbox.js
 - lib/docyard/templates/assets/js/components/navigation.js
+- lib/docyard/templates/assets/js/components/relative-time.js
 - lib/docyard/templates/assets/js/components/search.js
 - lib/docyard/templates/assets/js/components/sidebar-toggle.js
 - lib/docyard/templates/assets/js/components/tab-navigation.js
 - lib/docyard/templates/assets/js/components/table-of-contents.js
 - lib/docyard/templates/assets/js/components/tabs.js
 - lib/docyard/templates/assets/js/components/tooltip.js
+- lib/docyard/templates/assets/js/error-overlay.js
 - lib/docyard/templates/assets/js/hot-reload.js
 - lib/docyard/templates/assets/js/theme.js
 - lib/docyard/templates/assets/logo-dark.svg
@@ -394,6 +417,7 @@ files:
 - lib/docyard/templates/partials/_table_of_contents_toggle.html.erb
 - lib/docyard/templates/partials/_tabs.html.erb
 - lib/docyard/templates/partials/_theme_toggle.html.erb
+- lib/docyard/ui.rb
 - lib/docyard/utils/git_info.rb
 - lib/docyard/utils/hash_utils.rb
 - lib/docyard/utils/html_helpers.rb
@@ -414,7 +438,6 @@ metadata:
   documentation_uri: https://docyard.dev
   bug_tracker_uri: https://github.com/sanifhimani/docyard/issues
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -429,8 +452,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.7.2
 specification_version: 4
 summary: Generate beautiful documentation sites from Markdown
 test_files: []

data/lib/docyard/config/key_validator.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module Docyard
-  class Config
-    module KeyValidator
-      class << self
-        def validate(hash, valid_keys, context:)
-          return [] unless hash.is_a?(Hash)
-
-          unknown = hash.keys.map(&:to_s) - valid_keys
-          unknown.map { |key| build_error(key, valid_keys, context) }
-        end
-
-        private
-
-        def build_error(key, valid_keys, context)
-          suggestion = find_suggestion(key, valid_keys)
-          msg = "unknown key '#{key}'"
-          msg += ". Did you mean '#{suggestion}'?" if suggestion
-          { context: context, message: msg }
-        end
-
-        def find_suggestion(key, valid_keys)
-          checker = DidYouMean::SpellChecker.new(dictionary: valid_keys)
-          checker.correct(key).first
-        end
-      end
-    end
-  end
-end

data/lib/docyard/config/validation_helpers.rb

@@ -1,83 +0,0 @@
-# frozen_string_literal: true
-
-module Docyard
-  class Config
-    module ValidationHelpers
-      private
-
-      def validate_string(value, field_name)
-        return if value.nil? || value.is_a?(String)
-
-        add_error(field: field_name, error: "must be a string", got: value.class.name, fix: "Change to a string value")
-      end
-
-      def validate_boolean(value, field_name)
-        return if [true, false].include?(value)
-
-        add_error(field: field_name, error: "must be true or false", got: value.inspect, fix: "Change to true or false")
-      end
-
-      def validate_url(value, field_name)
-        return if value.nil? || value.is_a?(String)
-
-        add_error(field: field_name, error: "must be a URL string", got: value.class.name,
-                  fix: "Change to a URL string")
-      end
-
-      def validate_array(value, field_name)
-        return if value.nil? || value.is_a?(Array)
-
-        add_array_error(field_name)
-      end
-
-      def validate_file_path_or_url(value, field_name)
-        return if value.nil?
-        return add_type_error(field_name, "file path or URL (string)", value.class.name) unless value.is_a?(String)
-        return if url?(value)
-
-        public_dir = File.join(@config["source"] || "docs", "public")
-        file_path = File.absolute_path?(value) ? value : File.join(public_dir, value)
-        return if File.exist?(file_path)
-
-        add_error(field: field_name, error: "file not found", got: value,
-                  fix: "Place the file in #{public_dir}/ directory (e.g., 'logo.svg' for #{public_dir}/logo.svg)")
-      end
-
-      def validate_no_slashes(value, field_name)
-        return if value.nil? || !value.is_a?(String)
-        return unless value.include?("/") || value.include?("\\")
-
-        add_error(field: field_name, error: "cannot contain slashes", got: value,
-                  fix: "Use a simple directory name like 'dist' or '_site'")
-      end
-
-      def validate_starts_with_slash(value, field_name)
-        return if value.nil? || value.start_with?("/")
-
-        add_error(field: field_name, error: "must start with /", got: value, fix: "Change to '/#{value}'")
-      end
-
-      def url?(value)
-        value.match?(%r{\Ahttps?://})
-      end
-
-      def add_error(error_data)
-        @errors << error_data
-      end
-
-      def add_type_error(field, expected, got)
-        add_error(field: field, error: "must be a #{expected}", got: got, fix: "Change to a #{expected}")
-      end
-
-      def add_hash_error(field)
-        add_error(field: field, error: "must be a hash", got: @config[field].class.name,
-                  fix: "Change to a hash with platform names as keys and URLs as values")
-      end
-
-      def add_array_error(field)
-        value = field.split(".").reduce(@config) { |h, k| h&.[](k) }
-        add_error(field: field, error: "must be an array", got: value.class.name, fix: "Change to an array")
-      end
-    end
-  end
-end

data/lib/docyard/config/validators/navigation.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-module Docyard
-  class Config
-    module Validators
-      module Navigation
-        private
-
-        def validate_navigation_section
-          cta = @config.dig("navigation", "cta")
-          return if cta.nil?
-          return add_array_error("navigation.cta") unless cta.is_a?(Array)
-
-          validate_cta_max_count(cta)
-          validate_cta_items(cta)
-        end
-
-        def validate_cta_items(cta)
-          cta.each_with_index do |item, idx|
-            validate_string(item["text"], "navigation.cta[#{idx}].text")
-            validate_string(item["href"], "navigation.cta[#{idx}].href")
-            validate_cta_variant(item["variant"], idx) if item.key?("variant")
-            validate_boolean(item["external"], "navigation.cta[#{idx}].external") if item.key?("external")
-          end
-        end
-
-        def validate_cta_max_count(cta)
-          return if cta.length <= 2
-
-          add_error(field: "navigation.cta", error: "maximum 2 CTAs allowed",
-                    got: "#{cta.length} items", fix: "Remove extra CTA items to have at most 2")
-        end
-
-        def validate_cta_variant(variant, idx)
-          return if variant.nil? || %w[primary secondary].include?(variant)
-
-          add_error(field: "navigation.cta[#{idx}].variant", error: "must be 'primary' or 'secondary'",
-                    got: variant, fix: "Change to 'primary' or 'secondary'")
-        end
-      end
-    end
-  end
-end

data/lib/docyard/config/validators/section.rb

@@ -1,114 +0,0 @@
-# frozen_string_literal: true
-
-module Docyard
-  class Config
-    module Validators
-      module Section
-        private
-
-        def validate_top_level
-          validate_string(@config["title"], "title")
-          validate_string(@config["description"], "description")
-        end
-
-        def validate_branding_section
-          branding = @config["branding"]
-          return unless branding
-
-          validate_file_path_or_url(branding["logo"], "branding.logo")
-          validate_file_path_or_url(branding["favicon"], "branding.favicon")
-          validate_boolean(branding["credits"], "branding.credits") if branding.key?("credits")
-        end
-
-        def validate_socials_section
-          socials = @config["socials"]
-          return unless socials
-          return add_hash_error("socials") unless socials.is_a?(Hash)
-
-          socials.each { |platform, url| validate_url(url, "socials.#{platform}") unless platform == "custom" }
-          validate_custom_socials(socials["custom"]) if socials.key?("custom")
-        end
-
-        def validate_custom_socials(custom)
-          return if custom.nil?
-          return add_array_error("socials.custom") unless custom.is_a?(Array)
-
-          custom.each_with_index do |item, index|
-            validate_string(item["icon"], "socials.custom[#{index}].icon")
-            validate_url(item["href"], "socials.custom[#{index}].href")
-          end
-        end
-
-        def validate_tabs_section
-          tabs = @config["tabs"]
-          return unless tabs
-          return add_array_error("tabs") unless tabs.is_a?(Array)
-
-          tabs.each_with_index do |tab, index|
-            validate_string(tab["text"], "tabs[#{index}].text")
-            validate_string(tab["href"], "tabs[#{index}].href")
-            validate_boolean(tab["external"], "tabs[#{index}].external") if tab.key?("external")
-          end
-        end
-
-        def validate_sidebar_setting
-          sidebar = @config["sidebar"]
-          return if sidebar.nil? || Config::SIDEBAR_MODES.include?(sidebar)
-
-          add_error(
-            field: "sidebar",
-            error: "must be one of: #{Config::SIDEBAR_MODES.join(', ')}",
-            got: sidebar.inspect,
-            fix: "Change to 'config', 'auto', or 'distributed'"
-          )
-        end
-
-        def validate_build_section
-          build = @config["build"]
-          return unless build
-
-          validate_string(build["output"], "build.output")
-          validate_no_slashes(build["output"], "build.output")
-          validate_string(build["base"], "build.base")
-          validate_starts_with_slash(build["base"], "build.base")
-        end
-
-        def validate_search_section
-          search = @config["search"]
-          return unless search
-
-          validate_boolean(search["enabled"], "search.enabled") if search.key?("enabled")
-          validate_string(search["placeholder"], "search.placeholder") if search.key?("placeholder")
-          validate_array(search["exclude"], "search.exclude") if search.key?("exclude")
-        end
-
-        def validate_announcement_section
-          announcement = @config["announcement"]
-          return unless announcement.is_a?(Hash)
-
-          validate_string(announcement["text"], "announcement.text") if announcement.key?("text")
-        end
-
-        def validate_feedback_section
-          feedback = @config["feedback"]
-          return unless feedback.is_a?(Hash) && feedback["enabled"] == true
-          return if analytics_configured?
-
-          add_error(
-            field: "feedback.enabled",
-            error: "requires analytics to be configured",
-            got: "feedback enabled without analytics",
-            fix: "Configure analytics (google, plausible, fathom, or script) to collect feedback responses"
-          )
-        end
-
-        def analytics_configured?
-          analytics = @config["analytics"]
-          return false unless analytics.is_a?(Hash)
-
-          analytics["google"] || analytics["plausible"] || analytics["fathom"] || analytics["script"]
-        end
-      end
-    end
-  end
-end