Codecov Report

Merging #261 into master will increase coverage by 0.03%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master     #261      +/-   ##
==========================================
+ Coverage    94.6%   94.63%   +0.03%     
==========================================
  Files          65       66       +1     
  Lines        2778     2794      +16     
  Branches      720      723       +3     
==========================================
+ Hits         2628     2644      +16     
  Misses         57       57              
  Partials       93       93

Thank you for the review!

I updated this PR.

Do we want to add an option ignoreStringArray (which is turned off by default), which allows people to ignore the string[] case?

I'm just thinking - I can see some people getting annoyed at this rule for two reasons:

1. they like using the default function on string[], and don't want have to create a function which does the same thing as default (a,b) => a < b.
2. String#localeCompare can sometimes be dangerous because it uses the javascript context's current locale - which can mean that depending on the user's settings you might produce an unintended sort order.

1. they like using the default function on string[], and don't want have to create a function which does the same thing as default (a,b) => a < b.

People can use undefined instead of a function as well.

2. String#localeCompare can sometimes be dangerous because it uses the javascript context's current locale - which can mean that depending on the user's settings you might produce an unintended sort order.

String#localCompare has some options.
People can specify arbitary locale and options such as sensitivity, numeric, caseFirst, and etc.

I don't oppose the option, but I'm not sure if it's needed. I think, maybe, we can discuss it on another issue.

Figured it was worth raising just so we all thought about it.

I'm more happy to punt on it till someone asks for it :)

@mysticatea You forgot to add the rule to https://github.com/typescript-eslint/typescript-eslint/tree/master/packages/eslint-plugin#supported-rules

weird... that should have been caught by the CI.

we are not running eslint-docs check anymore, we have to update it first (support for scoped packages) and add it to CI

@armano2 I pushed the update that adds support for scoped packages (v0.4.0).