Class: Docscribe::CLI::Formatters::Json

Inherits:
Object
  • Object
show all
Defined in:
lib/docscribe/cli/formatters/json.rb

Overview

Output formatter producing RuboCop-compatible JSON.

stdout: complete JSON document with all findings. stderr: progress markers only (same as text mode).

Constant Summary collapse

SEVERITY_MAP = 
{
  missing_param: 'convention',
  missing_return: 'convention',
  missing_raise: 'convention',
  missing_visibility: 'convention',
  missing_module_function_note: 'convention',
  insert_full_doc_block: 'convention',
  unsorted_tags: 'convention',
  updated_param: 'warning',
  updated_return: 'warning',
  invalid_type: 'warning'
}.freeze
COP_NAME_MAP = 
{
  missing_param: 'Docscribe/MissingParam',
  missing_return: 'Docscribe/MissingReturn',
  missing_raise: 'Docscribe/MissingRaise',
  missing_visibility: 'Docscribe/MissingVisibility',
  missing_module_function_note: 'Docscribe/MissingModuleFunctionNote',
  insert_full_doc_block: 'Docscribe/MissingDocBlock',
  unsorted_tags: 'Docscribe/UnsortedTags',
  updated_param: 'Docscribe/UpdatedParam',
  updated_return: 'Docscribe/UpdatedReturn',
  invalid_type: 'Docscribe/InvalidType'
}.freeze

Instance Method Summary collapse

Instance Method Details

#format_check_summary(state:, options:) ⇒ void

This method returns an undefined value.

Output JSON check summary.

Parameters:

  • state (Docscribe::CLI::Formatters::state) —

    formatter state hash

  • options (Docscribe::CLI::Formatters::opts) —

    runtime options hash



45
46
47
 
# File 'lib/docscribe/cli/formatters/json.rb', line 45

def format_check_summary(state:, options:)
  puts JSON.generate(build_document(state, options))
end

#format_write_summary(state:, options:) ⇒ void

This method returns an undefined value.

Output JSON write summary.

Parameters:

  • state (Docscribe::CLI::Formatters::state) —

    formatter state hash

  • options (Docscribe::CLI::Formatters::opts) —

    runtime options hash



54
55
56
 
# File 'lib/docscribe/cli/formatters/json.rb', line 54

def format_write_summary(state:, options:)
  puts JSON.generate(build_document(state, options))
end