Merge pull request babel/eslint-plugin-babel#57 from nmote/docs

Add docs for flow-object-type rule
This commit is contained in:
Henry Zhu 2016-04-07 18:24:59 -04:00
parent 5363ff85cc
commit ba2b2bc04d

View File

@ -32,7 +32,8 @@ original ones as well!).
"babel/object-curly-spacing": 1,
"babel/object-shorthand": 1,
"babel/arrow-parens": 1,
"babel/no-await-in-loop": 1
"babel/no-await-in-loop": 1,
"babel/flow-object-type": 1
}
}
```
@ -46,4 +47,11 @@ Each rule corresponds to a core `eslint` rule, and has the same options.
- `babel/object-curly-spacing`: doesn't complain about `export x from "mod";` or `export * as x from "mod";`
- `babel/object-shorthand`: doesn't fail when using object spread (`...obj`)
- `babel/arrow-parens`: Handles async functions correctly
The following rules are not in `eslint`, but are relevant only to syntax that is not specified by
the current JavaScript standard or supported by `eslint`.
- `babel/no-await-in-loop`: guard against awaiting async functions inside of a loop
- `babel/flow-object-type`: Require a particular separator between properties in Flow object types.
- Use the option `semicolon` to require semicolons (e.g. `type Foo = { bar: number; baz: string }`).
- Use the option `comma` to require commas (e.g. `type Foo = { bar: number, baz: string }`).