Module: Yamlint::Presets

Defined in:

lib/yamlint/presets.rb,
lib/yamlint/presets/default.rb,
lib/yamlint/presets/relaxed.rb

Constant Summary

DEFAULT =

{
  rules: {
    'anchors' => { 'forbid-undeclared-aliases' => true, 'forbid-duplicated-anchors' => true,
                   'forbid-unused-anchors' => true },
    'braces' => { 'forbid' => false, 'min-spaces-inside' => 0, 'max-spaces-inside' => 0 },
    'brackets' => { 'forbid' => false, 'min-spaces-inside' => 0, 'max-spaces-inside' => 0 },
    'colons' => { 'max-spaces-before' => 0, 'max-spaces-after' => 1 },
    'commas' => { 'max-spaces-before' => 0, 'min-spaces-after' => 1, 'max-spaces-after' => 1 },
    'comments' => { 'require-starting-space' => true, 'ignore-shebangs' => true, 'min-spaces-from-content' => 2 },
    'comments-indentation' => {},
    'document-end' => 'disable',
    'document-start' => 'disable',
    'empty-lines' => { 'max' => 2, 'max-start' => 0, 'max-end' => 0 },
    'empty-values' => { 'forbid-in-block-mappings' => true, 'forbid-in-flow-mappings' => true },
    'float-values' => 'disable',
    'hyphens' => { 'max-spaces-after' => 1 },
    'indentation' => { 'spaces' => 2, 'indent-sequences' => true },
    'key-duplicates' => {},
    'key-ordering' => 'disable',
    'line-length' => { 'max' => 80, 'allow-non-breakable-words' => true,
                       'allow-non-breakable-inline-mappings' => true },
    'new-line-at-end-of-file' => {},
    'new-lines' => { 'type' => 'unix' },
    'octal-values' => { 'forbid-implicit-octal' => true, 'forbid-explicit-octal' => false },
    'quoted-strings' => 'disable',
    'trailing-spaces' => {},
    'truthy' => { 'allowed-values' => %w[true false], 'check-keys' => true }
  }
}.freeze

RELAXED =

{
  rules: {
    'anchors' => 'disable',
    'braces' => { 'forbid' => false, 'min-spaces-inside' => 0, 'max-spaces-inside' => 1 },
    'brackets' => { 'forbid' => false, 'min-spaces-inside' => 0, 'max-spaces-inside' => 1 },
    'colons' => { 'max-spaces-before' => 1, 'max-spaces-after' => 1 },
    'commas' => { 'max-spaces-before' => 1, 'min-spaces-after' => 1, 'max-spaces-after' => 1 },
    'comments' => 'disable',
    'comments-indentation' => 'disable',
    'document-end' => 'disable',
    'document-start' => 'disable',
    'empty-lines' => 'disable',
    'empty-values' => 'disable',
    'float-values' => 'disable',
    'hyphens' => 'disable',
    'indentation' => 'disable',
    'key-duplicates' => {},
    'key-ordering' => 'disable',
    'line-length' => { 'max' => 120, 'allow-non-breakable-words' => true,
                       'allow-non-breakable-inline-mappings' => true },
    'new-line-at-end-of-file' => 'disable',
    'new-lines' => { 'type' => 'unix' },
    'octal-values' => 'disable',
    'quoted-strings' => 'disable',
    'trailing-spaces' => 'disable',
    'truthy' => 'disable'
  }
}.freeze

Class Method Summary

• .get(name) ⇒ Object

Class Method Details

.get(name) ⇒ Object

# File 'lib/yamlint/presets.rb', line 8

def self.get(name)
  case name.to_s
  when 'default'
    DEFAULT
  when 'relaxed'
    RELAXED
  else
    raise ArgumentError, "Unknown preset: #{name}"
  end
end