docs(eslint-plugin): explicit-function-return-type: missing allowFunc…

…tionsWithoutTypeParameters sections (#6475) docs: explicit-function-return-type/allowFunctionsWithoutTypeParameters
typescript-eslint · Feb 15, 2023 · fc803cc · fc803cc
1 parent c46c793
commit fc803cc
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 0 deletions.
diff --git a/packages/eslint-plugin/docs/rules/explicit-function-return-type.md b/packages/eslint-plugin/docs/rules/explicit-function-return-type.md
@@ -242,6 +242,38 @@ const log = (message: string) => {
 var log = (message: string) => void console.log(message);
 ```
 
+### `allowFunctionsWithoutTypeParameters`
+
+Examples of code for this rule with `{ allowFunctionsWithoutTypeParameters: true }`:
+
+<!--tabs-->
+
+#### ❌ Incorrect
+
+```ts
+function foo<T>(t: T) {
+  return t;
+}
+
+const bar = <T>(t: T) => t;
+```
+
+#### ✅ Correct
+
+```ts
+function foo<T>(t: T): T {
+  return t;
+}
+
+const bar = <T>(t: T): T => t;
+
+const allowedFunction(x: string) {
+  return x;
+}
+
+const allowedArrow = (x: string) => x;
+```
+
 ### `allowedNames`
 
 You may pass function/method names you would like this rule to ignore, like so:

diff --git a/packages/eslint-plugin/src/rules/explicit-function-return-type.ts b/packages/eslint-plugin/src/rules/explicit-function-return-type.ts
@@ -93,6 +93,7 @@ export default util.createRule<Options, MessageIds>({
       allowHigherOrderFunctions: true,
       allowDirectConstAssertionInArrowFunctions: true,
       allowConciseArrowFunctionExpressionsStartingWithVoid: false,
+      allowFunctionsWithoutTypeParameters: false,
       allowedNames: [],
       allowIIFEs: false,
     },