Add notice to arrow-return-shorthand converter (#681)

* Add notice to arrow-return-shorthand converter

* Update src/rules/converters/arrow-return-shorthand.ts

Co-authored-by: Josh Goldberg <[email protected]>

Author: KingDarBoja

src/rules/converters/arrow-return-shorthand.ts

@@ -1,5 +1,8 @@
 import { RuleConverter } from "../converter";
 
+export const ARROW_RETURN_NOTICE =
+    "ESLint will throw an error if the function body is multiline yet has a one-line return on it.";
+
 export const convertArrowReturnShorthand: RuleConverter = (tslintRule) => {
     return {
         rules: [
@@ -9,6 +12,7 @@ export const convertArrowReturnShorthand: RuleConverter = (tslintRule) => {
                         ruleArguments: ["always"],
                     }),
                 ruleName: "arrow-body-style",
+                notices: [ARROW_RETURN_NOTICE],
             },
         ],
     };

src/rules/converters/tests/arrow-return-shorthand.test.ts

@@ -1,4 +1,4 @@
-import { convertArrowReturnShorthand } from "../arrow-return-shorthand";
+import { convertArrowReturnShorthand, ARROW_RETURN_NOTICE } from "../arrow-return-shorthand";
 
 describe(convertArrowReturnShorthand, () => {
     test("conversion without arguments", () => {
@@ -10,6 +10,7 @@ describe(convertArrowReturnShorthand, () => {
             rules: [
                 {
                     ruleName: "arrow-body-style",
+                    notices: [ARROW_RETURN_NOTICE],
                 },
             ],
         });
@@ -25,6 +26,7 @@ describe(convertArrowReturnShorthand, () => {
                 {
                     ruleArguments: ["always"],
                     ruleName: "arrow-body-style",
+                    notices: [ARROW_RETURN_NOTICE],
                 },
             ],
         });