spreen-wiki 0.1.0 → 0.3.0

data/sig/generated/spreen/wiki/configuration.rbs

@@ -1,150 +0,0 @@
-# Generated from lib/spreen/wiki/configuration.rb with RBS::Inline
-
-module Spreen
-  module Wiki
-    # Resolves the runtime configuration for a wiki checkout. Every value is
-    # looked up with the same precedence: explicit keyword argument, then the
-    # `.spreen.yml` file under base_path (or config_path), then the
-    # ORGANISATION_NAME environment variable (organisation only), then the
-    # built-in defaults.
-    class Configuration
-      CONFIG_FILENAME: ::String
-
-      EMPTY_HASH: Hash[String, untyped]
-
-      DEFAULT_TEMPLATE_DIR: untyped
-
-      DEFAULT_EXCLUDED_DIRS: untyped
-
-      # Built-in labels: how the first line of a wiki page is parsed (regexp),
-      # which namespace collects pages without a declaration (no_declaration),
-      # which namespaces the count report covers (unknown_namespaces) and which
-      # namespace the LLM export targets (llm_target_namespace). A config file
-      # can override any of these, add languages or add group_by criteria.
-      DEFAULT_LABELS: untyped
-
-      attr_reader organisation: untyped
-
-      attr_reader repository: untyped
-
-      attr_reader wiki_url: untyped
-
-      attr_reader owner_base_url: untyped
-
-      attr_reader excluded_dirs: untyped
-
-      attr_reader template_dir: untyped
-
-      @organisation: String?
-
-      @repository: String?
-
-      @wiki_url: String?
-
-      @owner_base_url: String?
-
-      @excluded_dirs: Array[String]
-
-      @template_dir: String
-
-      @file: Hash[String, untyped]
-
-      @labels: Hash[String, untyped]
-
-      # @rbs base_path: String
-      # @rbs config_path: String?
-      # @rbs organisation: String?
-      # @rbs repository: String?
-      # @rbs wiki_url: String?
-      # @rbs owner_base_url: String?
-      # @rbs excluded_dirs: Array[String]?
-      # @rbs template_dir: String?
-      # @rbs return: void
-      def initialize: (base_path: String, ?config_path: String?, ?organisation: String?, ?repository: String?, ?wiki_url: String?, ?owner_base_url: String?, ?excluded_dirs: Array[String]?, ?template_dir: String?) -> void
-
-      # @rbs return: Array[String]
-      def group_bys: () -> Array[String]
-
-      # @rbs group_by: String
-      # @rbs return: Array[String]
-      def languages: (String group_by) -> Array[String]
-
-      # @rbs group_by: String
-      # @rbs return: Regexp
-      def target_regexp: (String group_by) -> Regexp
-
-      # @rbs group_by: String
-      # @rbs language: String
-      # @rbs return: String
-      def no_declaration: (String group_by, String language) -> String
-
-      # @rbs group_by: String
-      # @rbs language: String
-      # @rbs return: Array[String]
-      def unknown_namespaces: (String group_by, String language) -> Array[String]
-
-      # @rbs group_by: String
-      # @rbs language: String
-      # @rbs return: String
-      def llm_target_namespace: (String group_by, String language) -> String
-
-      # @rbs group_by: String
-      # @rbs language: String
-      # @rbs return: String
-      def path_to_template: (String group_by, String language) -> String
-
-      private
-
-      attr_reader file: untyped
-
-      attr_reader labels: untyped
-
-      # Treats empty strings the same as nil so that callers can pass values
-      # straight from optional environment variables or CLI flags.
-      # @rbs value: String?
-      # @rbs return: String?
-      def presence: (String? value) -> String?
-
-      # @rbs explicit: String?
-      # @rbs key: String
-      # @rbs return: String?
-      def resolve: (String? explicit, String key) -> String?
-
-      # @rbs explicit: String?
-      # @rbs return: String?
-      def resolve_organisation: (String? explicit) -> String?
-
-      # @rbs explicit: String?
-      # @rbs return: String?
-      def resolve_wiki_url: (String? explicit) -> String?
-
-      # @rbs explicit: String?
-      # @rbs return: String?
-      def resolve_owner_base_url: (String? explicit) -> String?
-
-      # @rbs path: String
-      # @rbs return: Hash[String, untyped]
-      def load_file: (String path) -> Hash[String, untyped]
-
-      # @rbs group_by: String
-      # @rbs return: Hash[String, untyped]
-      def label_for: (String group_by) -> Hash[String, untyped]
-
-      # @rbs group_by: String
-      # @rbs language: String
-      # @rbs return: Hash[String, untyped]
-      def language_labels: (String group_by, String language) -> Hash[String, untyped]
-
-      # @rbs return: String?
-      def default_wiki_url: () -> String?
-
-      # @rbs return: String?
-      def default_owner_base_url: () -> String?
-
-      # @rbs base: Hash[String, untyped]
-      # @rbs override: Hash[String, untyped]
-      # @rbs return: Hash[String, untyped]
-      def deep_merge: (Hash[String, untyped] base, Hash[String, untyped] override) -> Hash[String, untyped]
-    end
-  end
-end

data/sig/generated/spreen/wiki/home.rbs

