chiridion 0.3.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/CHANGELOG.md +25 -0
- data/LICENSE.txt +21 -0
- data/README.md +201 -0
- data/lib/chiridion/config.rb +128 -0
- data/lib/chiridion/engine/class_linker.rb +204 -0
- data/lib/chiridion/engine/document_model.rb +299 -0
- data/lib/chiridion/engine/drift_checker.rb +146 -0
- data/lib/chiridion/engine/extractor.rb +311 -0
- data/lib/chiridion/engine/file_renderer.rb +717 -0
- data/lib/chiridion/engine/file_writer.rb +160 -0
- data/lib/chiridion/engine/frontmatter_builder.rb +248 -0
- data/lib/chiridion/engine/generated_rbs_loader.rb +344 -0
- data/lib/chiridion/engine/github_linker.rb +87 -0
- data/lib/chiridion/engine/inline_rbs_loader.rb +207 -0
- data/lib/chiridion/engine/post_processor.rb +86 -0
- data/lib/chiridion/engine/rbs_loader.rb +150 -0
- data/lib/chiridion/engine/rbs_type_alias_loader.rb +116 -0
- data/lib/chiridion/engine/renderer.rb +598 -0
- data/lib/chiridion/engine/semantic_extractor.rb +740 -0
- data/lib/chiridion/engine/semantic_renderer.rb +334 -0
- data/lib/chiridion/engine/spec_example_loader.rb +84 -0
- data/lib/chiridion/engine/template_renderer.rb +275 -0
- data/lib/chiridion/engine/type_merger.rb +126 -0
- data/lib/chiridion/engine/writer.rb +134 -0
- data/lib/chiridion/engine.rb +359 -0
- data/lib/chiridion/semantic_engine.rb +186 -0
- data/lib/chiridion/version.rb +5 -0
- data/lib/chiridion.rb +106 -0
- data/templates/constants.liquid +27 -0
- data/templates/document.liquid +48 -0
- data/templates/file.liquid +108 -0
- data/templates/index.liquid +21 -0
- data/templates/method.liquid +43 -0
- data/templates/methods.liquid +11 -0
- data/templates/type_aliases.liquid +26 -0
- data/templates/types.liquid +11 -0
- metadata +146 -0
metadata
ADDED
|
@@ -0,0 +1,146 @@
|
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
|
2
|
+
name: chiridion
|
|
3
|
+
version: !ruby/object:Gem::Version
|
|
4
|
+
version: 0.3.4
|
|
5
|
+
platform: ruby
|
|
6
|
+
authors:
|
|
7
|
+
- Joseph Wecker
|
|
8
|
+
bindir: exe
|
|
9
|
+
cert_chain: []
|
|
10
|
+
date: 1980-01-02 00:00:00.000000000 Z
|
|
11
|
+
dependencies:
|
|
12
|
+
- !ruby/object:Gem::Dependency
|
|
13
|
+
name: liquid
|
|
14
|
+
requirement: !ruby/object:Gem::Requirement
|
|
15
|
+
requirements:
|
|
16
|
+
- - "~>"
|
|
17
|
+
- !ruby/object:Gem::Version
|
|
18
|
+
version: '5.5'
|
|
19
|
+
type: :runtime
|
|
20
|
+
prerelease: false
|
|
21
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
22
|
+
requirements:
|
|
23
|
+
- - "~>"
|
|
24
|
+
- !ruby/object:Gem::Version
|
|
25
|
+
version: '5.5'
|
|
26
|
+
- !ruby/object:Gem::Dependency
|
|
27
|
+
name: yard
|
|
28
|
+
requirement: !ruby/object:Gem::Requirement
|
|
29
|
+
requirements:
|
|
30
|
+
- - "~>"
|
|
31
|
+
- !ruby/object:Gem::Version
|
|
32
|
+
version: '0.9'
|
|
33
|
+
type: :runtime
|
|
34
|
+
prerelease: false
|
|
35
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
36
|
+
requirements:
|
|
37
|
+
- - "~>"
|
|
38
|
+
- !ruby/object:Gem::Version
|
|
39
|
+
version: '0.9'
|
|
40
|
+
- !ruby/object:Gem::Dependency
|
|
41
|
+
name: logger
|
|
42
|
+
requirement: !ruby/object:Gem::Requirement
|
|
43
|
+
requirements:
|
|
44
|
+
- - ">="
|
|
45
|
+
- !ruby/object:Gem::Version
|
|
46
|
+
version: '0'
|
|
47
|
+
type: :runtime
|
|
48
|
+
prerelease: false
|
|
49
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
50
|
+
requirements:
|
|
51
|
+
- - ">="
|
|
52
|
+
- !ruby/object:Gem::Version
|
|
53
|
+
version: '0'
|
|
54
|
+
- !ruby/object:Gem::Dependency
|
|
55
|
+
name: base64
|
|
56
|
+
requirement: !ruby/object:Gem::Requirement
|
|
57
|
+
requirements:
|
|
58
|
+
- - ">="
|
|
59
|
+
- !ruby/object:Gem::Version
|
|
60
|
+
version: '0'
|
|
61
|
+
type: :runtime
|
|
62
|
+
prerelease: false
|
|
63
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
64
|
+
requirements:
|
|
65
|
+
- - ">="
|
|
66
|
+
- !ruby/object:Gem::Version
|
|
67
|
+
version: '0'
|
|
68
|
+
description: |
|
|
69
|
+
Chiridion generates documentation optimized for AI agents and LLMs working with
|
|
70
|
+
Ruby codebases. It extracts documentation from YARD comments, merges RBS type
|
|
71
|
+
signatures, and produces structured markdown suitable for context injection.
|
|
72
|
+
|
|
73
|
+
Features:
|
|
74
|
+
- YARD-based documentation extraction
|
|
75
|
+
- RBS type signature integration (RBS is authoritative)
|
|
76
|
+
- RSpec example extraction
|
|
77
|
+
- Obsidian-compatible wikilinks for cross-references
|
|
78
|
+
- Drift detection for CI/CD pipelines
|
|
79
|
+
- toys/dx CLI task definitions
|
|
80
|
+
email:
|
|
81
|
+
- joseph.wecker@gmail.com
|
|
82
|
+
executables: []
|
|
83
|
+
extensions: []
|
|
84
|
+
extra_rdoc_files: []
|
|
85
|
+
files:
|
|
86
|
+
- CHANGELOG.md
|
|
87
|
+
- LICENSE.txt
|
|
88
|
+
- README.md
|
|
89
|
+
- lib/chiridion.rb
|
|
90
|
+
- lib/chiridion/config.rb
|
|
91
|
+
- lib/chiridion/engine.rb
|
|
92
|
+
- lib/chiridion/engine/class_linker.rb
|
|
93
|
+
- lib/chiridion/engine/document_model.rb
|
|
94
|
+
- lib/chiridion/engine/drift_checker.rb
|
|
95
|
+
- lib/chiridion/engine/extractor.rb
|
|
96
|
+
- lib/chiridion/engine/file_renderer.rb
|
|
97
|
+
- lib/chiridion/engine/file_writer.rb
|
|
98
|
+
- lib/chiridion/engine/frontmatter_builder.rb
|
|
99
|
+
- lib/chiridion/engine/generated_rbs_loader.rb
|
|
100
|
+
- lib/chiridion/engine/github_linker.rb
|
|
101
|
+
- lib/chiridion/engine/inline_rbs_loader.rb
|
|
102
|
+
- lib/chiridion/engine/post_processor.rb
|
|
103
|
+
- lib/chiridion/engine/rbs_loader.rb
|
|
104
|
+
- lib/chiridion/engine/rbs_type_alias_loader.rb
|
|
105
|
+
- lib/chiridion/engine/renderer.rb
|
|
106
|
+
- lib/chiridion/engine/semantic_extractor.rb
|
|
107
|
+
- lib/chiridion/engine/semantic_renderer.rb
|
|
108
|
+
- lib/chiridion/engine/spec_example_loader.rb
|
|
109
|
+
- lib/chiridion/engine/template_renderer.rb
|
|
110
|
+
- lib/chiridion/engine/type_merger.rb
|
|
111
|
+
- lib/chiridion/engine/writer.rb
|
|
112
|
+
- lib/chiridion/semantic_engine.rb
|
|
113
|
+
- lib/chiridion/version.rb
|
|
114
|
+
- templates/constants.liquid
|
|
115
|
+
- templates/document.liquid
|
|
116
|
+
- templates/file.liquid
|
|
117
|
+
- templates/index.liquid
|
|
118
|
+
- templates/method.liquid
|
|
119
|
+
- templates/methods.liquid
|
|
120
|
+
- templates/type_aliases.liquid
|
|
121
|
+
- templates/types.liquid
|
|
122
|
+
homepage: https://github.com/v2-io/chiridion
|
|
123
|
+
licenses:
|
|
124
|
+
- MIT
|
|
125
|
+
metadata:
|
|
126
|
+
homepage_uri: https://github.com/v2-io/chiridion
|
|
127
|
+
source_code_uri: https://github.com/v2-io/chiridion
|
|
128
|
+
rubygems_mfa_required: 'true'
|
|
129
|
+
rdoc_options: []
|
|
130
|
+
require_paths:
|
|
131
|
+
- lib
|
|
132
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
|
133
|
+
requirements:
|
|
134
|
+
- - ">="
|
|
135
|
+
- !ruby/object:Gem::Version
|
|
136
|
+
version: '3.3'
|
|
137
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
138
|
+
requirements:
|
|
139
|
+
- - ">="
|
|
140
|
+
- !ruby/object:Gem::Version
|
|
141
|
+
version: '0'
|
|
142
|
+
requirements: []
|
|
143
|
+
rubygems_version: 4.0.3
|
|
144
|
+
specification_version: 4
|
|
145
|
+
summary: Agent-oriented documentation generator for Ruby projects
|
|
146
|
+
test_files: []
|