jekyll-agent-audit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4b88653ad0aae082e172a8ceb319711ed790ebf7f23180a20b9b9d63c9e883ba
+  data.tar.gz: cc9c187003514356d851ad8b01f7da6df7f54b6825c56c8b76c5ed3106e8aba2
+SHA512:
+  metadata.gz: 425e7f130492105c22bcac894e31d715eda5c739ac0bc117adca57a1bdd9f28437b92263f7f4b1a8cbe8d3eafbfb954bb74604df11b39430b7cbd55e32d7a7df
+  data.tar.gz: '0034998e52a8f13bc8088e7dc9f74d9de202e5b179b309b9b065ef093129ff7add37ab54274816cc8774798c3dd4888578fdb66cff18947215c869e123ce47fe'

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+
+## [0.1.0] - Unreleased
+
+- Add an offline audit of rendered Jekyll publications.
+- Report broken local references, conflicting document identity, structural markup problems, and observable metadata contradictions.
+- Provide configurable console and JSON reports, rule selection, explanations, suppressions, and bounded resource limits.
+- Add the `jekyll agent:audit` command with isolated temporary builds and generated API documentation.

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "minitest", ">= 5"
+gem "rake"
+gem "jekyll-seo-tag", "~> 2.9"
+gem "jekyll-sitemap", "~> 1.4"
+gem "yard", "~> 0.9", require: false
+gem "yard-markdown", "~> 0.9", require: false

data/LICENSE.txt