@@ -1,54 +0,0 @@
-# Generated from lib/spreen/wiki/home.rb with RBS::Inline
-
-module Spreen
-  module Wiki
-    # Generates the wiki Home page, optionally splitting per-owner content out
-    # into `wikis-by-owner/<owner>.md` when home_overflow is enabled. Returns
-    # the configured wiki URL (if any) so callers can point at the result.
-    class Home < Application
-      # @rbs return: String?
-      def run: () -> String?
-
-      private
-
-      # @rbs return: String
-      def path_to_wikis_by_owner: () -> String
-
-      # @rbs return: String
-      def path_to_home_template: () -> String
-
-      # @rbs return: Array[String]
-      def home_passage: () -> Array[String]
-
-      # @rbs return: void
-      def write_home_passage: () -> void
-
-      # @rbs return: void
-      def write_concise_home_passage: () -> void
-
-      # @rbs return: void
-      def write_per_namespace_files: () -> void
-
-      # @rbs return: void
-      def write_home_table_of_contents: () -> void
-
-      # @rbs passage: Array[String]
-      # @rbs namespace: String
-      # @rbs wikis: Array[String]
-      # @rbs owned: bool
-      # @rbs return: void
-      def append_block: (Array[String] passage, String namespace, Array[String] wikis, owned: bool) -> void
-
-      # @rbs namespace: String
-      # @rbs wikis: Array[String]
-      # @rbs owned: bool
-      # @rbs return: void
-      def write_overflow_block: (String namespace, Array[String] wikis, owned: bool) -> void
-
-      # @rbs namespace: String
-      # @rbs owned: bool
-      # @rbs return: String
-      def heading_for: (String namespace, owned: bool) -> String
-    end
-  end
-end

data/sig/generated/spreen/wiki/sidebar.rbs

@@ -1,31 +0,0 @@
-# Generated from lib/spreen/wiki/sidebar.rb with RBS::Inline
-
-module Spreen
-  module Wiki
-    # Generates the wiki _Sidebar.md as a nested list of owners/categories and
-    # their wiki pages.
-    class Sidebar < Application
-      # @rbs return: void
-      def run: () -> void
-
-      private
-
-      # @rbs return: Array[String]
-      def wiki_list: () -> Array[String]
-
-      # @rbs return: void
-      def update_wiki_list: () -> void
-
-      # @rbs namespace: String
-      # @rbs wikis: Array[String]
-      # @rbs owned: bool
-      # @rbs return: void
-      def append_section: (String namespace, Array[String] wikis, owned: bool) -> void
-
-      # @rbs namespace: String
-      # @rbs owned: bool
-      # @rbs return: String
-      def section_heading: (String namespace, owned: bool) -> String
-    end
-  end
-end

data/sig/generated/spreen/wiki/unknown_wiki_count_list_exporter.rbs

@@ -1,40 +0,0 @@
-# Generated from lib/spreen/wiki/unknown_wiki_count_list_exporter.rb with RBS::Inline
-
-module Spreen
-  module Wiki
-    # Writes a sorted text report of how many wikis exist under each of the
-    # configured "unknown owner/category" namespaces.
-    class UnknownWikiCountListExporter < Application
-      DEFAULT_OUTPUT_FILENAME: ::String
-
-      # @rbs base_path: String
-      # @rbs group_by: String
-      # @rbs language: String
-      # @rbs home_overflow: (bool | String)
-      # @rbs output: String?
-      # @rbs **options: untyped
-      # @rbs return: void
-      def initialize: (?base_path: String, ?group_by: String, ?language: String, ?home_overflow: bool | String, ?output: String?, **untyped) -> void
-
-      # @rbs return: [Array[String], String]
-      def run: () -> [ Array[String], String ]
-
-      private
-
-      attr_reader path_to_export: String
-
-      # @rbs filename: String
-      # @rbs return: String
-      def resolve_output_path: (String filename) -> String
-
-      # @rbs return: Array[String]
-      def namespace_list: () -> Array[String]
-
-      # @rbs return: Array[String]
-      def missing_count_list_by_namespace: () -> Array[String]
-
-      # @rbs return: Array[String]
-      def count_list_by_namespace: () -> Array[String]
-    end
-  end
-end

data/sig/generated/spreen/wiki/unknown_wiki_list_exporter_for_llm.rbs

@@ -1,37 +0,0 @@
-# Generated from lib/spreen/wiki/unknown_wiki_list_exporter_for_llm.rb with RBS::Inline
-
-module Spreen
-  module Wiki
-    # Writes a flat list of the wikis under the configured "unknown
-    # owner/category" namespace in a form suitable for feeding to an LLM.
-    class UnknownWikiListExporterForLLM < Application
-      DEFAULT_OUTPUT_FILENAME: ::String
-
-      # @rbs base_path: String
-      # @rbs group_by: String
-      # @rbs language: String
-      # @rbs home_overflow: (bool | String)
-      # @rbs output: String?
-      # @rbs **options: untyped
-      # @rbs return: void
-      def initialize: (?base_path: String, ?group_by: String, ?language: String, ?home_overflow: bool | String, ?output: String?, **untyped) -> void
-
-      # @rbs return: String
-      def run: () -> String
-
-      private
-
-      attr_reader path_to_export: String
-
-      # @rbs filename: String
-      # @rbs return: String
-      def resolve_output_path: (String filename) -> String
-
-      # @rbs return: String
-      def target_namespace: () -> String
-
-      # @rbs return: Array[String]
-      def unknown_wiki_list_for_llm: () -> Array[String]
-    end
-  end
-end

data/sig/generated/spreen/wiki/version.rbs

@@ -1,7 +0,0 @@
-# Generated from lib/spreen/wiki/version.rb with RBS::Inline
-
-module Spreen
-  module Wiki
-    VERSION: ::String
-  end
-end

data/sig/generated/spreen/wiki.rbs

@@ -1,10 +0,0 @@
-# Generated from lib/spreen/wiki.rb with RBS::Inline
-
-module Spreen
-  # Spreens a GitHub wiki — the falcon's stoop, then the preen: generates
-  # Home.md and _Sidebar.md grouped by the Owner/Category declared on the
-  # first line of each page, and exports reports of the pages whose owner
-  # or category is unknown.
-  module Wiki
-  end
-end