mirror of
				https://gitea.invidious.io/iv-org/shard-ameba.git
				synced 2024-08-15 00:53:29 +00:00 
			
		
		
		
	Correct yaml configuration examples in docs
This commit is contained in:
		
							parent
							
								
									790b519653
								
							
						
					
					
						commit
						068733a9d3
					
				
					 28 changed files with 34 additions and 27 deletions
				
			
		| 
						 | 
				
			
			@ -4,7 +4,7 @@ module Ameba::Rule::Layout
 | 
			
		|||
  # YAML configuration example:
 | 
			
		||||
  #
 | 
			
		||||
  # ```
 | 
			
		||||
  # LineLength:
 | 
			
		||||
  # Layout/LineLength:
 | 
			
		||||
  #   Enabled: true
 | 
			
		||||
  #   MaxLength: 100
 | 
			
		||||
  # ```
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -4,7 +4,7 @@ module Ameba::Rule::Layout
 | 
			
		|||
  # YAML configuration example:
 | 
			
		||||
  #
 | 
			
		||||
  # ```
 | 
			
		||||
  # TrailingBlankLines:
 | 
			
		||||
  # Layout/TrailingBlankLines:
 | 
			
		||||
  #   Enabled: true
 | 
			
		||||
  # ```
 | 
			
		||||
  #
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -4,7 +4,7 @@ module Ameba::Rule::Layout
 | 
			
		|||
  # YAML configuration example:
 | 
			
		||||
  #
 | 
			
		||||
  # ```
 | 
			
		||||
  # TrailingWhitespace:
 | 
			
		||||
  # Layout/TrailingWhitespace:
 | 
			
		||||
  #   Enabled: true
 | 
			
		||||
  # ```
 | 
			
		||||
  #
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -16,7 +16,7 @@ module Ameba::Rule::Lint
 | 
			
		|||
  # YAML configuration example:
 | 
			
		||||
  #
 | 
			
		||||
  # ```
 | 
			
		||||
  # ComparisonToBoolean:
 | 
			
		||||
  # Lint/ComparisonToBoolean:
 | 
			
		||||
  #   Enabled: true
 | 
			
		||||
  # ```
 | 
			
		||||
  #
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -7,7 +7,7 @@ module Ameba::Rule::Lint
 | 
			
		|||
  # YAML configuration example:
 | 
			
		||||
  #
 | 
			
		||||
  # ```
 | 
			
		||||
  # DebuggerStatement:
 | 
			
		||||
  # Lint/DebuggerStatement:
 | 
			
		||||
  #   Enabled: true
 | 
			
		||||
  # ```
 | 
			
		||||
  #
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -32,6 +32,13 @@ module Ameba::Rule::Lint
 | 
			
		|||
  # end
 | 
			
		||||
  # ```
 | 
			
		||||
  #
 | 
			
		||||
  # YAML configuration example:
 | 
			
		||||
  #
 | 
			
		||||
  # ```
 | 
			
		||||
  # Lint/EmptyEnsure
 | 
			
		||||
  #   Enabled: true
 | 
			
		||||
  # ```
 | 
			
		||||
  #
 | 
			
		||||
  struct EmptyEnsure < Base
 | 
			
		||||
    properties do
 | 
			
		||||
      description "Disallows empty ensure statement"
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -24,7 +24,7 @@ module Ameba::Rule::Lint
 | 
			
		|||
  # YAML configuration example:
 | 
			
		||||
  #
 | 
			
		||||
  # ```
 | 
			
		||||
  # EmptyExpression:
 | 
			
		||||
  # Lint/EmptyExpression:
 | 
			
		||||
  #   Enabled: true
 | 
			
		||||
  # ```
 | 
			
		||||
  #
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -16,7 +16,7 @@ module Ameba::Rule::Lint
 | 
			
		|||
  # YAML configuration example:
 | 
			
		||||
  #
 | 
			
		||||
  # ```
 | 
			
		||||
  # HashDuplicatedKey:
 | 
			
		||||
  # Lint/HashDuplicatedKey:
 | 
			
		||||
  #   Enabled: true
 | 
			
		||||
  # ```
 | 
			
		||||
  #
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -16,7 +16,7 @@ module Ameba::Rule::Lint
 | 
			
		|||
  # YAML configuration example:
 | 
			
		||||
  #
 | 
			
		||||
  # ```
 | 
			
		||||
  # LiteralInCondition:
 | 
			
		||||
  # Lint/LiteralInCondition:
 | 
			
		||||
  #   Enabled: true
 | 
			
		||||
  # ```
 | 
			
		||||
  #
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -12,7 +12,7 @@ module Ameba::Rule::Lint
 | 
			
		|||
  # YAML configuration example:
 | 
			
		||||
  #
 | 
			
		||||
  # ```
 | 
			
		||||
  # LiteralInInterpolation
 | 
			
		||||
  # Lint/LiteralInInterpolation
 | 
			
		||||
  #   Enabled: true
 | 
			
		||||
  # ```
 | 
			
		||||
  #
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -18,7 +18,7 @@ module Ameba::Rule::Lint
 | 
			
		|||
  # YAML configuration example:
 | 
			
		||||
  #
 | 
			
		||||
  # ```
 | 
			
		||||
  # PercentArrays:
 | 
			
		||||
  # Lint/PercentArrays:
 | 
			
		||||
  #   Enabled: true
 | 
			
		||||
  #   StringArrayUnwantedSymbols: ',"'
 | 
			
		||||
  #   SymbolArrayUnwantedSymbols: ',:'
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -19,7 +19,7 @@ module Ameba::Rule::Lint
 | 
			
		|||
  # YAML configuration example:
 | 
			
		||||
  #
 | 
			
		||||
  # ```
 | 
			
		||||
  # RandZero:
 | 
			
		||||
  # Lint/RandZero:
 | 
			
		||||
  #   Enabled: true
 | 
			
		||||
  # ```
 | 
			
		||||
  #
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -32,7 +32,7 @@ module Ameba::Rule::Lint
 | 
			
		|||
  # YAML configuration example:
 | 
			
		||||
  #
 | 
			
		||||
  # ```
 | 
			
		||||
  # ShadowedArgument:
 | 
			
		||||
  # Lint/ShadowedArgument:
 | 
			
		||||
  #   Enabled: true
 | 
			
		||||
  # ```
 | 
			
		||||
  #
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -30,7 +30,7 @@ module Ameba::Rule::Lint
 | 
			
		|||
  # YAML configuration example:
 | 
			
		||||
  #
 | 
			
		||||
  # ```
 | 
			
		||||
  # ShadowedException:
 | 
			
		||||
  # Lint/ShadowedException:
 | 
			
		||||
  #   Enabled: true
 | 
			
		||||
  # ```
 | 
			
		||||
  #
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -27,7 +27,7 @@ module Ameba::Rule::Lint
 | 
			
		|||
  # YAML configuration example:
 | 
			
		||||
  #
 | 
			
		||||
  # ```
 | 
			
		||||
  # ShadowingOuterLocalVar:
 | 
			
		||||
  # Lint/ShadowingOuterLocalVar:
 | 
			
		||||
  #   Enabled: true
 | 
			
		||||
  # ```
 | 
			
		||||
  #
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -18,7 +18,7 @@ module Ameba::Rule::Lint
 | 
			
		|||
  # YAML configuration example:
 | 
			
		||||
  #
 | 
			
		||||
  # ```
 | 
			
		||||
  # UnusedArgument:
 | 
			
		||||
  # Lint/UnusedArgument:
 | 
			
		||||
  #   Enabled: true
 | 
			
		||||
  #   IgnoreDefs: true
 | 
			
		||||
  #   IgnoreBlocks: false
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -22,7 +22,7 @@ module Ameba::Rule::Lint
 | 
			
		|||
  # YAML configuration example:
 | 
			
		||||
  #
 | 
			
		||||
  # ```
 | 
			
		||||
  # UselessAssign:
 | 
			
		||||
  # Lint/UselessAssign:
 | 
			
		||||
  #   Enabled: true
 | 
			
		||||
  # ```
 | 
			
		||||
  #
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -27,7 +27,7 @@ module Ameba::Rule::Lint
 | 
			
		|||
  # YAML configuration example:
 | 
			
		||||
  #
 | 
			
		||||
  # ```
 | 
			
		||||
  # UselessConditionInWhen:
 | 
			
		||||
  # Lint/UselessConditionInWhen:
 | 
			
		||||
  #   Enabled: true
 | 
			
		||||
  # ```
 | 
			
		||||
  #
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -18,7 +18,7 @@ module Ameba::Rule::Style
 | 
			
		|||
  # YAML configuration example:
 | 
			
		||||
  #
 | 
			
		||||
  # ```
 | 
			
		||||
  # ConstantNames:
 | 
			
		||||
  # Style/ConstantNames:
 | 
			
		||||
  #   Enabled: true
 | 
			
		||||
  # ```
 | 
			
		||||
  #
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -22,7 +22,7 @@ module Ameba::Rule::Style
 | 
			
		|||
  # YAML configuration example:
 | 
			
		||||
  #
 | 
			
		||||
  # ```
 | 
			
		||||
  # LargeNumbers:
 | 
			
		||||
  # Style/LargeNumbers:
 | 
			
		||||
  #   Enabled: true
 | 
			
		||||
  #   IntMinDigits: 5 # i.e. integers higher than 9999
 | 
			
		||||
  # ```
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -34,7 +34,7 @@ module Ameba::Rule::Style
 | 
			
		|||
  # YAML configuration example:
 | 
			
		||||
  #
 | 
			
		||||
  # ```
 | 
			
		||||
  # MethodNames:
 | 
			
		||||
  # Style/MethodNames:
 | 
			
		||||
  #   Enabled: true
 | 
			
		||||
  # ```
 | 
			
		||||
  #
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -23,7 +23,7 @@ module Ameba::Rule::Style
 | 
			
		|||
  # YAML configuration example:
 | 
			
		||||
  #
 | 
			
		||||
  # ```
 | 
			
		||||
  # NegatedConditionsInUnless:
 | 
			
		||||
  # Style/NegatedConditionsInUnless:
 | 
			
		||||
  #   Enabled: true
 | 
			
		||||
  # ```
 | 
			
		||||
  #
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -25,7 +25,7 @@ module Ameba::Rule::Style
 | 
			
		|||
  # YAML configuration example:
 | 
			
		||||
  #
 | 
			
		||||
  # ```
 | 
			
		||||
  # PredicateName:
 | 
			
		||||
  # Style/PredicateName:
 | 
			
		||||
  #   Enabled: true
 | 
			
		||||
  # ```
 | 
			
		||||
  #
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -52,7 +52,7 @@ module Ameba::Rule::Style
 | 
			
		|||
  # YAML configuration example:
 | 
			
		||||
  #
 | 
			
		||||
  # ```
 | 
			
		||||
  # RedundantBegin:
 | 
			
		||||
  # Style/RedundantBegin:
 | 
			
		||||
  #   Enabled: true
 | 
			
		||||
  # ```
 | 
			
		||||
  #
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -48,7 +48,7 @@ module Ameba::Rule::Style
 | 
			
		|||
  # YAML configuration example:
 | 
			
		||||
  #
 | 
			
		||||
  # ```
 | 
			
		||||
  # TypeNames:
 | 
			
		||||
  # Style/TypeNames:
 | 
			
		||||
  #   Enabled: true
 | 
			
		||||
  # ```
 | 
			
		||||
  #
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -39,7 +39,7 @@ module Ameba::Rule::Style
 | 
			
		|||
  # YAML configuration example:
 | 
			
		||||
  #
 | 
			
		||||
  # ```
 | 
			
		||||
  # UnlessElse:
 | 
			
		||||
  # Style/UnlessElse:
 | 
			
		||||
  #   Enabled: true
 | 
			
		||||
  # ```
 | 
			
		||||
  #
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -27,7 +27,7 @@ module Ameba::Rule::Style
 | 
			
		|||
  # YAML configuration example:
 | 
			
		||||
  #
 | 
			
		||||
  # ```
 | 
			
		||||
  # VariableNames:
 | 
			
		||||
  # Style/VariableNames:
 | 
			
		||||
  #   Enabled: true
 | 
			
		||||
  # ```
 | 
			
		||||
  #
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -22,7 +22,7 @@ module Ameba::Rule::Style
 | 
			
		|||
  # YAML configuration example:
 | 
			
		||||
  #
 | 
			
		||||
  # ```
 | 
			
		||||
  # WhileTrue:
 | 
			
		||||
  # Style/WhileTrue:
 | 
			
		||||
  #   Enabled: true
 | 
			
		||||
  # ```
 | 
			
		||||
  #
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue