zard 0.0.1
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 +27 -0
- data/CONTEXT.md +93 -0
- data/LICENSE +373 -0
- data/README.md +170 -0
- data/docs/adr/0001-contract-and-documentation-channels.md +13 -0
- data/docs/adr/0002-em-dash-zard-documentation-marker.md +29 -0
- data/docs/adr/0003-package-boundaries-and-rigor-lens.md +15 -0
- data/docs/agents/domain.md +15 -0
- data/docs/agents/issue-tracker.md +22 -0
- data/docs/agents/triage-labels.md +11 -0
- data/docs/supported-ruby-syntax.md +55 -0
- data/docs/usage.md +124 -0
- data/examples/catalog/expected.md +51 -0
- data/examples/catalog/lib/catalog/entry.rb +45 -0
- data/examples/catalog/lib/catalog.rb +5 -0
- data/lib/zard/model/v1.rb +111 -0
- data/lib/zard/parsing/parser.rb +1781 -0
- data/lib/zard/version.rb +5 -0
- data/lib/zard.rb +15 -0
- data/sig/zard.rbs +7 -0
- metadata +80 -0
data/lib/zard/version.rb
ADDED
data/lib/zard.rb
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
require_relative "zard/version"
|
|
4
|
+
require_relative "zard/model/v1"
|
|
5
|
+
require_relative "zard/parsing/parser"
|
|
6
|
+
|
|
7
|
+
module Zard
|
|
8
|
+
class Error < StandardError; end
|
|
9
|
+
|
|
10
|
+
def self.parse(source, path:)
|
|
11
|
+
Parsing::Parser.call(source, path: path)
|
|
12
|
+
end
|
|
13
|
+
|
|
14
|
+
private_constant :Parsing
|
|
15
|
+
end
|
data/sig/zard.rbs
ADDED
metadata
ADDED
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
|
2
|
+
name: zard
|
|
3
|
+
version: !ruby/object:Gem::Version
|
|
4
|
+
version: 0.0.1
|
|
5
|
+
platform: ruby
|
|
6
|
+
authors:
|
|
7
|
+
- USAMI Kenta
|
|
8
|
+
bindir: bin
|
|
9
|
+
cert_chain: []
|
|
10
|
+
date: 1980-01-02 00:00:00.000000000 Z
|
|
11
|
+
dependencies:
|
|
12
|
+
- !ruby/object:Gem::Dependency
|
|
13
|
+
name: prism
|
|
14
|
+
requirement: !ruby/object:Gem::Requirement
|
|
15
|
+
requirements:
|
|
16
|
+
- - "~>"
|
|
17
|
+
- !ruby/object:Gem::Version
|
|
18
|
+
version: '1.9'
|
|
19
|
+
type: :runtime
|
|
20
|
+
prerelease: false
|
|
21
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
22
|
+
requirements:
|
|
23
|
+
- - "~>"
|
|
24
|
+
- !ruby/object:Gem::Version
|
|
25
|
+
version: '1.9'
|
|
26
|
+
description: ZARD models Ruby declarations, API documentation, and RBS or Rigor contract
|
|
27
|
+
text with source provenance.
|
|
28
|
+
email:
|
|
29
|
+
- tadsan@zonu.me
|
|
30
|
+
executables: []
|
|
31
|
+
extensions: []
|
|
32
|
+
extra_rdoc_files: []
|
|
33
|
+
files:
|
|
34
|
+
- CHANGELOG.md
|
|
35
|
+
- CONTEXT.md
|
|
36
|
+
- LICENSE
|
|
37
|
+
- README.md
|
|
38
|
+
- docs/adr/0001-contract-and-documentation-channels.md
|
|
39
|
+
- docs/adr/0002-em-dash-zard-documentation-marker.md
|
|
40
|
+
- docs/adr/0003-package-boundaries-and-rigor-lens.md
|
|
41
|
+
- docs/agents/domain.md
|
|
42
|
+
- docs/agents/issue-tracker.md
|
|
43
|
+
- docs/agents/triage-labels.md
|
|
44
|
+
- docs/supported-ruby-syntax.md
|
|
45
|
+
- docs/usage.md
|
|
46
|
+
- examples/catalog/expected.md
|
|
47
|
+
- examples/catalog/lib/catalog.rb
|
|
48
|
+
- examples/catalog/lib/catalog/entry.rb
|
|
49
|
+
- lib/zard.rb
|
|
50
|
+
- lib/zard/model/v1.rb
|
|
51
|
+
- lib/zard/parsing/parser.rb
|
|
52
|
+
- lib/zard/version.rb
|
|
53
|
+
- sig/zard.rbs
|
|
54
|
+
homepage: https://github.com/rigortype/zard
|
|
55
|
+
licenses:
|
|
56
|
+
- MPL-2.0
|
|
57
|
+
metadata:
|
|
58
|
+
allowed_push_host: https://rubygems.org
|
|
59
|
+
changelog_uri: https://github.com/rigortype/zard/blob/master/CHANGELOG.md
|
|
60
|
+
homepage_uri: https://github.com/rigortype/zard
|
|
61
|
+
rubygems_mfa_required: 'true'
|
|
62
|
+
source_code_uri: https://github.com/rigortype/zard
|
|
63
|
+
rdoc_options: []
|
|
64
|
+
require_paths:
|
|
65
|
+
- lib
|
|
66
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
|
67
|
+
requirements:
|
|
68
|
+
- - ">="
|
|
69
|
+
- !ruby/object:Gem::Version
|
|
70
|
+
version: 3.2.0
|
|
71
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
72
|
+
requirements:
|
|
73
|
+
- - ">="
|
|
74
|
+
- !ruby/object:Gem::Version
|
|
75
|
+
version: '0'
|
|
76
|
+
requirements: []
|
|
77
|
+
rubygems_version: 4.0.20
|
|
78
|
+
specification_version: 4
|
|
79
|
+
summary: AI-friendly Ruby documentation built on RBS and Rigor extensions
|
|
80
|
+
test_files: []
|