Merge pull request #6 from abailly-akamai/M3-8552

[M3-8552] - Add new deprecated formik rule

src/index.ts

@@ -1,5 +1,7 @@
 import { noCustomFontWeight } from './rules/no-custom-fontWeight';
+import { deprecateFormik } from './rules/deprecate-formik';
 
 export const rules = {
   'no-custom-fontWeight': noCustomFontWeight,
+  'deprecate-formik': deprecateFormik,
 };

src/rules/deprecate-formik.ts

@@ -0,0 +1,31 @@
+import type { Rule } from 'eslint';
+
+/**
+ * Warn about Formik usage.
+ * Promote the use of React Hook Form.
+ */
+export const deprecateFormik: Rule.RuleModule = {
+  meta: {
+    type: 'suggestion',
+    docs: {
+      description: 'Warn about Formik being deprecated in favor of react-hook-form',
+      category: 'Best Practices',
+      recommended: false,
+    },
+    messages: {
+      formikUsage: 'Formik is being deprecated. Please use react-hook-form.',
+    },
+  },
+  create(context) {
+    return {
+      Identifier(node) {
+        if (node.name === 'useFormik' || node.name === 'Formik') {
+          context.report({
+            node,
+            messageId: 'formikUsage',
+          });
+        }
+      },
+    };
+  },
+};