docs: no-primitive-constructor-types

gajus · Nov 27, 2016 · 0d2e10f · 0d2e10f
1 parent 0d37f03
commit 0d2e10f
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/.README/README.md b/.README/README.md
@@ -50,6 +50,7 @@ npm install eslint-plugin-flowtype
       2,
       "never"
     ],
+    "flowtype/no-primitive-constructor-types": 2,
     "flowtype/no-weak-types": 2,
     "flowtype/object-type-delimiter": [
       2,
@@ -145,6 +146,7 @@ When `true`, only checks files with a [`@flow` annotation](http://flowtype.org/d
 {"gitdown": "include", "file": "./rules/delimiter-dangle.md"}
 {"gitdown": "include", "file": "./rules/generic-spacing.md"}
 {"gitdown": "include", "file": "./rules/no-dupe-keys.md"}
+{"gitdown": "include", "file": "./rules/no-primitive-constructor-types.md"}
 {"gitdown": "include", "file": "./rules/no-weak-types.md"}
 {"gitdown": "include", "file": "./rules/object-type-delimiter.md"}
 {"gitdown": "include", "file": "./rules/require-parameter-type.md"}

diff --git a/.README/rules/no-primitive-constructor-types.md b/.README/rules/no-primitive-constructor-types.md
@@ -0,0 +1,13 @@
+### `no-primitive-constructor-types`
+
+Disallows use of primitive constructors as types, such as `Boolean`, `Number` and `String`. [See more](https://flowtype.org/docs/builtins.html).
+
+```js
+{
+    "rules": {
+        "flowtype/no-primitive-constructor-types": 2
+    }
+}
+```
+
+<!-- assertions noPrimitiveConstructorTypes -->