@@ -0,0 +1,17 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   Copyright 2026 Lucian Ghinda
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,180 @@
+# jekyll-agent-audit
+
+An offline audit of rendered Jekyll publications. It finds broken local references, conflicting document identity, structural markup problems, and observable metadata contradictions. It does not predict search rankings or AI citations, score pages, rewrite content, or check deployed HTTP behavior.
+
+## Install and run
+
+Add the gem to your site's **Gemfile**, in the command-loading group:
+
+```ruby
+group :jekyll_plugins do
+  gem "jekyll-agent-audit", "~> 0.1.0"
+end
+```
+
+For an unpublished local checkout, add `path: "/path/to/jekyll-agent-audit"` to that declaration. Run `bundle install`, then:
+
+```sh
+bundle exec jekyll agent:audit
+bundle exec jekyll agent:audit --format json --output tmp/agent-audit.json
+bundle exec jekyll agent:audit --config _config.yml,_config.production.yml
+bundle exec jekyll agent:audit --fail-on warning
+bundle exec jekyll agent:audit --only links.target_missing,identity.canonical_multiple
+bundle exec jekyll agent:audit --list-rules --format json
+bundle exec jekyll agent:audit --explain identity.canonical_multiple
+```
+
+Putting the gem only under `_config.yml`'s `plugins` setting is too late for initial command discovery. See [Jekyll's command integration documentation](https://jekyllrb.com/docs/plugins/commands/).
+
+The command makes one full build in a temporary directory, with a separate temporary cache, and inspects the final output. Existing `_site` output is preserved. Build logs go to stderr; JSON stdout contains one report. `--output` writes atomically. Merely loading the gem does not audit an ordinary `jekyll build`.
+
+The analyzer performs no network requests. Your site's ordinary build plugins retain their own behavior, including any network requests or custom filesystem writes they perform. Temporary build isolation cannot constrain arbitrary third-party plugin side effects.
+
+## Findings and exit codes
+
+The default release enables these 17 rules:
+
+| Severity | Rules |
+| --- | --- |
+| Error | `architecture.output_collision`, `links.target_missing`, `links.fragment_missing`, `identity.canonical_invalid`, `identity.canonical_multiple`, `identity.canonical_target_missing`, `structure.id_duplicate`, `provenance.jsonld_invalid` |
+| Warning | `architecture.orphan`, `structure.title_missing`, `structure.heading_empty`, `structure.link_unnamed`, `provenance.date_invalid`, `provenance.date_order`, `provenance.metadata_conflict` |
+| Info | `structure.h1_absent`, `structure.heading_jump` |
+
+`--explain RULE` gives applicability, evidence, limitations, and remediation. Deferred catalog rules cannot be selected. Multiple H1s, an external canonical, no modification date, long prose, and no external citations are acceptable by themselves.
+
+| Exit | Meaning |
+| --- | --- |
+| 0 | Completed; no active findings meet the failure policy |
+| 1 | Completed; active errors, or warnings with `--fail-on warning` |
+| 2 | Invalid configuration/invocation, failed build/report write, resource limit, or incomplete supported-input analysis |
+| 130 | Interrupted by SIGINT |
+
+Default `fail_on: error` leaves warnings and info nonblocking. `none` disables finding-based failure; operational failures still return 2. A build with no HTML returns 2. Discovery always reports **not assessed**, owned by `jekyll-agent-discovery`.
+
+## Configuration
+
+These are the defaults, under `_config.yml`. CLI audit options override them after ordinary Jekyll config layering. Jekyll environment, drafts, future posts, URL, and baseurl retain the site's configuration.
+
+```yaml
+agent_audit:
+  fail_on: error
+  format: console
+  include: ["**/*"]
+  exclude: []
+  content:
+    selector: null
+    exclude_selectors: [nav, footer, aside, script, style, template]
+  metadata:
+    selectors:
+      author: null
+      publisher: null
+      published: null
+      modified: null
+  graph:
+    roots: ["/"]
+  routes:
+    directory_index: index.html
+    external_paths: []
+    aliases: {}
+  rules: {}
+  suppressions: []
+  limits:
+    max_html_bytes: 5242880
+    max_jsonld_bytes: 1048576
+    max_documents: 50000
+    max_edges: 1000000
+```
+
+Unknown options, rules, invalid CSS selectors, alias cycles, and malformed limits are rejected. Disable a rule with `rules: {structure.heading_jump: {enabled: false}}`. `--only` intersects enabled rules and cannot re-enable one.
+
+Include/exclude patterns match source-relative paths using Ruby `File.fnmatch?` pathname/glob semantics; exclusion wins. Excluded pages still supply links and targets to the graph. Generated HTML is included with a stable generated identity and a null source path when no source mapping is known.
+
+Graph roots are site-relative: `/` becomes `/project/` when `baseurl: /project`. Roots must exist. Route aliases and `external_paths` use full public paths, including baseurl. For example:
+
+```yaml
+agent_audit:
+  routes:
+    external_paths: ["/project/api/**"]
+    aliases:
+      /project/old-guide/: /project/guide/
+```
+
+These declarations describe hosting assumptions; they do not create or verify redirects. Assets are valid local targets. Directory-index aliases are proven by the emitted index file; `/guide` is not automatically equivalent to `/guide/`. Query strings stay in observations while target existence uses the path.
+
+Content selection uses page `agent_audit.content.selector`, site selector, unique `main`, unique main-role landmark, then unique `article`. Body fallback supports whole-document checks and skips content-sensitive headings. Ambiguous selectors produce coverage diagnostics. Metadata date selectors read machine `datetime` attributes, never free-form prose.
+
+## Suppressions
+
+Suppressions retain findings in JSON and require a reason. Site suppressions require source path scope and may specify a fingerprint. `until` is inclusive in the report's UTC reference date.
+
+```yaml
+agent_audit:
+  suppressions:
+    - rule: architecture.orphan
+      paths: ["landing/private-preview.md"]
+      reason: "Linked only from a customer email."
+      until: "2026-12-31"
+```
+
+Page front matter can use:
+
+```yaml
+agent_audit:
+  suppress:
+    - rule: structure.h1_absent
+      reason: "The layout renders the title outside main."
+```
+
+Expired suppressions do not hide findings. Unused suppressions generate notices. Collisions require a site suppression with primary-owner scope and a fingerprint. Disabling a rule appears as disabled coverage, never a clean result.
+
+## Reports and interpretation
+
+Console and JSON share one report. The [JSON schema](schema/report-1.0.json) is versioned `1.0`; consumers should tolerate additive fields and use rule IDs instead of parsing message text. Findings preserve evidence level, observation, rendered location, related locations, remediation, fingerprint, and suppression. Source lines are null unless an actual source mapping exists; rendered HTML lines are not Markdown source lines.
+
+The [example JSON report](docs/example-report.json) was generated by a fixture with a broken local link, no H1, and an explicit modification date preceding publication.
+
+Fingerprints exclude line numbers, temporary paths, message wording, and timestamps. Findings and coverage are deterministically ordered; run clocks and timings are volatile. Reports contain bounded observations, not article bodies. They can still reveal unpublished paths, so choose artifact access and retention accordingly.
+
+For every rule, `candidate = evaluated + not_applicable + skipped`. Evaluated includes clean and finding-producing applications. Suppressing a finding does not change coverage. Counts describe local observations; there is no quality percentage.
+
+## Development and release status
+
+```sh
+bundle install
+bundle exec rake test
+bundle exec rake lint
+gem build jekyll-agent-audit.gemspec
+ruby script/benchmark.rb
+```
+
+
+### Generated documentation
+
+Generate Markdown API documentation and the LLM index from the Ruby source:
+
+```sh
+bundle exec rake docs
+```
+
+This replaces `doc/` with fresh YARD Markdown, updates the documentation index in
+`doc/Jekyll/AgentAudit.md`, and writes `llms.txt` with links relative to the gem
+root. Both namespaces are indexed: the library under `Jekyll::AgentAudit` and the
+Jekyll subcommand under `Jekyll::Commands::AgentAudit`. The generated files are
+checked in and shipped with the gem; `yard` and `yard-markdown` stay development
+dependencies. Authored guides belong in `docs/`, not the generated `doc/`.
+
+For the individual steps, run `bundle exec rake yard`, then
+`ruby bin/generate_llm.rb`.
+
+To verify everything, regenerate documentation, and build the versioned gem and
+SHA-256 checksum in `pkg/`, run:
+
+```sh
+bin/prepare_release
+```
+
+It stops at the first failure and never commits, tags, pushes, or publishes.
+
+The implementation targets Jekyll 4.4.x. See [verification and compatibility](docs/verification.md) for combinations actually tested and benchmark measurements. Do not infer native GitHub Pages compatibility. The runtime HTML parser is explicitly declared as Nokogiri; no optional SEO, sitemap, or Markdown plugin is required.
+
+See [limitations and evidence](docs/limitations.md) before interpreting findings. The design specification in the parent workspace is the normative MVP catalog; deferred editorial and duplication analyses are not enabled.

data/Rakefile

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "fileutils"
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "rbconfig"
+require "open3"
+require "yard"
+
+ROOT = File.expand_path(__dir__)
+
+Rake::TestTask.new do |task|
+  task.libs << "lib" << "test"
+  task.pattern = "test/**/*_test.rb"
+  task.warning = true
+end
+
+desc "Check Ruby syntax and compiler warnings in gem code, tests, and scripts"
+task :lint do
+  files = Dir["{lib,test,script}/**/*.rb", "bin/*", "*.gemspec", "Gemfile", "Rakefile"].select { |file| File.file?(file) }.sort
+  problems = files.filter_map do |file|
+    stdout, stderr, status = Open3.capture3(RbConfig.ruby, "-cw", file)
+    "#{file}:\n#{stdout}#{stderr}" unless status.success? && stderr.empty?
+  end
+  abort problems.join("\n") unless problems.empty?
+  puts "Syntax and compiler warnings: #{files.length} Ruby files checked."
+end
+
+YARD::Rake::YardocTask.new do |task|
+  task.before = -> { FileUtils.rm_rf(File.join(ROOT, "doc")) }
+end
+
+desc "Generate Markdown API documentation and the LLM index"
+task docs: :yard do
+  sh RbConfig.ruby, File.join(ROOT, "bin/generate_llm.rb")
+end
+
+task default: %i[test lint]

data/doc/Jekyll/AgentAudit/BuildInventory.md

@@ -0,0 +1,29 @@
+# Class Jekyll::AgentAudit::BuildInventory <a id="class-Jekyll-AgentAudit-BuildInventory"></a>
+
+|  |  |
+| --- | --- |
+| **Inherits** | Object |
+| **Defined in** | lib/jekyll/agent_audit/build_inventory.rb |
+
+## Attributes
+### `collisions` [R] <a id="attribute-i-collisions"></a> <a id="collisions-instance_method"></a>
+Returns the value of attribute collisions.
+
+### `diagnostics` [R] <a id="attribute-i-diagnostics"></a> <a id="diagnostics-instance_method"></a>
+Returns the value of attribute diagnostics.
+
+### `entries` [R] <a id="attribute-i-entries"></a> <a id="entries-instance_method"></a>
+Returns the value of attribute entries.
+
+## Public Instance Methods
+### `capture!()` <a id="method-i-capture-21"></a> <a id="capture!-instance_method"></a>
+Not documented.
+
+### `complete?()` <a id="method-i-complete-3F"></a> <a id="complete?-instance_method"></a>
+- **@return** [Boolean]
+
+### `finalize!()` <a id="method-i-finalize-21"></a> <a id="finalize!-instance_method"></a>
+Not documented.
+
+### `initialize(site, configuration)` <a id="method-i-initialize"></a> <a id="initialize-instance_method"></a>
+- **@return** [BuildInventory] a new instance of BuildInventory

data/doc/Jekyll/AgentAudit/Configuration.md

@@ -0,0 +1,42 @@
+# Class Jekyll::AgentAudit::Configuration <a id="class-Jekyll-AgentAudit-Configuration"></a>
+
+|  |  |
+| --- | --- |
+| **Inherits** | Object |
+| **Defined in** | lib/jekyll/agent_audit/configuration.rb |
+
+## Constants
+### `DEFAULTS` <a id="constant-DEFAULTS"></a> <a id="DEFAULTS-constant"></a>
+Not documented.
+
+### `LIMITS` <a id="constant-LIMITS"></a> <a id="LIMITS-constant"></a>
+Not documented.
+
+### `TOP_KEYS` <a id="constant-TOP_KEYS"></a> <a id="TOP_KEYS-constant"></a>
+Not documented.
+
+## Attributes
+### `raw` [R] <a id="attribute-i-raw"></a> <a id="raw-instance_method"></a>
+Returns the value of attribute raw.
+
+## Public Instance Methods
+### `[] (key)` <a id="method-i--5B-5D"></a> <a id="[]-instance_method"></a>
+Not documented.
+
+### `enabled_rules()` <a id="method-i-enabled_rules"></a> <a id="enabled_rules-instance_method"></a>
+Not documented.
+
+### `expired_suppressions(now: = Date.today)` <a id="method-i-expired_suppressions"></a> <a id="expired_suppressions-instance_method"></a>
+Not documented.
+
+### `initialize(raw_namespace = {}, overrides = {})` <a id="method-i-initialize"></a> <a id="initialize-instance_method"></a>
+- **@return** [Configuration] a new instance of Configuration
+
+### `selected?(source_path)` <a id="method-i-selected-3F"></a> <a id="selected?-instance_method"></a>
+- **@return** [Boolean]
+
+### `suppression_for(rule_id, source_path: = nil, fingerprint: = nil, now: = Date.today)` <a id="method-i-suppression_for"></a> <a id="suppression_for-instance_method"></a>
+Not documented.
+
+### `to_h()` <a id="method-i-to_h"></a> <a id="to_h-instance_method"></a>
+Not documented.

data/doc/Jekyll/AgentAudit/ConfigurationError.md

@@ -0,0 +1,6 @@
+# Class Jekyll::AgentAudit::ConfigurationError <a id="class-Jekyll-AgentAudit-ConfigurationError"></a>
+
+|  |  |
+| --- | --- |
+| **Inherits** | [Jekyll::AgentAudit::Error](Error.md) |
+| **Defined in** | lib/jekyll/agent_audit/errors.rb |

data/doc/Jekyll/AgentAudit/Error.md

@@ -0,0 +1,6 @@
+# Class Jekyll::AgentAudit::Error <a id="class-Jekyll-AgentAudit-Error"></a>
+
+|  |  |
+| --- | --- |
+| **Inherits** | StandardError |
+| **Defined in** | lib/jekyll/agent_audit/errors.rb |

data/doc/Jekyll/AgentAudit/Extractor.md

@@ -0,0 +1,20 @@
+# Class Jekyll::AgentAudit::Extractor <a id="class-Jekyll-AgentAudit-Extractor"></a>
+
+|  |  |
+| --- | --- |
+| **Inherits** | Object |
+| **Defined in** | lib/jekyll/agent_audit/extractor.rb |
+
+## Constants
+### `MAX_EXCERPT_BYTES` <a id="constant-MAX_EXCERPT_BYTES"></a> <a id="MAX_EXCERPT_BYTES-constant"></a>
+Not documented.
+
+### `MAX_NAME_BYTES` <a id="constant-MAX_NAME_BYTES"></a> <a id="MAX_NAME_BYTES-constant"></a>
+Not documented.
+
+## Public Instance Methods
+### `extract(entry)` <a id="method-i-extract"></a> <a id="extract-instance_method"></a>
+Not documented.
+
+### `initialize(configuration)` <a id="method-i-initialize"></a> <a id="initialize-instance_method"></a>
+- **@return** [Extractor] a new instance of Extractor

data/doc/Jekyll/AgentAudit/Finding.md

@@ -0,0 +1,30 @@
+# Class Jekyll::AgentAudit::Finding <a id="class-Jekyll-AgentAudit-Finding"></a>
+
+|  |  |
+| --- | --- |
+| **Inherits** | Object |
+| **Defined in** | lib/jekyll/agent_audit/finding.rb |
+
+## Constants
+### `SEVERITY_ORDER` <a id="constant-SEVERITY_ORDER"></a> <a id="SEVERITY_ORDER-constant"></a>
+Not documented.
+
+## Attributes
+### `data` [R] <a id="attribute-i-data"></a> <a id="data-instance_method"></a>
+Returns the value of attribute data.
+
+## Public Instance Methods
+### `[] (key)` <a id="method-i--5B-5D"></a> <a id="[]-instance_method"></a>
+Not documented.
+
+### `initialize(draft = nil, registry: = Registry, **attributes)` <a id="method-i-initialize"></a> <a id="initialize-instance_method"></a>
+- **@return** [Finding] a new instance of Finding
+
+### `severity_rank()` <a id="method-i-severity_rank"></a> <a id="severity_rank-instance_method"></a>
+Not documented.
+
+### `suppressed?()` <a id="method-i-suppressed-3F"></a> <a id="suppressed?-instance_method"></a>
+- **@return** [Boolean]
+
+### `to_h()` <a id="method-i-to_h"></a> <a id="to_h-instance_method"></a>
+Not documented.

data/doc/Jekyll/AgentAudit/InputError.md

@@ -0,0 +1,6 @@
+# Class Jekyll::AgentAudit::InputError <a id="class-Jekyll-AgentAudit-InputError"></a>
+
+|  |  |
+| --- | --- |
+| **Inherits** | StandardError |
+| **Defined in** | lib/jekyll/agent_audit/errors.rb, lib/jekyll/agent_audit/extractor.rb |

data/doc/Jekyll/AgentAudit/LinkGraph.md

@@ -0,0 +1,26 @@
+# Class Jekyll::AgentAudit::LinkGraph <a id="class-Jekyll-AgentAudit-LinkGraph"></a>
+
+|  |  |
+| --- | --- |
+| **Inherits** | Object |
+| **Defined in** | lib/jekyll/agent_audit/link_graph.rb |
+
+## Attributes
+### `diagnostics` [R] <a id="attribute-i-diagnostics"></a> <a id="diagnostics-instance_method"></a>
+Returns the value of attribute diagnostics.
+
+## Public Instance Methods
+### `edges()` <a id="method-i-edges"></a> <a id="edges-instance_method"></a>
+Not documented.
+
+### `edges_for(document)` <a id="method-i-edges_for"></a> <a id="edges_for-instance_method"></a>
+Not documented.
+
+### `incoming(document)` <a id="method-i-incoming"></a> <a id="incoming-instance_method"></a>
+Not documented.
+
+### `initialize(documents, resolver, configuration, site_config = {})` <a id="method-i-initialize"></a> <a id="initialize-instance_method"></a>
+- **@return** [LinkGraph] a new instance of LinkGraph
+
+### `reachable()` <a id="method-i-reachable"></a> <a id="reachable-instance_method"></a>
+Not documented.

data/doc/Jekyll/AgentAudit/Registry.md

@@ -0,0 +1,38 @@
+# Module Jekyll::AgentAudit::Registry <a id="module-Jekyll-AgentAudit-Registry"></a>
+
+|  |  |
+| --- | --- |
+| **Defined in** | lib/jekyll/agent_audit/registry.rb |
+
+## Constants
+### `DEFERRED_RULES` <a id="constant-DEFERRED_RULES"></a> <a id="DEFERRED_RULES-constant"></a>
+Not documented.
+
+### `DETAILS` <a id="constant-DETAILS"></a> <a id="DETAILS-constant"></a>
+category, evidence, severity, source keys, applicability, required inputs, limitations, remediation
+:
+
+### `MVP_RULES` <a id="constant-MVP_RULES"></a> <a id="MVP_RULES-constant"></a>
+Not documented.
+
+### `SEVERITIES` <a id="constant-SEVERITIES"></a> <a id="SEVERITIES-constant"></a>
+Not documented.
+
+### `SOURCE_URLS` <a id="constant-SOURCE_URLS"></a> <a id="SOURCE_URLS-constant"></a>
+Not documented.
+
+## Public Class Methods
+### `[] (id)` <a id="method-c--5B-5D"></a> <a id="[]-class_method"></a>
+Not documented.
+
+### `all()` <a id="method-c-all"></a> <a id="all-class_method"></a>
+Not documented.
+
+### `deferred?(id)` <a id="method-c-deferred-3F"></a> <a id="deferred?-class_method"></a>
+- **@return** [Boolean]
+
+### `known?(id)` <a id="method-c-known-3F"></a> <a id="known?-class_method"></a>
+- **@return** [Boolean]
+
+### `mvp_ids()` <a id="method-c-mvp_ids"></a> <a id="mvp_ids-class_method"></a>
+Not documented.

data/doc/Jekyll/AgentAudit/Report.md

@@ -0,0 +1,27 @@
+# Class Jekyll::AgentAudit::Report <a id="class-Jekyll-AgentAudit-Report"></a>
+
+|  |  |
+| --- | --- |
+| **Inherits** | Object |
+| **Defined in** | lib/jekyll/agent_audit/report.rb |
+
+## Constants
+### `SCHEMA_VERSION` <a id="constant-SCHEMA_VERSION"></a> <a id="SCHEMA_VERSION-constant"></a>
+Not documented.
+
+## Attributes
+### `data` [R] <a id="attribute-i-data"></a> <a id="data-instance_method"></a>
+Returns the value of attribute data.
+
+## Public Instance Methods
+### `exit_code()` <a id="method-i-exit_code"></a> <a id="exit_code-instance_method"></a>
+Not documented.
+
+### `findings()` <a id="method-i-findings"></a> <a id="findings-instance_method"></a>
+Not documented.
+
+### `initialize(findings: = [], coverage: = {}, diagnostics: = [], documents_inspected: = 0, options: = {}, site_config: = {}, complete: = true, reference_time: = Time.now.utc, operational_error: = false, effective_configuration: = nil, build: = nil)` <a id="method-i-initialize"></a> <a id="initialize-instance_method"></a>
+- **@return** [Report] a new instance of Report
+
+### `to_h()` <a id="method-i-to_h"></a> <a id="to_h-instance_method"></a>
+Not documented.

data/doc/Jekyll/AgentAudit/ReportError.md

@@ -0,0 +1,6 @@
+# Class Jekyll::AgentAudit::ReportError <a id="class-Jekyll-AgentAudit-ReportError"></a>
+
+|  |  |
+| --- | --- |
+| **Inherits** | [Jekyll::AgentAudit::Error](Error.md) |
+| **Defined in** | lib/jekyll/agent_audit/errors.rb |

data/doc/Jekyll/AgentAudit/Reporters/Console.md

@@ -0,0 +1,19 @@
+# Module Jekyll::AgentAudit::Reporters::Console <a id="module-Jekyll-AgentAudit-Reporters-Console"></a>
+
+|  |  |
+| --- | --- |
+| **Defined in** | lib/jekyll/agent_audit/reporters/console.rb |
+
+## Constants
+### `MAX_VALUE_LENGTH` <a id="constant-MAX_VALUE_LENGTH"></a> <a id="MAX_VALUE_LENGTH-constant"></a>
+Not documented.
+
+### `SEVERITIES` <a id="constant-SEVERITIES"></a> <a id="SEVERITIES-constant"></a>
+Not documented.
+
+## Public Class Methods
+### `render(report, verbose: = false)` <a id="method-c-render"></a> <a id="render-class_method"></a>
+Not documented.
+
+### `result_line(report, data)` <a id="method-c-result_line"></a> <a id="result_line-class_method"></a>
+Not documented.

data/doc/Jekyll/AgentAudit/Reporters/JSON.md

@@ -0,0 +1,9 @@
+# Module Jekyll::AgentAudit::Reporters::JSON <a id="module-Jekyll-AgentAudit-Reporters-JSON"></a>
+
+|  |  |
+| --- | --- |
+| **Defined in** | lib/jekyll/agent_audit/reporters/json.rb |
+
+## Public Class Methods
+### `render(report)` <a id="method-c-render"></a> <a id="render-class_method"></a>
+Not documented.

data/doc/Jekyll/AgentAudit/Reporters.md

@@ -0,0 +1,5 @@
+# Module Jekyll::AgentAudit::Reporters <a id="module-Jekyll-AgentAudit-Reporters"></a>
+
+|  |  |
+| --- | --- |
+| **Defined in** | lib/jekyll/agent_audit/reporters/json.rb, lib/jekyll/agent_audit/reporters/console.rb |