Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "Orion/ESLint"

(→‎Rules)
(throw-error)
(86 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
Orion 5.0 will replace our current [http://www.jslint.com/ JSLint validator] with [https://github.com/nzakas/eslint/ ESLint]. This page captures ongoing issues.
+
Orion 5.0 moved to [https://github.com/nzakas/eslint/ ESLint] as the validator that ships with Orion. This page captures ongoing issues.
  
 
== Rules ==  
 
== Rules ==  
−
Here's a table showing the equivalent validation rules in JSLint and ESLint.
+
The following table describes all of the rules currently available in Orion and ones that we plan to add in the future.
  
−
{| class="wikitable" border="1" style="width: 100%;"
+
Rules that are currently available are <del>struck out</del>.
−
! ESLint rule
+
 
−
! JSLint option
+
{| class="wikitable" border="1" cellpadding="5" cellspacing="0" style="width: 100%;"
−
! JSLint message
+
! style="background:#efefef;" width=5% | Rule
−
! Details
+
! style="background:#efefef;" width=5% | Default Severity
 +
! style="background:#efefef;" width=5% | Available Since
 +
! style="background:#efefef;" width=40%| Problem Message
 +
! style="background:#efefef;" width=40% | Details
 
|-
 
|-
  
−
| block-scoped-var
+
!| [https://bugs.eclipse.org/bugs/show_bug.cgi?id=428433 block-scoped-var]
−
|  
+
| Error
−
|  
+
| -
 +
| '''{variable}' is already defined.''
 +
|
 +
* Occurs when a function-scoped variable is treated as if it was block scoped.
 +
* ESLint calls this error '{variable} used outside of binding context.'
 
|-
 
|-
  
−
| brace-style
+
!| brace-style
−
|  
+
| Ignore
−
|  
+
| -
 +
| &nbsp;
 +
| &nbsp;
 
|-
 
|-
  
−
| camelcase
+
!| camelcase
−
|  
+
| Ignore
−
|  
+
| -
 +
| &nbsp;
 +
| &nbsp;
 
|-
 
|-
  
−
| complexity
+
!| complexity
−
|  
+
| Ignore
−
|  
+
| -
 +
| &nbsp;
 +
| &nbsp;
 
|-
 
|-
  
−
| consistent-this
+
!| consistent-this
−
|  
+
| Ignore
−
|  
+
| -
 +
| &nbsp;
 +
| &nbsp;
 
|-
 
|-
  
−
| curly
+
!| <del>[https://bugs.eclipse.org/bugs/show_bug.cgi?id=429722 curly]</del>
−
|  
+
| Ignore
−
|  
+
| 6.0
 +
| ''Statements should be enclosed in braces.''
 +
| &nbsp;
 
|-
 
|-
  
−
| dot-notation
+
!| dot-notation
−
| '''sub'''
+
| Warning
−
| {a} is better written in dot notation.
+
| -
 +
| ''{a} is better written in dot notation.''
 +
| &nbsp;
 
|-
 
|-
  
−
| eqeqeq
+
!| <del>[https://bugs.eclipse.org/bugs/show_bug.cgi?id=414779 eqeqeq]</del>
−
| '''eqeqeq'''<br>'''eqeq'''
+
| Warning
−
| Expected '===' and saw '=='.<br>Expected '!==' and saw '!='.
+
| 5.0
−
| '''eqeq''' only appears in old versions of JSLint (like Orion's), has opposite on/off state to '''eqeqeq'''.
+
|
 +
* ''Expected '===' and saw '=='.''
 +
* ''Expected '!==' and saw '!='.''
 +
| &nbsp;
 
|-
 
|-
  
−
| guard-for-in
+
!| guard-for-in
−
| '''forin'''
+
| Ignore
−
| The body of a for in should be wrapped in an if statement to filter unwanted properties from the prototype.
+
| -
 +
| ''The body of a <code>for in</code> should be wrapped in an <code>if</code> statement to filter unwanted properties from the prototype.''
 +
| &nbsp;
 
|-
 
|-
  
−
| max-depth
+
!| max-depth
−
|  
+
| Ignore
−
|  
+
| -
 +
| &nbsp;
 +
| Enforces max depth of nested blocks within a function.
 
|-
 
|-
  
−
| max-len
+
!| max-len
−
|  
+
| Ignore
−
|  
+
| -
 +
| ''Line is too long.''
 +
| Enforces a maximum line length.
 
|-
 
|-
  
−
| max-params
+
!| max-params
−
|  
+
| Ignore
−
|  
+
| -
 +
| &nbsp;
 +
| &nbsp;
 
|-
 
|-
  
−
| max-statements
+
!| max-statements
−
|  
+
| Ignore
−
|  
+
| -
 +
| &nbsp;
 +
| &nbsp;
 +
|-
 +
 
 +
!| <del>[https://bugs.eclipse.org/bugs/show_bug.cgi?id=424128 missing-doc]</del>
 +
| Ignore
 +
| 5.0
 +
| "Missing documentation for function '{name}.'"
 +
| Flags missing documentation nodes on function declarations and function expressions when they appear as object properties
 
|-
 
|-
  
−
| new-cap
+
!| [https://bugs.eclipse.org/bugs/show_bug.cgi?id=424204 missing-doc-items]
 +
| Ignore
 
| -
 
| -
−
| A constructor name should start with an uppercase letter.
+
|&nbsp;
 +
| Flags missing documentation for parameters, returns, throws, etc on function declarations and function expressions when they appear as object properties
 
|-
 
|-
  
−
| new-parens
+
!| [https://bugs.eclipse.org/bugs/show_bug.cgi?id=428429 missing-nls]
−
|  
+
| Ignore
−
|  
+
| -
 +
| &nbsp;
 +
| Flags String literals that are not properly NLS'd
 
|-
 
|-
  
−
| no-alert
+
!| new-cap
−
|  
+
| Warning
−
|  
+
| -
 +
| ''A constructor name should start with an uppercase letter.''
 +
| &nbsp;
 
|-
 
|-
  
−
| no-bitwise
+
!| <del>[https://bugs.eclipse.org/bugs/show_bug.cgi?id=429801 new-parens]</del>
−
|  
+
| Error
−
|  
+
| 6.0
 +
| ''Missing parentheses invoking constructor.''
 +
| Flags <code>new Whatever</code>
 
|-
 
|-
  
−
| no-caller
+
!| no-alert
−
|  
+
| Ignore
−
|  
+
| -
 +
| '''{alert, confirm, prompt}' is not defined.''
 +
| &nbsp;
 
|-
 
|-
  
−
| no-catch-shadow
+
!| no-bitwise
−
|  
+
| Warning
−
|  
+
| -
 +
| ''Unexpected use of '{operator}'.''
 +
| JSLint disallows bitwise ops by default.
 
|-
 
|-
  
−
| no-comma-dangle
+
!| no-caller
 +
| Ignore
 
| -
 
| -
−
| Unexpected comma.
+
| &nbsp;
−
| Flags trailing commas in object literals.
+
| Flags references to <code>arguments.callee</code> and <code>arguments.caller</code>.
 
|-
 
|-
  
−
| no-cond-assign
+
!| no-catch-shadow
−
|  
+
| Warning
−
|  
+
| -
 +
| '''{a}' is already defined.''
 +
|
 +
* Flags a <code>catch</code> clause's variable that shadows a variable declared in an outer scope. (In IE8 this [http://weblog.bocoup.com/the-catch-with-try-catch/ causes the outer variable to be overwritten]).
 
|-
 
|-
  
−
| no-console
+
!| [https://bugs.eclipse.org/bugs/show_bug.cgi?id=426723 no-comma-dangle]
−
|  
+
| Warning
−
|  
+
| -
 +
| ''Unexpected comma.''
 +
| Flags trailing commas in object literals and array declarations.
 
|-
 
|-
  
−
| no-control-regex
+
!| no-cond-assign
−
|  
+
| Ignore
−
|  
+
| -
 +
| &nbsp;
 +
| Flags assignment in an <code>if/while/do..while/for</code> condition.
 
|-
 
|-
  
−
| no-debugger
+
!| no-console
−
|  
+
| Ignore
−
|  
+
| -
 +
| &nbsp;
 +
| &nbsp;
 
|-
 
|-
  
−
| no-delete-var
+
!| no-control-regex
−
|  
+
| Ignore
−
|  
+
| -
 +
| &nbsp;
 +
| Flags control characters (U+0000–U+001F and U+007F) within the source argument to the RegExp constructor.
 
|-
 
|-
  
−
| no-div-regex
+
!| <del>[https://bugs.eclipse.org/bugs/show_bug.cgi?id=429690 no-debugger]</del>
−
|  
+
| Warning
−
|  
+
| 6.0
 +
| ''debugger' statement use is discouraged.''
 +
| &nbsp;
 
|-
 
|-
  
−
| no-dupe-keys
+
!| no-delete-var
−
|  
+
| Warning
−
|  
+
| -
 +
| ''Deleting a local variable is discouraged.''
 +
| Flags an attempt to <code>delete</code> a local variable.
 
|-
 
|-
  
−
| no-else-return
+
!| no-div-regex
−
|  
+
| Warning
−
|  
+
| -
 +
| ''A regular expression literal can be confused with '/='.''
 +
| Flags a regex literal starting with <code>/=</code>
 
|-
 
|-
  
−
| no-empty-class
+
!| <del>[https://bugs.eclipse.org/bugs/show_bug.cgi?id=428430 no-dupe-keys]</del>
−
|  
+
| Error
−
|  
+
| 6.0
 +
| ''Duplicate object key '{key}'.''
 +
| Flags object literals that contain the same key more than once.
 
|-
 
|-
  
−
| no-empty-label
+
!| no-else-return
−
|  
+
| Warning
−
|  
+
| -
 +
| &nbsp;
 +
| Flags an <code>else</code> appearing after an <code>if</code> that contains a <code>return</code>.
 
|-
 
|-
  
−
| no-empty
+
!| no-empty-class
−
|  
+
| Warning
−
|  
+
| -
 +
| ''Empty class.''
 +
| Flags an empty character class <code>[]</code> within a regular expression.
 
|-
 
|-
  
−
| no-eq-null
+
!| no-empty-label
−
|  
+
| Warning
−
|  
+
| -
 +
| ''Label '{a}' is not allowed on this statement.''
 +
| Flags a labeled statement that is not a <code>switch</code>, <code>for</code>, or <code>while</code>.
 
|-
 
|-
  
−
| no-eval
+
!| <del>no-empty</del>
−
|  
+
| Warning
−
|  
+
| -
 +
| &nbsp;
 +
| Flags an empty block like <code>if (something) { }</code>.
 
|-
 
|-
  
−
| no-ex-assign
+
!| no-eq-null
−
|  
+
| Error
−
|  
+
| -
 +
| ''Use '===' to compare with 'null'.''
 +
| &nbsp;
 
|-
 
|-
  
−
| no-extra-semi
+
!| <del>[https://bugs.eclipse.org/bugs/show_bug.cgi?id=429702 no-eval]</del>
−
|  
+
| Ignore
−
|  
+
| 6.0
 +
| '''eval' function calls are discouraged.''
 +
| &nbsp;
 
|-
 
|-
  
−
| no-fallthrough
+
!| no-ex-assign
−
|  
+
| Warning
−
|  
+
| -
 +
| ''Do not assign to the exception parameter.''
 +
| &nbsp;
 
|-
 
|-
  
−
| no-floating-decimal
+
!| <del>[https://bugs.eclipse.org/bugs/show_bug.cgi?id=428040 no-extra-semi]</del>
−
|  
+
| Warning
−
|  
+
| 5.0
 +
| ''Unnecessary semicolon.''
 +
| &nbsp;
 
|-
 
|-
  
−
| no-func-assign
+
!| <del>[https://bugs.eclipse.org/bugs/show_bug.cgi?id=429815 no-fallthrough]</del>
−
|  
+
| Error
−
|  
+
| -
 +
| ''Switch case may be entered by falling through previous case. If intended, add a new comment //$FALL-THROUGH$ on the line above''
 +
| Flags a fallthrough case within a <code>switch</code> statement, unless it is explicitly commented.
 
|-
 
|-
  
−
| no-global-strict
+
!| no-floating-decimal
−
|  
+
| Warning
−
|  
+
| -
 +
| ''A {leading, trailing} decimal point can be confused with a dot: '{n}'.''
 +
| Flags numeric literals that have a leading or trailing decimal point.
 
|-
 
|-
  
−
| no-implied-eval
+
!| no-func-assign
−
|  
+
| Warning
−
|  
+
| -
 +
| &nbsp;
 +
| Flags assignment to a variable that's already bound to a <code>FunctionExpression</code>.
 
|-
 
|-
  
−
| no-iterator
+
!| no-global-strict
−
|  
+
| Warning
−
|  
+
| -
 +
| &nbsp;
 +
| Flags <code>"use strict"</code> applied to the entire Program.
 
|-
 
|-
  
−
| no-label-var
+
!| <del>[https://bugs.eclipse.org/bugs/show_bug.cgi?id=429707 no-implied-eval]</del>
−
|  
+
| Ignore
−
|  
+
| 6.0
 +
| ''Implicit 'eval' function calls are discouraged.''
 +
| Flags calls to the string-argument form of <code>setTimeout</code> and <code>setInterval</code>, which implicitly perform <code>eval</code>. This rule logic was merged to be part of the <b>no-eval</b> rule.
 
|-
 
|-
  
−
| no-loop-func
+
!| no-iterator
−
|  
+
| Error
−
|  
+
| -
 +
| ''Reserved name '__iterator__'.''
 +
| Flags use of __iterator__ as an identifier name or property key.
 
|-
 
|-
  
−
| no-mixed-requires
+
!| no-label-var
−
|  
+
| Error
−
|  
+
| -
 +
| '''{label}' is already defined.''
 +
| Flags labels that collide with an identifier.
 
|-
 
|-
  
−
| no-multi-str
+
!| no-loop-func
−
|  
+
| Error
−
|  
+
| -
 +
| ''Don't make functions within a loop.''
 +
| &nbsp;
 
|-
 
|-
  
−
| no-native-reassign
+
!| no-mixed-requires
−
|  
+
| Ignore
−
|  
+
| -
 +
| &nbsp;
 +
| Flags Node.js <code>require()</code>s that mix different types of requires (core, module, file, computed).
 
|-
 
|-
  
−
| no-negated-in-lhs
+
!| [https://bugs.eclipse.org/bugs/show_bug.cgi?id=425200 no-mixed-returns]
−
|  
+
| Error
−
|  
+
| -
 +
| &nbsp;
 +
| Flags functions that return more than one kind of item, for example returning String and Object
 
|-
 
|-
  
−
| no-new-array
+
!| no-multi-str
−
|  
+
| Warning
−
|  
+
| -
 +
| &nbsp;
 +
| Flags use of ES5 multiline string literals.
 
|-
 
|-
  
−
| no-new-func
+
!| no-native-reassign
−
|  
+
| Warning
−
|  
+
| -
 +
|
 +
* ''Read only.''
 +
* ''Bad assignment.'' (if assigning to <code>undefined</code>)
 +
| Flags an attempt to reassign a native object like <code>Math</code>, Array, <code>undefined</code>, etc.
 
|-
 
|-
  
−
| no-new-object
+
!| no-negated-in-lhs
−
|  
+
| Warning
−
|  
+
| -
 +
| &nbsp;
 +
|
 +
* Flags a unary <code>!</code> operator applied to the LHS of an in statement, which negates the LHS, not the <code>in</code>.
 +
* Eg. <code>(!"key" in {key: 1})</code> (which always evaluates to false), will be flagged.
 
|-
 
|-
  
−
| no-new-wrappers
+
!| <del>[https://bugs.eclipse.org/bugs/show_bug.cgi?id=429817 no-new-array]</del>
−
|  
+
| Warning
−
|  
+
| -
 +
| ''Use the array literal notation [].''
 +
| Flags <code>new Array()</code>.
 
|-
 
|-
  
−
| no-new
+
!| <del>[https://bugs.eclipse.org/bugs/show_bug.cgi?id=429817 no-new-func]</del>
−
|  
+
| Warning
−
|  
+
| -
 +
| ''The Function constructor is eval.''
 +
| Flags <code>new Function()</code>.
 
|-
 
|-
  
−
| no-obj-calls
+
!| <del>[https://bugs.eclipse.org/bugs/show_bug.cgi?id=429817 no-new-object]</del>
−
|  
+
| Warning
−
|  
+
| -
 +
| ''Use the object literal notation {}.''
 +
| Flags <code>new Object()</code>.
 
|-
 
|-
  
−
| no-octal-escape
+
!| <del>[https://bugs.eclipse.org/bugs/show_bug.cgi?id=429817 no-new-wrappers]</del>
−
|  
+
| Warning
−
|  
+
| -
 +
| ''Do not use {String, Number, Boolean, Math, JSON} as a constructor.''
 +
| Flags <code>new</code> applied to any of those.
 
|-
 
|-
  
−
| no-octal
+
!| no-new
−
|  
+
| Error
−
|  
+
| -
 +
| ''Do not use 'new' for side effects.''
 +
| Flags uses of <code>new</code> operator in an expression that is not assigned to anything.
 
|-
 
|-
  
−
| no-plusplus
+
!| no-obj-calls
−
|  
+
| Warning
−
|  
+
| -
 +
| ''Math is not a function..''
 +
|
 +
* Flags attempts to call object properties of the global object (<code>Math</code>, <code>JSON</code>) as a function, like <code>Math()</code>.
 
|-
 
|-
  
−
| no-proto
+
!| no-octal-escape
−
|  
+
| Warning
−
|  
+
| -
 +
| ''Bad escapement.''
 +
| Flags octal escapes in strings, for example <code>var x = "Copyright \251";</code>
 
|-
 
|-
  
−
| no-redeclare
+
!| no-octal
−
|  
+
| Warning
−
|  
+
| -
 +
| ''Don't use extra leading zeros '{n}'.''
 +
| Flags number literals that begin with leading 0s, which indicate a (probably accidental) octal literal.
 
|-
 
|-
  
−
| no-return-assign
+
!| no-plusplus
−
|  
+
| Warning
 +
| -
 
|  
 
|  
 +
* ''Unexpected use of '++'''
 +
* ''Unexpected use of '--'''
 +
| &nbsp;
 
|-
 
|-
  
−
| no-script-url
+
!| no-proto
−
|  
+
| Error
−
|  
+
| -
 +
|
 +
* ''Reserved name '__proto__' should not be assigned."
 +
* 'Reserved name '__proto__' should not be used as a key."
 +
| &nbsp;
 
|-
 
|-
  
−
| no-self-compare
+
!| <del>[https://bugs.eclipse.org/bugs/show_bug.cgi?id=414779 no-redeclare]</del>
−
|  
+
| Warning
−
|  
+
| 5.0
 +
| '''{a}' is already defined.''
 +
| Usually results from having two <code>for</code> loops in the same function that share a loop variable declaration like <code>var i=...</code>.
 
|-
 
|-
  
−
| no-shadow
+
!| no-return-assign
−
|  
+
| Warning
−
|  
+
| -
 +
| &nbsp;
 +
|
 +
* Prevents assignment in a <code>return</code> statement.
 +
* Unsupported by JSLint, although JSLint does require parens around a return-assignment, eg: <code>return (x = 2);</code>
 
|-
 
|-
  
−
| no-spaced-func
+
!| no-script-url
−
|  
+
| Warning
 +
| -
 +
| &nbsp;
 
|  
 
|  
 +
* Flags string literals beginning with <code>javascript:</code>. (Script URLs are a form of <code>eval</code>.)
 
|-
 
|-
  
−
| no-sync
+
!| no-self-compare
−
|  
+
| Error
−
|  
+
| -
 +
| &nbsp;
 +
| Flags comparisons where the left- and right-hand sides are the same.
 
|-
 
|-
  
−
| no-ternary
+
!!| [https://bugs.eclipse.org/bugs/show_bug.cgi?id=438319 no-shadow]
−
|  
+
| Warning
−
|  
+
| -
 +
| &nbsp;
 +
| Flags variables that have the same name as a variable declared in an outer scope.
 
|-
 
|-
  
−
| no-undef-init
+
!| no-spaced-func
−
|  
+
| Ignore
−
|  
+
| -
 +
| ''Unnecessary space in function call.''
 +
| Report on excess space in a function call, for example <code>myFunc ();</code> or <code>new MyObj ();</code>
 
|-
 
|-
  
−
| no-undef
+
!| no-sync
−
| '''node''', '''browser''', '''require'''
+
| Ignore
−
|
+
| -
 +
| ''Unexpected sync method: '{a}'.''
 +
|
 +
* Flags Node.js's synchronous I/O methods.
 +
* The '''stupid''' option is supported only in newer versions of JSLint (not Orion's).
 
|-
 
|-
  
 +
!| no-ternary
 +
| Ignore
 +
| -
 +
| &nbsp;
 +
| Flags any use of the ternary operator <code>cond ? thenExpr : elseExpr</code>
 +
|-
  
−
| no-underscore-dangle
+
!| no-undef-init
−
|  
+
| Warning
−
|  
+
| -
 +
| ''It is not necessary to initialize '{variable}' to 'undefined'.''
 +
| &nbsp;
 
|-
 
|-
  
−
| no-unreachable
+
!| <del>[https://bugs.eclipse.org/bugs/show_bug.cgi?id=427310 no-unused-params]</del>
−
|  
+
| Warning
−
|  
+
| -
 +
| "Parameter '{param}' is not used."
 +
| Flags parameters in function declarations / expressions if they are not being used
 
|-
 
|-
  
−
| no-unused-expressions
+
!| <del>[https://bugs.eclipse.org/bugs/show_bug.cgi?id=414779 no-undef]</del>
−
|  
+
| Error
−
|  
+
| 5.0
 +
| '''{variable}' is not defined.''
 +
|
 +
* Flags references to a global variable that is not listed in a /*global*/ or /*globals*/ block.
 +
* Predefined environments (eg. '''node''', '''browser''') can be set in the /*jslint */ block.
 
|-
 
|-
  
−
| no-unused-vars
+
!| no-underscore-dangle
−
|  
+
| Ignore
−
|  
+
| -
 +
| ''Dangling '_'''
 +
| &nbsp;
 
|-
 
|-
  
−
| no-use-before-define
+
!| <del>[https://bugs.eclipse.org/bugs/show_bug.cgi?id=436986 no-unreachable]</del>
−
|  
+
| Error
−
|  
+
| -
 +
| ''Unreachable code.''
 +
| Flags statements that occur after a <code>return</code>, <code>throw</code>, etc.
 
|-
 
|-
  
−
| no-with
+
!| no-unused-expressions
−
|  
+
| Warning
−
|  
+
| -
 +
| ''Expected an assignment or function call and instead saw an expression.''
 +
| Flags expressions that appear in a statement context and don't cause side effects.
 
|-
 
|-
  
−
| no-wrap-func
+
!| <deL>[https://bugs.eclipse.org/bugs/show_bug.cgi?id=414779 no-unused-vars]</del>
−
|  
+
| Warning
−
|  
+
| 5.0
 +
| ''Function declares unused variable '{a}'.''
 +
| &nbsp;
 
|-
 
|-
  
−
| one-var
+
!| <del>[https://bugs.eclipse.org/bugs/show_bug.cgi?id=414779 no-use-before-define]</del>
−
|  
+
| Warning
−
|  
+
| 5.0
 +
| '''{a}' was used before it was defined.''
 +
| &nbsp;
 
|-
 
|-
  
−
| quote-props
+
!| no-with
−
|  
+
| Warning
−
|  
+
| -
 +
| ''Expected an identifier and instead saw 'with'.''
 +
| Treated as fatal parse error in JSLint.
 
|-
 
|-
  
−
| quotes
+
!| no-wrap-func
−
|  
+
| Ignore
−
|  
+
| -
 +
| ''Do not wrap function literals in parens unless they are to be immediately invoked.''
 +
| Flags a parenthesized function literal that is not immediately invoked, eg. <code>(function fun(){})</code>
 
|-
 
|-
  
−
| radix
+
!| object-prototype-external
−
|  
+
| Warning
−
|  
+
| -
 +
| &nbsp;
 +
| Flags calls to methods of <code>Object.prototype</code> that rely on the prototype chain. For example this code should be flagged:
 +
<source lang="javascript" line="line">
 +
foo.hasOwnProperty("bar")
 +
</source>
 +
 
 +
Example (1) is [https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/hasOwnProperty?redirectlocale=en-US&redirectslug=JavaScript%2FReference%2FGlobal_Objects%2FObject%2FhasOwnProperty#hasOwnProperty_as_a_property unsafe], as <code>foo</code> may have a property named <code>hasOwnProperty</code>, or have been constructed via <code>Object.create(null)</code>.
 +
 
 +
As for this:
 +
 
 +
<source lang="javascript" line="line" start="2">
 +
Object.hasOwnProperty.call(foo, "bar")
 +
</source>
 +
 
 +
Example (2) technically relies on the prototype chain as well: the hasOwnProperty method is defined on Object.prototype, not Object. Object inherits the methods of Object.prototype [http://stackoverflow.com/questions/14817826/difference-between-an-object-and-its-prototype/14817913#14817913 through its prototype chain]. However (2) is unlikely to fail, as sane JavaScript programs will not modify the global objects' prototypes. If we choose to flag (2), it should only be for style.
 
|-
 
|-
  
−
| regex-spaces
+
!| one-var
−
|  
+
| Warning
−
|  
+
| -
 +
| ''Too many var statements.''
 +
| Allows only 1 <code>var</code> statement per function.
 
|-
 
|-
  
−
| semi
+
!| quote-props
 +
| Warning
 
| -
 
| -
−
| Missing semicolon.
+
| &nbsp;
−
|
+
| Requires object literal keys to be quoted with " or '.
 
|-
 
|-
  
−
| strict
+
!| quotes
−
|  
+
| Ignore
−
|  
+
| -
 +
| &nbsp;
 +
| Flags any use of single or double quote marks, depending on setting.
 
|-
 
|-
  
−
| unnecessary-strict
+
!| radix
−
|  
+
| Warning
−
|  
+
| -
 +
| ''Missing radix parameter.''
 +
| Affects parseInt().
 
|-
 
|-
  
−
| use-isnan
+
!| regex-spaces
−
|  
+
| Warning
−
|  
+
| -
 +
| ''Spaces are hard to count. Use {n}.''
 +
| &nbsp;
 
|-
 
|-
  
−
| wrap-iife
+
!| <del>[https://bugs.eclipse.org/bugs/show_bug.cgi?id=427930 semi]</del>
−
| -
+
| Warning
−
| Wrap the entire immediate function invocation in parens.<br>Do not wrap function literals in parens unless they are to be immediately invoked.<br>Move the invocation into the parens that contain the function.
+
| 5.0
−
|  
+
| ''Missing semicolon.''
 +
| &nbsp;
 
|-
 
|-
  
−
| wrap-regex
+
!| strict
 +
| Ignore
 
| -
 
| -
−
| Wrap the /regexp/ literal in parens to disambiguate the slash operator.
+
| &nbsp;
 +
| Flags any code that lacks the <code>"use strict"</code> pragma.
 +
|-
 +
 
 +
!| throw-error
 +
| Warning
 +
| 7.0
 +
| &nbsp;
 +
| Flags code that throws a non-Error, eg. <code>throw "a problem occurred";</code>
 +
|-
 +
 
 +
 
 +
!| unnecessary-strict
 +
| Warning
 +
| -
 +
| &nbsp;
 +
| Flags <code>"use strict"</code> on a function when the entire Program is already in strict mode.
 +
|-
 +
 
 +
!| <del>[https://bugs.eclipse.org/bugs/show_bug.cgi?id=429711 use-isnan]</del>
 +
| Error
 +
| 6.0
 +
| ''Use the isNaN function to compare with NaN.''
 +
| &nbsp;
 +
|-
 +
 
 +
!| wrap-iife
 +
| Ignore
 +
| -
 +
|
 +
* ''Wrap the entire immediate function invocation in parens.''
 +
* ''Move the invocation into the parens that contain the function.''
 +
| Flags missing parens on immediately-invoked functions, eg. <code>function(){ console.log('hi'); }();</code>
 +
|-
 +
 
 +
!| wrap-regex
 +
| Warning
 +
| -
 +
| ''Wrap the /regexp/ literal in parens to disambiguate the slash operator.''
 +
| &nbsp;
 
|-
 
|-
  
Line 444: Line 698:
 
|}
 
|}
  
−
== Rule priority ==
+
== Tests ==
−
Here are the rules we want, in order of priority:
+
* Every rule needs extensive unit tests
−
# no-undef
+
* Unit tests should use Mocha
 +
 
 +
Currently the tests are run from Node.js. They do not run in the browser (yet).
 +
 
 +
=== Test requirements ===
 +
First install [http://nodejs.org/ Node.js]. Then open a console and install Mocha globally:
 +
 
 +
$ npm install mocha -g
 +
 
 +
Then from your Orion client repository, run these commands to install eslint's dependencies:
 +
 
 +
$ cd bundles/org.eclipse.orion.client.javascript/web/eslint/
 +
$ npm install
 +
 
 +
=== Running the tests ===
 +
From the <code>bundles/org.eclipse.orion.client.javascript/web/eslint/</code> directory, simply run <code>npm test</code>:
 +
 
 +
$ npm test
 +
 +
> eslint@0.2.0-dev test c:\Users\mamacdon\code\orion\client\bundles\org.eclipse.orion.client.javascript\web\eslint
 +
> bash scripts/test.sh
 +
 +
 +
  ......................................................................
 +
  ...............
 +
 +
  85 passing (106ms)
 +
 
 +
To run only a subset of the tests, launch mocha from the command line, passing the test file:
 +
 
 +
$ mocha tests/lib/rules/semi.js
 +
 +
  ............
 +
 +
  12 passing (17ms)
 +
 
 +
You can also pass an entire directory:
 +
 
 +
$ mocha tests/lib/rules
 +
 +
  ......................................................................
 +
  ..........
 +
 +
  80 passing (104ms)
 +
 
 +
To run only some tests from a file, use the --grep option:
 +
 
 +
$ mocha tests/lib/rules/semi.js --grep VariableDeclaration
 +
 +
  .
 +
 +
  1 passing (5ms)
 +
 
 +
See [http://visionmedia.github.io/mocha/#usage Mocha usage options] for more.
 +
 
 +
== User interface ==
 +
* <del>Should we have a UI for configuring what rules are active?</del> [https://bugs.eclipse.org/bugs/show_bug.cgi?id=424268 bug 424268].
 +
* Should we try to support <code>.eslintrc</code>? This would be an ideal project-scope setting.
 +
* Should we try to honor equivalent JSLint/JSHint flags when possible? For example <code>/*jslint eqeqeq:false */</code> could disable the eqeqeq rule on a per-file basis.
 +
** This would give compatibility with Orion codebase which uses these flags.
 +
** OTOH, eslint now has its own syntax for this: <code>/*eslint ..*/</code>, which we should perhaps use instead.
 +
 
 +
== i18n ==
 +
We need to support i18n. Pre-req is {{bug|422278}} (orion.edit.validator support for i18n).
 +
 
 +
[[Category:Orion]]

Revision as of 19:40, 10 July 2014

Orion 5.0 moved to ESLint as the validator that ships with Orion. This page captures ongoing issues.

Rules

The following table describes all of the rules currently available in Orion and ones that we plan to add in the future.

Rules that are currently available are struck out.

Rule Default Severity Available Since Problem Message Details
block-scoped-var Error - '{variable}' is already defined.
  • Occurs when a function-scoped variable is treated as if it was block scoped.
  • ESLint calls this error '{variable} used outside of binding context.'
brace-style Ignore -    
camelcase Ignore -    
complexity Ignore -    
consistent-this Ignore -    
curly Ignore 6.0 Statements should be enclosed in braces.  
dot-notation Warning - {a} is better written in dot notation.  
eqeqeq Warning 5.0
  • Expected '===' and saw '=='.
  • Expected '!==' and saw '!='.
  
guard-for-in Ignore - The body of a for in should be wrapped in an if statement to filter unwanted properties from the prototype.  
max-depth Ignore -   Enforces max depth of nested blocks within a function.
max-len Ignore - Line is too long. Enforces a maximum line length.
max-params Ignore -    
max-statements Ignore -    
missing-doc Ignore 5.0 "Missing documentation for function '{name}.'" Flags missing documentation nodes on function declarations and function expressions when they appear as object properties
missing-doc-items Ignore -   Flags missing documentation for parameters, returns, throws, etc on function declarations and function expressions when they appear as object properties
missing-nls Ignore -   Flags String literals that are not properly NLS'd
new-cap Warning - A constructor name should start with an uppercase letter.  
new-parens Error 6.0 Missing parentheses invoking constructor. Flags new Whatever
no-alert Ignore - '{alert, confirm, prompt}' is not defined.  
no-bitwise Warning - Unexpected use of '{operator}'. JSLint disallows bitwise ops by default.
no-caller Ignore -   Flags references to arguments.callee and arguments.caller.
no-catch-shadow Warning - '{a}' is already defined.
no-comma-dangle Warning - Unexpected comma. Flags trailing commas in object literals and array declarations.
no-cond-assign Ignore -   Flags assignment in an if/while/do..while/for condition.
no-console Ignore -    
no-control-regex Ignore -   Flags control characters (U+0000–U+001F and U+007F) within the source argument to the RegExp constructor.
no-debugger Warning 6.0 debugger' statement use is discouraged.  
no-delete-var Warning - Deleting a local variable is discouraged. Flags an attempt to delete a local variable.
no-div-regex Warning - A regular expression literal can be confused with '/='. Flags a regex literal starting with /=
no-dupe-keys Error 6.0 Duplicate object key '{key}'. Flags object literals that contain the same key more than once.
no-else-return Warning -   Flags an else appearing after an if that contains a return.
no-empty-class Warning - Empty class. Flags an empty character class [] within a regular expression.
no-empty-label Warning - Label '{a}' is not allowed on this statement. Flags a labeled statement that is not a switch, for, or while.
no-empty Warning -   Flags an empty block like if (something) { }.
no-eq-null Error - Use '===' to compare with 'null'.  
no-eval Ignore 6.0 'eval' function calls are discouraged.  
no-ex-assign Warning - Do not assign to the exception parameter.  
no-extra-semi Warning 5.0 Unnecessary semicolon.  
no-fallthrough Error - Switch case may be entered by falling through previous case. If intended, add a new comment //$FALL-THROUGH$ on the line above Flags a fallthrough case within a switch statement, unless it is explicitly commented.
no-floating-decimal Warning - A {leading, trailing} decimal point can be confused with a dot: '{n}'. Flags numeric literals that have a leading or trailing decimal point.
no-func-assign Warning -   Flags assignment to a variable that's already bound to a FunctionExpression.
no-global-strict Warning -   Flags "use strict" applied to the entire Program.
no-implied-eval Ignore 6.0 Implicit 'eval' function calls are discouraged. Flags calls to the string-argument form of setTimeout and setInterval, which implicitly perform eval. This rule logic was merged to be part of the no-eval rule.
no-iterator Error - Reserved name '__iterator__'. Flags use of __iterator__ as an identifier name or property key.
no-label-var Error - '{label}' is already defined. Flags labels that collide with an identifier.
no-loop-func Error - Don't make functions within a loop.  
no-mixed-requires Ignore -   Flags Node.js require()s that mix different types of requires (core, module, file, computed).
no-mixed-returns Error -   Flags functions that return more than one kind of item, for example returning String and Object
no-multi-str Warning -   Flags use of ES5 multiline string literals.
no-native-reassign Warning -
  • Read only.
  • Bad assignment. (if assigning to undefined)
 Flags an attempt to reassign a native object like Math, Array, undefined, etc.
no-negated-in-lhs Warning -  
  • Flags a unary ! operator applied to the LHS of an in statement, which negates the LHS, not the in.
  • Eg. (!"key" in {key: 1}) (which always evaluates to false), will be flagged.
no-new-array Warning - Use the array literal notation []. Flags new Array().
no-new-func Warning - The Function constructor is eval. Flags new Function().
no-new-object Warning - Use the object literal notation {}. Flags new Object().
no-new-wrappers Warning - Do not use {String, Number, Boolean, Math, JSON} as a constructor. Flags new applied to any of those.
no-new Error - Do not use 'new' for side effects. Flags uses of new operator in an expression that is not assigned to anything.
no-obj-calls Warning - Math is not a function..
  • Flags attempts to call object properties of the global object (Math, JSON) as a function, like Math().
no-octal-escape Warning - Bad escapement. Flags octal escapes in strings, for example var x = "Copyright \251";
no-octal Warning - Don't use extra leading zeros '{n}'. Flags number literals that begin with leading 0s, which indicate a (probably accidental) octal literal.
no-plusplus Warning -
  • Unexpected use of '++'
  • Unexpected use of '--'
  
no-proto Error -
  • Reserved name '__proto__' should not be assigned."
  • 'Reserved name '__proto__' should not be used as a key."
  
no-redeclare Warning 5.0 '{a}' is already defined. Usually results from having two for loops in the same function that share a loop variable declaration like var i=....
no-return-assign Warning -  
  • Prevents assignment in a return statement.
  • Unsupported by JSLint, although JSLint does require parens around a return-assignment, eg: return (x = 2);
no-script-url Warning -  
  • Flags string literals beginning with javascript:. (Script URLs are a form of eval.)
no-self-compare Error -   Flags comparisons where the left- and right-hand sides are the same.
no-shadow Warning -   Flags variables that have the same name as a variable declared in an outer scope.
no-spaced-func Ignore - Unnecessary space in function call. Report on excess space in a function call, for example myFunc (); or new MyObj ();
no-sync Ignore - Unexpected sync method: '{a}'.
  • Flags Node.js's synchronous I/O methods.
  • The stupid option is supported only in newer versions of JSLint (not Orion's).
no-ternary Ignore -   Flags any use of the ternary operator cond ? thenExpr : elseExpr
no-undef-init Warning - It is not necessary to initialize '{variable}' to 'undefined'.  
no-unused-params Warning - "Parameter '{param}' is not used." Flags parameters in function declarations / expressions if they are not being used
no-undef Error 5.0 '{variable}' is not defined.
  • Flags references to a global variable that is not listed in a /*global*/ or /*globals*/ block.
  • Predefined environments (eg. node, browser) can be set in the /*jslint */ block.
no-underscore-dangle Ignore - Dangling '_'  
no-unreachable Error - Unreachable code. Flags statements that occur after a return, throw, etc.
no-unused-expressions Warning - Expected an assignment or function call and instead saw an expression. Flags expressions that appear in a statement context and don't cause side effects.
no-unused-vars Warning 5.0 Function declares unused variable '{a}'.  
no-use-before-define Warning 5.0 '{a}' was used before it was defined.  
no-with Warning - Expected an identifier and instead saw 'with'. Treated as fatal parse error in JSLint.
no-wrap-func Ignore - Do not wrap function literals in parens unless they are to be immediately invoked. Flags a parenthesized function literal that is not immediately invoked, eg. (function fun(){})
object-prototype-external Warning -   Flags calls to methods of Object.prototype that rely on the prototype chain. For example this code should be flagged: 
  1. foo.hasOwnProperty("bar")

Example (1) is unsafe, as foo may have a property named hasOwnProperty, or have been constructed via Object.create(null).

As for this: 

  1. Object.hasOwnProperty.call(foo, "bar")

Example (2) technically relies on the prototype chain as well: the hasOwnProperty method is defined on Object.prototype, not Object. Object inherits the methods of Object.prototype through its prototype chain. However (2) is unlikely to fail, as sane JavaScript programs will not modify the global objects' prototypes. If we choose to flag (2), it should only be for style.

one-var Warning - Too many var statements. Allows only 1 var statement per function.
quote-props Warning -   Requires object literal keys to be quoted with " or '.
quotes Ignore -   Flags any use of single or double quote marks, depending on setting.
radix Warning - Missing radix parameter. Affects parseInt().
regex-spaces Warning - Spaces are hard to count. Use {n}.  
semi Warning 5.0 Missing semicolon.  
strict Ignore -   Flags any code that lacks the "use strict" pragma.
throw-error Warning 7.0   Flags code that throws a non-Error, eg. throw "a problem occurred";
unnecessary-strict Warning -   Flags "use strict" on a function when the entire Program is already in strict mode.
use-isnan Error 6.0 Use the isNaN function to compare with NaN.  
wrap-iife Ignore -
  • Wrap the entire immediate function invocation in parens.
  • Move the invocation into the parens that contain the function.
 Flags missing parens on immediately-invoked functions, eg. function(){ console.log('hi'); }();
wrap-regex Warning - Wrap the /regexp/ literal in parens to disambiguate the slash operator.  

Tests

  • Every rule needs extensive unit tests
  • Unit tests should use Mocha

Currently the tests are run from Node.js. They do not run in the browser (yet).

Test requirements

First install Node.js. Then open a console and install Mocha globally: 

$ npm install mocha -g

Then from your Orion client repository, run these commands to install eslint's dependencies: 

$ cd bundles/org.eclipse.orion.client.javascript/web/eslint/
$ npm install

Running the tests

From the bundles/org.eclipse.orion.client.javascript/web/eslint/ directory, simply run npm test: 

$ npm test

> eslint@0.2.0-dev test c:\Users\mamacdon\code\orion\client\bundles\org.eclipse.orion.client.javascript\web\eslint
> bash scripts/test.sh


  ......................................................................
  ...............

  85 passing (106ms)

To run only a subset of the tests, launch mocha from the command line, passing the test file: 

$ mocha tests/lib/rules/semi.js

  ............

  12 passing (17ms)

You can also pass an entire directory: 

$ mocha tests/lib/rules

  ......................................................................
  ..........

  80 passing (104ms)

To run only some tests from a file, use the --grep option: 

$ mocha tests/lib/rules/semi.js --grep VariableDeclaration

  .

  1 passing (5ms)

See Mocha usage options for more.

User interface

  • Should we have a UI for configuring what rules are active? bug 424268.
  • Should we try to support .eslintrc? This would be an ideal project-scope setting.
  • Should we try to honor equivalent JSLint/JSHint flags when possible? For example /*jslint eqeqeq:false */ could disable the eqeqeq rule on a per-file basis.
    • This would give compatibility with Orion codebase which uses these flags.
    • OTOH, eslint now has its own syntax for this: /*eslint ..*/, which we should perhaps use instead.

i18n

We need to support i18n. Pre-req is bug 422278 (orion.edit.validator support for i18n).

Retrieved from "https://wiki.eclipse.org/index.php?title=Orion/ESLint&oldid=366970"

Back to the top