Package Exports

coffeelint-alphabetize-keys

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (coffeelint-alphabetize-keys) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

coffeelint-alphabetize-keys

Coffeelint rule requiring objects to have keys in alphabetical order

Installation

npm install coffeelint-alphabetize-keys

Usage

Put this in your coffeelint config:

"alphabetize_keys": {
  "module": "coffeelint-alphabetize-keys"
}

Configuration options

overrides - Array of keys to order as a separate category, keys must appear in the order provided.

Examples

Objects

{keyA, keyB, keyC} # Good
{keyC, keyB, keyA} # Bad

The rule applies to both defining and destructing objects.

Classes

# Good
class A
  methodA: ->
  methodB: ->
  methodC: ->

# Bad
class A
  methodC: ->
  methodB: ->
  methodA: ->

The keys are broken down into 8 categories and each are required to only be individually alphabetical. Keys are separated based on:

function vs variable (based on the type of the value)
public vs private (key starting with _ is private)
instance vs static

The constructor function is ignored.

Overrides

"alphabetize_keys": {
  "module": "coffeelint-alphabetize-keys",
  "overrides": ["methodC", "methodB", "methodA"]
}

# Good
class A
  methodC: ->
  methodB: ->
  methodA: ->

# Bad
class A
  methodA: ->
  methodB: ->
  methodC: ->