feat(plugins): added eslint-plugin-remeda support

Fixes #209
AndreaPontrandolfo · Sep 16, 2024 · 5dc6228 · 5dc6228
1 parent f2bab54
commit 5dc6228
Show file tree

Hide file tree

Showing 26 changed files with 137 additions and 20 deletions.
diff --git a/apps/config-validation-playground/eslint.config.js b/apps/config-validation-playground/eslint.config.js
@@ -4,6 +4,7 @@ import { defineFlatConfig } from 'eslint-define-config';
 const sheriffOptions = {
   react: true,
   lodash: true,
+  remeda: true,
   next: true,
   playwright: true,
   jest: false,

diff --git a/apps/docs-website/docs/configuration.mdx b/apps/docs-website/docs/configuration.mdx
@@ -36,6 +36,7 @@ const sheriffOptions = {
   next: false,
   astro: false,
   lodash: false,
+  remeda: false,
   playwright: false,
   jest: false,
   vitest: false,
@@ -60,6 +61,7 @@ const sheriffOptions: SheriffSettings = {
   next: false,
   astro: false,
   lodash: false,
+  remeda: false,
   playwright: false,
   jest: false,
   vitest: false,
@@ -90,6 +92,7 @@ const sheriffOptions = {
   next: false,
   astro: false,
   lodash: false,
+  remeda: false,
   playwright: false,
   jest: false,
   vitest: false,
@@ -119,6 +122,7 @@ const sheriffOptions: SheriffSettings = {
   next: false,
   astro: false,
   lodash: false,
+  remeda: false,
   playwright: false,
   jest: false,
   vitest: false,
@@ -152,6 +156,7 @@ const sheriffOptions = {
   next: false,
   astro: false,
   lodash: false,
+  remeda: false,
   playwright: false,
   jest: false,
   vitest: false,
@@ -181,6 +186,7 @@ const sheriffOptions: SheriffSettings = {
   next: false,
   astro: false,
   lodash: false,
+  remeda: false,
   playwright: false,
   jest: false,
   vitest: false,
@@ -245,6 +251,7 @@ const sheriffOptions = {
   next: false,
   astro: false,
   lodash: false,
+  remeda: false,
   playwright: false,
   jest: false,
   vitest: false,
@@ -271,6 +278,7 @@ const sheriffOptions: SheriffSettings = {
   next: false,
   astro: false,
   lodash: false,
+  remeda: false,
   playwright: false,
   jest: false,
   vitest: false,
@@ -305,6 +313,7 @@ const sheriffOptions = {
   next: false,
   astro: false,
   lodash: false,
+  remeda: false,
   playwright: false,
   jest: false,
   vitest: false,
@@ -331,6 +340,7 @@ const sheriffOptions: SheriffSettings = {
   next: false,
   astro: false,
   lodash: false,
+  remeda: false,
   playwright: false,
   jest: false,
   vitest: false,
@@ -380,6 +390,7 @@ const sheriffOptions = {
   next: false,
   astro: false,
   lodash: false,
+  remeda: false,
   playwright: false,
   jest: false,
   vitest: false,
@@ -405,6 +416,7 @@ const sheriffOptions: SheriffSettings = {
   next: false,
   astro: false,
   lodash: false,
+  remeda: false,
   playwright: false,
   jest: false,
   vitest: false,
@@ -446,6 +458,7 @@ const sheriffOptions = {
   next: false,
   astro: false,
   lodash: false,
+  remeda: false,
   playwright: false,
   jest: false,
   vitest: false,
@@ -476,6 +489,7 @@ const sheriffOptions: SheriffSettings = {
   next: false,
   astro: false,
   lodash: false,
+  remeda: false,
   playwright: false,
   jest: false,
   vitest: false,
@@ -520,6 +534,7 @@ const sheriffOptions = {
   next: false,
   astro: false,
   lodash: false,
+  remeda: false,
   playwright: false,
   jest: false,
   vitest: false,
@@ -553,6 +568,7 @@ const sheriffOptions: SheriffSettings = {
   next: false,
   astro: false,
   lodash: false,
+  remeda: false,
   playwright: false,
   jest: false,
   vitest: false,
@@ -595,6 +611,7 @@ const sheriffOptions = {
   next: false,
   astro: false,
   lodash: false,
+  remeda: false,
   playwright: false,
   jest: false,
   vitest: false
@@ -629,6 +646,7 @@ const sheriffOptions: SheriffSettings = {
   next: false,
   astro: false,
   lodash: false,
+  remeda: false,
   playwright: false,
   jest: false,
   vitest: false
@@ -673,6 +691,7 @@ const sheriffOptions = {
   next: false,
   astro: false,
   lodash: false,
+  remeda: false,
   playwright: false,
   jest: false,
   vitest: false
@@ -706,6 +725,7 @@ const sheriffOptions: SheriffSettings = {
   next: false,
   astro: false,
   lodash: false,
+  remeda: false,
   playwright: false,
   jest: false,
   vitest: false

diff --git a/apps/docs-website/docs/eslint-plugins.md b/apps/docs-website/docs/eslint-plugins.md
@@ -21,6 +21,7 @@ sidebar_position: 7
 - [@vitest/eslint-plugin](https://github.com/vitest-dev/eslint-plugin-vitest)
 - [eslint-plugin-import](https://github.com/import-js/eslint-plugin-import) with [eslint-import-resolver-typescript](https://github.com/import-js/eslint-import-resolver-typescript)
 - [eslint-plugin-lodash-f](https://github.com/AndreaPontrandolfo/eslint-plugin-lodash) (my fork of [eslint-plugin-lodash](https://github.com/wix/eslint-plugin-lodash))
+- [eslint-plugin-remeda](https://github.com/AndreaPontrandolfo/eslint-plugin-remeda)
 - [@next/eslint-plugin-next](https://www.npmjs.com/package/@next/eslint-plugin-next)
 - [eslint-plugin-playwright](https://github.com/playwright-community/eslint-plugin-playwright)
 - [eslint-plugin-storybook](https://github.com/storybookjs/eslint-plugin-storybook)

diff --git a/apps/docs-website/docs/migration-guide.mdx b/apps/docs-website/docs/migration-guide.mdx
@@ -37,6 +37,7 @@ const sheriffOptions = {
   next: false,
   astro: false,
   lodash: false,
+  remeda: false,
   playwright: false,
   jest: false,
   vitest: false,
@@ -60,6 +61,7 @@ const sheriffOptions: SheriffSettings = {
   next: false,
   astro: false,
   lodash: false,
+  remeda: false,
   playwright: false,
   jest: false,
   vitest: false,

diff --git a/apps/docs-website/docs/performance-considerations.mdx b/apps/docs-website/docs/performance-considerations.mdx
@@ -51,6 +51,7 @@ const sheriffOptions = {
   next: false,
   astro: false,
   lodash: false,
+  remeda: false,
   playwright: false,
   jest: false,
   vitest: false,
@@ -80,6 +81,7 @@ const sheriffOptions: SheriffSettings = {
   next: false,
   astro: false,
   lodash: false,
+  remeda: false,
   playwright: false,
   jest: false,
   vitest: false,

diff --git a/apps/docs-website/docs/setup/manual-setup.mdx b/apps/docs-website/docs/setup/manual-setup.mdx
@@ -27,6 +27,7 @@ Follow these steps:
       next: false,
       astro: false,
       lodash: false,
+      remeda: false,
       playwright: false,
       jest: false,
       vitest: false,
@@ -51,6 +52,7 @@ Follow these steps:
       next: false,
       astro: false,
       lodash: false,
+      remeda: false,
       playwright: false,
       jest: false,
       vitest: false,
@@ -85,6 +87,7 @@ Follow these steps:
           next: false,
           astro: false,
           lodash: false,
+          remeda: false,
           playwright: false,
           jest: false,
           vitest: false,

diff --git a/apps/docs-website/docs/techs.md b/apps/docs-website/docs/techs.md
@@ -4,14 +4,15 @@ sidebar_position: 4
 
 # 🖥️ Techs
 
-- [Eslint](https://eslint.org/)
-- [Prettier](https://prettier.io/)
-- [Typescript](https://www.typescriptlang.org/) (_out of the box support_)
-- [Storybook](https://storybook.js.org/) (_out of the box support_)
-- [Astro](https://astro.build/) (_opt-in_)
-- [React](https://reactjs.org/) (_opt-in_)
-- [Next](https://nextjs.org/) (_opt-in_)
-- [Lodash](https://lodash.com/) (_opt-in_)
-- [Playwright](https://playwright.dev/) (_opt-in_)
-- [Jest](https://jestjs.io/) (_opt-in_)
-- [Vitest](https://vitest.dev/) (_opt-in_)
+- [Eslint](https://eslint.org)
+- [Prettier](https://prettier.io)
+- [Typescript](https://www.typescriptlang.org) (_out of the box support_)
+- [Storybook](https://storybook.js.org) (_out of the box support_)
+- [Astro](https://astro.build) (_opt-in_)
+- [React](https://reactjs.org) (_opt-in_)
+- [Next](https://nextjs.org) (_opt-in_)
+- [Lodash](https://lodash.com) (_opt-in_)
+- [Remeda](https://remedajs.com) (_opt-in_)
+- [Playwright](https://playwright.dev) (_opt-in_)
+- [Jest](https://jestjs.io) (_opt-in_)
+- [Vitest](https://vitest.dev) (_opt-in_)
diff --git a/apps/docs-website/eslint.config.mjs b/apps/docs-website/eslint.config.mjs
@@ -6,6 +6,7 @@ import { flat, flatCodeBlocks, createRemarkProcessor } from 'eslint-plugin-mdx';
 const sheriffOptions = {
   react: true,
   lodash: true,
+  remeda: false,
   next: false,
   astro: false,
   playwright: false,

diff --git a/apps/docs-website/src/components/ComparisonTable.tsx b/apps/docs-website/src/components/ComparisonTable.tsx
@@ -22,6 +22,7 @@ interface TableEntry {
   TSDoc: '✅' | '❌';
   Import: '✅' | '❌';
   Lodash: '✅' | '❌';
+  Remeda: '✅' | '❌';
   Nextjs: '✅' | '❌';
   Jest: '✅' | '❌';
   Vitest: '✅' | '❌';
@@ -67,6 +68,7 @@ const entriesTable: EntriesTable = {
     TSDoc: '✅',
     Import: '✅',
     Lodash: '✅',
+    Remeda: '✅',
     Nextjs: '✅',
     Jest: '✅',
     Vitest: '✅',
@@ -97,6 +99,7 @@ const entriesTable: EntriesTable = {
     TSDoc: '❌',
     Import: '✅',
     Lodash: '❌',
+    Remeda: '❌',
     Nextjs: '❌',
     Jest: '❌',
     Vitest: '❌',
@@ -127,6 +130,7 @@ const entriesTable: EntriesTable = {
     TSDoc: '❌',
     Import: '✅',
     Lodash: '❌',
+    Remeda: '❌',
     Nextjs: '❌',
     Jest: '❌',
     Vitest: '❌',
@@ -157,6 +161,7 @@ const entriesTable: EntriesTable = {
     TSDoc: '❌',
     Import: '✅',
     Lodash: '❌',
+    Remeda: '❌',
     Nextjs: '❌',
     Jest: '❌',
     Vitest: '❌',
@@ -187,6 +192,7 @@ const entriesTable: EntriesTable = {
     TSDoc: '❌',
     Import: '✅',
     Lodash: '❌',
+    Remeda: '❌',
     Nextjs: '✅',
     Jest: '❌',
     Vitest: '✅',
@@ -217,6 +223,7 @@ const entriesTable: EntriesTable = {
     TSDoc: '❌',
     Import: '✅',
     Lodash: '❌',
+    Remeda: '❌',
     Nextjs: '❌',
     Jest: '❌',
     Vitest: '❌',
@@ -247,6 +254,7 @@ const entriesTable: EntriesTable = {
     TSDoc: '❌',
     Import: '✅',
     Lodash: '✅',
+    Remeda: '❌',
     Nextjs: '✅',
     Jest: '✅',
     Vitest: '✅',
@@ -277,6 +285,7 @@ const entriesTable: EntriesTable = {
     TSDoc: '❌',
     Import: '✅',
     Lodash: '❌',
+    Remeda: '❌',
     Nextjs: '✅',
     Jest: '❌',
     Vitest: '❌',
@@ -307,6 +316,7 @@ const entriesTable: EntriesTable = {
     TSDoc: '❌',
     Import: '✅',
     Lodash: '❌',
+    Remeda: '❌',
     Nextjs: '✅',
     Jest: '✅',
     Vitest: '❌',
@@ -337,6 +347,7 @@ const entriesTable: EntriesTable = {
     TSDoc: '❌',
     Import: '✅',
     Lodash: '❌',
+    Remeda: '❌',
     Nextjs: '❌',
     Jest: '✅',
     Vitest: '❌',

diff --git a/apps/docs-website/src/components/ConfigCombinationForm.tsx b/apps/docs-website/src/components/ConfigCombinationForm.tsx
@@ -11,6 +11,7 @@ interface ConfigCombinationFormProps {
 interface FormInputs {
   react: boolean;
   lodash: boolean;
+  remeda: boolean;
   next: boolean;
   playwright: boolean;
   vitest: boolean;
@@ -65,6 +66,15 @@ export const ConfigCombinationForm = ({
         />
         <label htmlFor="lodash">Lodash</label>
       </div>
+      <div className={styles.nativeCheckbox}>
+        <input
+          {...register('remeda')}
+          defaultChecked
+          type="checkbox"
+          id="remeda"
+        />
+        <label htmlFor="remeda">Remeda</label>
+      </div>
       <div className={styles.nativeCheckbox}>
         <input {...register('next')} defaultChecked type="checkbox" id="next" />
         <label htmlFor="next">Next</label>

diff --git a/apps/sheriff-webservices/eslint.config.js b/apps/sheriff-webservices/eslint.config.js
@@ -4,6 +4,7 @@ import { defineFlatConfig } from 'eslint-define-config';
 const sheriffOptions = {
   react: false,
   lodash: true,
+  remeda: false,
   next: false,
   astro: false,
   playwright: false,

diff --git a/apps/sheriff-webservices/package.json b/apps/sheriff-webservices/package.json
@@ -46,6 +46,7 @@
     "eslint-plugin-react": "^7.35.0",
     "eslint-plugin-react-hooks": "^4.6.0",
     "eslint-plugin-react-refresh": "^0.4.3",
+    "eslint-plugin-remeda": "^1.4.0",
     "eslint-plugin-simple-import-sort": "^12.1.0",
     "eslint-plugin-sonarjs": "^1.0.4",
     "eslint-plugin-storybook": "^0.6.11",