Add option for object-literal-sort-keys to not ignore blank lines

[dmitryshimkin]

Bug Report

• TSLint version: 5.17.0
• TypeScript version: 2.7.2
• Running TSLint via: CLI

TypeScript code being linted

const test = {
  b: 'b',

  a: 'a',

  c: 'c',
};

with tslint.json configuration:

"object-literal-sort-keys": [
  true,
  "ignore-case",
  "locale-compare"
]

Actual behavior

No lint errors

Expected behavior

"Properties are not sorted" error.

[ghost]

After see the rule documentation seems the correct behavior:

When using the default alphabetical ordering, additional blank lines may be used to group object properties together while keeping the elements within each group in alphabetical order.

[dmitryshimkin]

After see the rule documentation seems the correct behavior:

When using the default alphabetical ordering, additional blank lines may be used to group object properties together while keeping the elements within each group in alphabetical order.

Right, according to the docs it seems to be expected behaviour. Now I wonder if there is a way to opt out this. Otherwise, this rule cannot be used in cases when all properties are separated with blank lines for better readability.

[JoshuaKGoldberg]

Seems like a reasonable idea - accepting PRs to add an option to not ignore blank lines.

Do keep #4534 in mind: custom rules including forks of built-in rules such as object-literal-sort-keys are always an option and can be maintained outside this repo.