Merge pull request #632 from palantir/sort-keys-doc

Add documentation for sort-object-literal-keys rule
palantir · Sep 2, 2015 · f1e4aa6 · f1e4aa6
2 parents fca2a66 + 404cadd
commit f1e4aa6
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -194,6 +194,7 @@ A sample configuration file with all options is available [here](https://github.
     * `"double"` enforces double quotes
 * `radix` enforces the radix parameter of `parseInt`
 * `semicolon` enforces semicolons at the end of every statement.
+* `sort-object-literal-keys` checks that keys in object literals are declared in alphabetical order
 * `switch-default` enforces a `default` case in `switch` statements.
 * `triple-equals` enforces === and !== in favor of == and !=.
 * `typedef` enforces type definitions to exist. Rule options:

diff --git a/docs/sample.tslint.json b/docs/sample.tslint.json
@@ -65,6 +65,7 @@
     "quotemark": [true, "double"],
     "radix": true,
     "semicolon": true,
+    "sort-object-literal-keys": true,
     "switch-default": true,
     "triple-equals": [true, "allow-null-check"],
     "typedef": [true,