fix(config): update lint to naming-convention rule

ssube · Jul 29, 2020 · 8db6b43 · 8db6b43
1 parent 7d525fc
commit 8db6b43
Show file tree

Hide file tree

Showing 2 changed files with 42 additions and 4 deletions.
diff --git a/config/eslint.json b/config/eslint.json
@@ -35,7 +35,6 @@
                 }
             }
         ],
-        "@typescript-eslint/class-name-casing": "error",
         "@typescript-eslint/consistent-type-assertions": "error",
         "@typescript-eslint/consistent-type-definitions": "error",
         "@typescript-eslint/explicit-member-accessibility": [
@@ -61,7 +60,6 @@
                 "SwitchCase": 1
             }
         ],
-        "@typescript-eslint/interface-name-prefix": "error",
         "@typescript-eslint/member-delimiter-style": [
             "error",
             {
@@ -89,6 +87,45 @@
                 ]
             }
         ],
+        "@typescript-eslint/naming-convention": [
+            "error",
+            {
+                "selector": "default",
+                "format": [
+                    "camelCase"
+                ],
+                "leadingUnderscore": "forbid",
+                "trailingUnderscore": "forbid"
+            },
+            {
+                "selector": "variable",
+                "format": [
+                    "camelCase",
+                    "UPPER_CASE"
+                ],
+                "leadingUnderscore": "forbid",
+                "trailingUnderscore": "forbid"
+            },
+            {
+                "selector": "typeLike",
+                "format": [
+                    "PascalCase"
+                ],
+                "leadingUnderscore": "forbid",
+                "trailingUnderscore": "forbid"
+            },
+            {
+                "selector": "interface",
+                "format": [
+                    "PascalCase"
+                ],
+                "leadingUnderscore": "forbid",
+                "trailingUnderscore": "forbid",
+                "prefix": [
+                    "I"
+                ]
+            }
+        ],
         "@typescript-eslint/no-empty-function": "error",
         "@typescript-eslint/no-empty-interface": "error",
         "@typescript-eslint/no-explicit-any": "error",
@@ -154,6 +191,7 @@
             "error",
             "any",
             "Number",
+            "String",
             "Boolean",
             "Undefined"
         ],

diff --git a/docs/api/js-utils.timeout.md b/docs/api/js-utils.timeout.md
@@ -9,7 +9,7 @@ Reject after a set amount of time if the original promise has not yet resolved.
 <b>Signature:</b>
 
 ```typescript
-export declare function timeout<T>(ms: number, oper: Promise<T>): Promise<T>;
+export declare function timeout<T>(ms: number, oper: Promise<T>): Promise<Optional<T>>;
 ```
 
 ## Parameters
@@ -21,5 +21,5 @@ export declare function timeout<T>(ms: number, oper: Promise<T>): Promise<T>;
 
 <b>Returns:</b>
 
-Promise&lt;T&gt;
+Promise&lt;[Optional](./js-utils.optional.md)<!-- -->&lt;T&gt;&gt;