feat: add "type" property to rules (#179)

DopustimVladimir · web-flow · commit 85f38a21b7bf · 2021-11-07T20:57:49.000+05:30
diff --git a/src/rules/arrow_spacing.coffee b/src/rules/arrow_spacing.coffee
@@ -1,6 +1,7 @@
 module.exports = class ArrowSpacing
 
     rule:
+        type: 'style'
         name: 'arrow_spacing'
         level: 'ignore'
         message: 'Function arrows (-> and =>) must be spaced properly'
diff --git a/src/rules/braces_spacing.coffee b/src/rules/braces_spacing.coffee
@@ -1,6 +1,7 @@
 module.exports = class BracesSpacing
 
     rule:
+        type: 'style'
         name: 'braces_spacing'
         level: 'ignore'
         spaces: 0
diff --git a/src/rules/bracket_spacing.coffee b/src/rules/bracket_spacing.coffee
@@ -1,6 +1,7 @@
 module.exports = class BracketSpacing
 
     rule:
+        type: 'style'
         name: 'bracket_spacing'
         level: 'ignore'
         spaces: 0
diff --git a/src/rules/camel_case_classes.coffee b/src/rules/camel_case_classes.coffee
@@ -4,6 +4,7 @@ regexes =
 module.exports = class CamelCaseClasses
 
     rule:
+        type: 'style'
         name: 'camel_case_classes'
         level: 'error'
         message: 'Class name should be UpperCamelCased'
diff --git a/src/rules/colon_assignment_spacing.coffee b/src/rules/colon_assignment_spacing.coffee
@@ -1,5 +1,6 @@
 module.exports = class ColonAssignmentSpacing
     rule:
+        type: 'style'
         name: 'colon_assignment_spacing'
         level: 'ignore'
         message: 'Colon assignment without proper spacing'
diff --git a/src/rules/cyclomatic_complexity.coffee b/src/rules/cyclomatic_complexity.coffee
@@ -1,6 +1,7 @@
 module.exports = class CyclomaticComplexity
 
     rule:
+        type: 'problem'
         name: 'cyclomatic_complexity'
         level: 'ignore'
         message: 'The cyclomatic complexity is too damn high'
diff --git a/src/rules/duplicate_key.coffee b/src/rules/duplicate_key.coffee
@@ -5,6 +5,7 @@ module.exports = class DuplicateKey
         # object. It seems to always be a mistake, it's also a syntax error in
         # strict mode.
         # See https://jslinterrors.com/duplicate-key-a/
+        type: 'problem'
         name: 'duplicate_key'
         level: 'error'
         message: 'Duplicate key defined in object or class'
diff --git a/src/rules/empty_constructor_needs_parens.coffee b/src/rules/empty_constructor_needs_parens.coffee
@@ -1,6 +1,7 @@
 module.exports = class EmptyConstructorNeedsParens
 
     rule:
+        type: 'style'
         name: 'empty_constructor_needs_parens'
         level: 'ignore'
         message: 'Invoking a constructor without parens and without arguments'
diff --git a/src/rules/ensure_comprehensions.coffee b/src/rules/ensure_comprehensions.coffee
@@ -1,6 +1,7 @@
 module.exports = class EnsureComprehensions
 
     rule:
+        type: 'style'
         name: 'ensure_comprehensions'
         level: 'warn'
         message: 'Comprehensions must have parentheses around them'
diff --git a/src/rules/eol_last.coffee b/src/rules/eol_last.coffee
@@ -1,6 +1,7 @@
 module.exports = class EOLLast
 
     rule:
+        type: 'style'
         name: 'eol_last'
         level: 'ignore'
         message: 'File does not end with a single newline'
diff --git a/src/rules/indentation.coffee b/src/rules/indentation.coffee
@@ -1,6 +1,7 @@
 module.exports = class Indentation
 
     rule:
+        type: 'problem'
         name: 'indentation'
         value: 2
         level: 'error'
diff --git a/src/rules/line_endings.coffee b/src/rules/line_endings.coffee
@@ -1,6 +1,7 @@
 module.exports = class LineEndings
 
     rule:
+        type: 'problem'
         name: 'line_endings'
         level: 'ignore'
         value: 'unix' # or 'windows'
diff --git a/src/rules/max_line_length.coffee b/src/rules/max_line_length.coffee
@@ -12,6 +12,7 @@ regexes =
 module.exports = class MaxLineLength
 
     rule:
+        type: 'style'
         name: 'max_line_length'
         value: 80
         level: 'error'
diff --git a/src/rules/missing_fat_arrows.coffee b/src/rules/missing_fat_arrows.coffee
@@ -13,6 +13,7 @@ containsButIsnt = (node, nIsThis, nIsClass) ->
 module.exports = class MissingFatArrows
 
     rule:
+        type: 'problem'
         name: 'missing_fat_arrows'
         level: 'ignore'
         is_strict: false
diff --git a/src/rules/missing_parseint_radix.coffee b/src/rules/missing_parseint_radix.coffee
@@ -1,6 +1,7 @@
 module.exports = class ParseintRadix
 
     rule:
+        type: 'problem'
         name: 'missing_parseint_radix'
         level: 'warn'
         message: 'parseInt is missing the radix argument'
diff --git a/src/rules/newlines_after_classes.coffee b/src/rules/newlines_after_classes.coffee
@@ -1,6 +1,7 @@
 module.exports = class NewlinesAfterClasses
 
     rule:
+        type: 'style'
         name: 'newlines_after_classes'
         value: 3
         level: 'ignore'
diff --git a/src/rules/no_backticks.coffee b/src/rules/no_backticks.coffee
@@ -1,6 +1,7 @@
 module.exports = class NoBackticks
 
     rule:
+        type: 'problem'
         name: 'no_backticks'
         level: 'error'
         message: 'Backticks are forbidden'
diff --git a/src/rules/no_debugger.coffee b/src/rules/no_debugger.coffee
@@ -1,6 +1,7 @@
 module.exports = class NoDebugger
 
     rule:
+        type: 'problem'
         name: 'no_debugger'
         level: 'warn'
         message: 'Found debugging code'
diff --git a/src/rules/no_empty_functions.coffee b/src/rules/no_empty_functions.coffee
@@ -5,6 +5,7 @@ isEmptyCode = (node, astApi) ->
 module.exports = class NoEmptyFunctions
 
     rule:
+        type: 'problem'
         name: 'no_empty_functions'
         level: 'ignore'
         message: 'Empty function'
diff --git a/src/rules/no_empty_param_list.coffee b/src/rules/no_empty_param_list.coffee
@@ -1,6 +1,7 @@
 module.exports = class NoEmptyParamList
 
     rule:
+        type: 'style'
         name: 'no_empty_param_list'
         level: 'ignore'
         message: 'Empty parameter list is forbidden'
diff --git a/src/rules/no_implicit_braces.coffee b/src/rules/no_implicit_braces.coffee
@@ -1,6 +1,7 @@
 module.exports = class NoImplicitBraces
 
     rule:
+        type: 'style'
         name: 'no_implicit_braces'
         level: 'ignore'
         message: 'Implicit braces are forbidden'
diff --git a/src/rules/no_implicit_parens.coffee b/src/rules/no_implicit_parens.coffee
@@ -1,6 +1,7 @@
 module.exports = class NoImplicitParens
 
     rule:
+        type: 'style'
         name: 'no_implicit_parens'
         level: 'ignore'
         message: 'Implicit parens are forbidden'
diff --git a/src/rules/no_interpolation_in_single_quotes.coffee b/src/rules/no_interpolation_in_single_quotes.coffee
@@ -1,6 +1,7 @@
 module.exports = class NoInterpolationInSingleQuotes
 
     rule:
+        type: 'problem'
         name: 'no_interpolation_in_single_quotes'
         level: 'ignore'
         message: 'Interpolation in single quoted strings is forbidden'
diff --git a/src/rules/no_nested_string_interpolation.coffee b/src/rules/no_nested_string_interpolation.coffee
@@ -1,6 +1,7 @@
 module.exports = class NoNestedStringInterpolation
 
     rule:
+        type: 'problem'
         name: 'no_nested_string_interpolation'
         level: 'warn'
         message: 'Nested string interpolation is forbidden'
diff --git a/src/rules/no_plusplus.coffee b/src/rules/no_plusplus.coffee
@@ -1,6 +1,7 @@
 module.exports = class NoPlusPlus
 
     rule:
+        type: 'style'
         name: 'no_plusplus'
         level: 'ignore'
         message: 'The increment and decrement operators are forbidden'
diff --git a/src/rules/no_private_function_fat_arrows.coffee b/src/rules/no_private_function_fat_arrows.coffee
@@ -1,6 +1,7 @@
 module.exports = class NoPrivateFunctionFatArrows
 
     rule:
+        type: 'style'
         name: 'no_private_function_fat_arrows'
         level: 'warn'
         message: 'Used the fat arrow for a private function'
diff --git a/src/rules/no_spaces.coffee b/src/rules/no_spaces.coffee
@@ -3,6 +3,7 @@ indentationRegex = /\S/
 module.exports = class NoSpaces
 
     rule:
+        type: 'style'
         name: 'no_spaces'
         level: 'ignore'
         message: 'Line contains space indentation'
diff --git a/src/rules/no_stand_alone_at.coffee b/src/rules/no_stand_alone_at.coffee
@@ -1,6 +1,7 @@
 module.exports = class NoStandAloneAt
 
     rule:
+        type: 'style'
         name: 'no_stand_alone_at'
         level: 'ignore'
         message: '@ must not be used stand alone'
diff --git a/src/rules/no_tabs.coffee b/src/rules/no_tabs.coffee
@@ -3,6 +3,7 @@ indentationRegex = /\S/
 module.exports = class NoTabs
 
     rule:
+        type: 'style'
         name: 'no_tabs'
         level: 'error'
         message: 'Line contains tab indentation'
diff --git a/src/rules/no_this.coffee b/src/rules/no_this.coffee
@@ -1,6 +1,7 @@
 module.exports = class NoThis
 
     rule:
+        type: 'style'
         name: 'no_this'
         level: 'ignore'
         message: "Don't use 'this', use '@' instead"
diff --git a/src/rules/no_throwing_strings.coffee b/src/rules/no_throwing_strings.coffee
@@ -1,6 +1,7 @@
 module.exports = class NoThrowingStrings
 
     rule:
+        type: 'problem'
         name: 'no_throwing_strings'
         level: 'error'
         message: 'Throwing strings is forbidden'
diff --git a/src/rules/no_trailing_semicolons.coffee b/src/rules/no_trailing_semicolons.coffee
@@ -4,6 +4,7 @@ regexes =
 module.exports = class NoTrailingSemicolons
 
     rule:
+        type: 'style'
         name: 'no_trailing_semicolons'
         level: 'error'
         message: 'Line contains a trailing semicolon'
diff --git a/src/rules/no_trailing_whitespace.coffee b/src/rules/no_trailing_whitespace.coffee
@@ -7,6 +7,7 @@ regexes =
 module.exports = class NoTrailingWhitespace
 
     rule:
+        type: 'style'
         name: 'no_trailing_whitespace'
         level: 'error'
         message: 'Line ends with trailing whitespace'
diff --git a/src/rules/no_unnecessary_double_quotes.coffee b/src/rules/no_unnecessary_double_quotes.coffee
@@ -1,6 +1,7 @@
 module.exports = class NoUnnecessaryDoubleQuotes
 
     rule:
+        type: 'style'
         name: 'no_unnecessary_double_quotes'
         level: 'ignore'
         message: 'Unnecessary double quotes are forbidden'
diff --git a/src/rules/no_unnecessary_fat_arrows.coffee b/src/rules/no_unnecessary_fat_arrows.coffee
@@ -3,6 +3,7 @@ any = (arr, test) -> arr.reduce ((res, elt) -> res or test elt), false
 module.exports = class NoUnnecessaryFatArrows
 
     rule:
+        type: 'style'
         name: 'no_unnecessary_fat_arrows'
         level: 'warn'
         message: 'Unnecessary fat arrow'
diff --git a/src/rules/non_empty_constructor_needs_parens.coffee b/src/rules/non_empty_constructor_needs_parens.coffee
@@ -3,6 +3,7 @@ ParentClass = require './empty_constructor_needs_parens.coffee'
 module.exports = class NonEmptyConstructorNeedsParens extends ParentClass
 
     rule:
+        type: 'style'
         name: 'non_empty_constructor_needs_parens'
         level: 'ignore'
         message: 'Invoking a constructor without parens and with arguments'
diff --git a/src/rules/object_shorthand.coffee b/src/rules/object_shorthand.coffee
@@ -1,5 +1,6 @@
 module.exports = class ObjectShorthand
     rule:
+        type: 'style'
         name: 'object_shorthand'
         level: 'ignore'
         message: 'Use property-value shorthand when using explicit braces'
diff --git a/src/rules/prefer_english_operator.coffee b/src/rules/prefer_english_operator.coffee
@@ -1,6 +1,7 @@
 module.exports = class PreferEnglishOperator
 
     rule:
+        type: 'style'
         name: 'prefer_english_operator'
         level: 'ignore'
         message: 'Don\'t use &&, ||, ==, !=, or !'
diff --git a/src/rules/prefer_fat_arrows_in_methods.coffee b/src/rules/prefer_fat_arrows_in_methods.coffee
@@ -2,6 +2,7 @@
 module.exports = class MissingFatArrows
 
     rule:
+        type: 'style'
         name: 'prefer_fat_arrows_in_methods'
         level: 'ignore'
         message: 'Require fat arrows inside method bodies'
diff --git a/src/rules/prefer_logical_operator.coffee b/src/rules/prefer_logical_operator.coffee
@@ -1,6 +1,7 @@
 module.exports = class PreferLogicalOperator
 
     rule:
+        type: 'style'
         name: 'prefer_logical_operator'
         level: 'ignore'
         message: 'Don\'t use is, isnt, not, and, or, yes, on, no, off'
diff --git a/src/rules/space_operators.coffee b/src/rules/space_operators.coffee
@@ -1,6 +1,7 @@
 module.exports = class SpaceOperators
 
     rule:
+        type: 'style'
         name: 'space_operators'
         level: 'ignore'
         message: 'Operators must be spaced properly'
diff --git a/src/rules/spacing_after_comma.coffee b/src/rules/spacing_after_comma.coffee
@@ -1,5 +1,6 @@
 module.exports = class SpacingAfterComma
     rule:
+        type: 'style'
         name: 'spacing_after_comma'
         level: 'ignore'
         ignore_elision: false
diff --git a/src/rules/transform_messes_up_line_numbers.coffee b/src/rules/transform_messes_up_line_numbers.coffee
@@ -1,6 +1,7 @@
 module.exports = class TransformMessesUpLineNumbers
 
     rule:
+        type: 'style'
         name: 'transform_messes_up_line_numbers'
         level: 'warn'
         message: 'Transforming source messes up line numbers'
diff --git a/test/test_all_named_rules.coffee b/test/test_all_named_rules.coffee
@@ -0,0 +1,22 @@
+path = require 'path'
+vows = require 'vows'
+assert = require 'assert'
+coffeelint = require path.join('..', 'lib', 'coffeelint')
+
+rules = Object.values(coffeelint.getRules())
+namedRules = rules.filter((it) -> it.hasOwnProperty('name'))
+
+knownRuleTypes = [ 'style', 'problem' ]
+
+hasCorrectPropertyType = (rule) ->
+    return rule.hasOwnProperty('type') and rule.type in knownRuleTypes
+
+vows.describe('coffeelint').addBatch({
+
+    'CoffeeLint\'s named rules':
+        topic: namedRules
+
+        'has correct property "type"': (rules) ->
+            assert.isTrue(rules.every(hasCorrectPropertyType))
+
+}).export(module)
