Introduce new linting setup (#1341)

* Setup new scripts stuff * Run lint & prettier - again
saleor · Oct 10, 2024 · ee6cb1a · ee6cb1a
1 parent c432da0
commit ee6cb1a
Show file tree

Hide file tree

Showing 56 changed files with 988 additions and 588 deletions.
diff --git a/.eslintignore b/.eslintignore
@@ -0,0 +1,6 @@
+.docusaurus/
+docusaurus.config.js
+build/
+docs/
+examples/
+template/
diff --git a/.eslintrc b/.eslintrc
@@ -0,0 +1,38 @@
+{
+  "$schema": "https://json.schemastore.org/eslintrc.json",
+  "extends": ["eslint:recommended", "plugin:react/recommended"],
+  "overrides": [
+    {
+      "files": ["*.mdx"],
+      "extends": "plugin:mdx/recommended"
+    }
+  ],
+  "parserOptions": {
+    "ecmaFeatures": {
+      "jsx": true
+    },
+    "ecmaVersion": "latest",
+    "sourceType": "module"
+  },
+  "env": {
+    "browser": true,
+    "node": true,
+    "es6": true
+  },
+  "rules": {
+    "react/prop-types": "off",
+    "simple-import-sort/imports": "error",
+    "simple-import-sort/exports": "error",
+    "no-unused-vars": [
+      "error",
+      { "argsIgnorePattern": "^_", "varsIgnorePattern": "^_" }
+    ]
+  },
+  "plugins": ["import", "simple-import-sort", "react"],
+  "settings": {
+    "mdx/code-blocks": true,
+    "react": {
+      "version": "detect"
+    }
+  }
+}
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -6,6 +6,9 @@ on:
       - main
   pull_request:
 
+env:
+  HUSKY: 0
+
 jobs:
   build:
     runs-on: ubuntu-22.04
@@ -19,4 +22,6 @@ jobs:
 
       - run: npm ci
 
+      - run: npm run lint
+
       - run: npm run build
diff --git a/.github/workflows/update-api-reference.yml b/.github/workflows/update-api-reference.yml
@@ -5,6 +5,9 @@ on:
   # schedule:
   #   - cron: "0 20 * * 1-5" # workdays at 20:00
 
+env:
+  HUSKY: 0
+
 jobs:
   check_saleor_release:
     name: Update API reference based on the latest Saleor release
@@ -42,7 +45,7 @@ jobs:
         run: npm run update-api-reference
 
       - name: Lint changes
-        run: npx pretty-quick
+        run: npm run lint
 
       - name: Show changed files
         run: git status

diff --git a/.github/workflows/update-cli-docs.yml b/.github/workflows/update-cli-docs.yml
@@ -5,6 +5,9 @@ on:
   # schedule:
   #   - cron: "10 20 * * 1-5" # workdays at 20:10
 
+env:
+  HUSKY: 0
+
 jobs:
   check_saleor_release:
     name: Update CLI docs
@@ -35,7 +38,7 @@ jobs:
       - run: npm ci
 
       - name: Lint changes
-        run: npx pretty-quick
+        run: npm run lint
 
       - name: Show changed files
         run: git status

diff --git a/.gitignore b/.gitignore
@@ -1,18 +1,18 @@
 .*
-!.circleci
 !.dockerignore
 !.github
 !.husky
 !.vscode
 !.remarkrc
-!.prettierignore
 !.nvmrc
+!.eslintignore
+!.eslintrc
+!.gitignore
+!.lintstagedrc
+!.prettierrc
+!.prettierignore
 
-node_modules
+node_modules/
 
 build/
-.vercel
-
-scripts/sitemap_new.xml
-scripts/sitemap_old.xml
-vercel2.json
+.vercel/
diff --git a/.husky/pre-commit b/.husky/pre-commit
@@ -1,4 +1 @@
-#!/usr/bin/env sh
-
-npx pretty-quick --staged
-npm run lint
+pnpm lint-staged
diff --git a/.lintstagedrc b/.lintstagedrc
@@ -0,0 +1,5 @@
+{
+  "$schema": "https://json.schemastore.org/lintstagedrc.schema.json",
+  "*.{js,ts,tsx,jsx}": "eslint --cache --fix",
+  "*": "prettier --write --ignore-unknown"
+}
diff --git a/.prettierignore b/.prettierignore
@@ -1 +1,3 @@
 **/*.mdx
+build/
+.docusaurus/
diff --git a/.prettierrc b/.prettierrc
@@ -0,0 +1,4 @@
+{
+  "$schema": "https://json.schemastore.org/prettierrc.json",
+  "singleQuote": false
+}
diff --git a/components/AppMetadata/AppMetadata.tsx → components/AppMetadata/AppMetadata.jsx b/components/AppMetadata/AppMetadata.tsx → components/AppMetadata/AppMetadata.jsx
@@ -1,18 +1,9 @@
 import React from "react";
-import styles from "./AppMetadata.module.css";
-import ExternalLinkIcon from "../../static/assets/icons/external-link.svg";
 
-type Props = {
-  minSaleorVersion: string;
-  roadmapUrl?: string;
-  githubUrl?: string;
-};
+import ExternalLinkIcon from "../../static/assets/icons/external-link.svg";
+import styles from "./AppMetadata.module.css";
 
-export const AppMetadata = ({
-  minSaleorVersion,
-  roadmapUrl,
-  githubUrl,
-}: Props) => {
+export const AppMetadata = ({ minSaleorVersion, roadmapUrl, githubUrl }) => {
   return (
     <div className={styles.root}>
       <span>

diff --git a/components/Apps/Apps.jsx b/components/Apps/Apps.jsx
@@ -1,5 +1,6 @@
 import Link from "@docusaurus/Link";
 import React from "react";
+
 import Adyen from "../../static/img/apps/adyen.svg";
 import CRM from "../../static/img/apps/app-crm.svg";
 import Invoices from "../../static/img/apps/app-invoices.svg";
@@ -9,7 +10,6 @@ import CMS from "../../static/img/apps/cms-hub.svg";
 import Notification from "../../static/img/apps/notification-hub.svg";
 import Search from "../../static/img/apps/search-hub.svg";
 import Segment from "../../static/img/apps/segment.svg";
-
 import s from "./apps.module.css";
 
 const Shell = ({ color, title, children, href = "" }) => {

diff --git a/components/AskAI/index.jsx b/components/AskAI/index.jsx
@@ -115,7 +115,9 @@ const AskAI = () => {
               const parts = startText.split(STREAM_SEPARATOR);
               try {
                 refs = JSON.parse(parts[0]);
-              } catch {}
+              } catch {
+                /* empty */
+              }
               setAnswer((prev) => prev + parts[1]);
               didHandleHeader = true;
             }
@@ -304,10 +306,10 @@ const AskAI = () => {
               </div>
             </div>
 
-            <footer class="DocSearch-Footer">
-              <ul class="DocSearch-Commands">
+            <footer className="DocSearch-Footer">
+              <ul className="DocSearch-Commands">
                 <li>
-                  <kbd class="DocSearch-Commands-Key">
+                  <kbd className="DocSearch-Commands-Key">
                     <svg
                       width="15"
                       height="15"
@@ -325,10 +327,10 @@ const AskAI = () => {
                       </g>
                     </svg>
                   </kbd>
-                  <span class="DocSearch-Label">to select</span>
+                  <span className="DocSearch-Label">to select</span>
                 </li>
                 <li>
-                  <kbd class="DocSearch-Commands-Key">
+                  <kbd className="DocSearch-Commands-Key">
                     <svg
                       width="15"
                       height="15"
@@ -346,7 +348,7 @@ const AskAI = () => {
                       </g>
                     </svg>
                   </kbd>
-                  <span class="DocSearch-Label">to close</span>
+                  <span className="DocSearch-Label">to close</span>
                 </li>
               </ul>
             </footer>

diff --git a/components/Feedback/index.js b/components/Feedback/index.js
@@ -1,7 +1,6 @@
-import React, { useState, useEffect } from "react";
-import { v4 as uuid } from "uuid";
-
 import useIsBrowser from "@docusaurus/useIsBrowser";
+import React, { useEffect, useState } from "react";
+import { v4 as uuid } from "uuid";
 
 import styles from "./styles.module.css";
 

diff --git a/components/Figure/index.js b/components/Figure/index.js
@@ -1,7 +1,6 @@
 import React from "react";
 
 import styles from "./styles.module.css";
-import Image from "";
 
 const Figure = ({ src, alt }) => {
   return <img src={src} className={styles.figure} alt={alt} />;

diff --git a/docs/developer/app-store/apps/TEMPLATE.mdx b/docs/developer/app-store/apps/TEMPLATE.mdx
@@ -3,7 +3,7 @@ title: APP NAME
 sidebar_position: 3
 ---
 
-import { AppMetadata } from "/components/AppMetadata/AppMetadata.tsx";
+import { AppMetadata } from "/components/AppMetadata/AppMetadata.jsx";
 
 <AppMetadata
   minSaleorVersion="3.10"

diff --git a/docs/developer/app-store/apps/adyen/overview.mdx b/docs/developer/app-store/apps/adyen/overview.mdx
@@ -4,7 +4,7 @@ sidebar_position: 1
 title: Adyen
 ---
 
-import { AppMetadata } from "/components/AppMetadata/AppMetadata.tsx";
+import { AppMetadata } from "/components/AppMetadata/AppMetadata.jsx";
 import { Mail } from "lucide-react";
 
 <AppMetadata minSaleorVersion="3.17" />

diff --git a/docs/developer/app-store/apps/avatax/overview.mdx b/docs/developer/app-store/apps/avatax/overview.mdx
@@ -4,7 +4,7 @@ sidebar_position: 1
 title: AvaTax
 ---
 
-import { AppMetadata } from "/components/AppMetadata/AppMetadata.tsx";
+import { AppMetadata } from "/components/AppMetadata/AppMetadata.jsx";
 
 <AppMetadata
   minSaleorVersion="3.19"

diff --git a/docs/developer/app-store/apps/cms.mdx b/docs/developer/app-store/apps/cms.mdx
@@ -3,7 +3,7 @@ title: CMS
 sidebar_position: 4
 ---
 
-import { AppMetadata } from "/components/AppMetadata/AppMetadata.tsx";
+import { AppMetadata } from "/components/AppMetadata/AppMetadata.jsx";
 
 <AppMetadata
   minSaleorVersion="3.10"

diff --git a/docs/developer/app-store/apps/crm.mdx b/docs/developer/app-store/apps/crm.mdx
@@ -3,7 +3,7 @@ title: CRM
 sidebar_position: 3
 ---
 
-import { AppMetadata } from "/components/AppMetadata/AppMetadata.tsx";
+import { AppMetadata } from "/components/AppMetadata/AppMetadata.jsx";
 
 <AppMetadata
   minSaleorVersion="3.10"

diff --git a/docs/developer/app-store/apps/emails-and-messages/overview.mdx b/docs/developer/app-store/apps/emails-and-messages/overview.mdx
@@ -4,7 +4,7 @@ sidebar_position: 1
 title: Emails and Messages
 ---
 
-import { AppMetadata } from "/components/AppMetadata/AppMetadata.tsx";
+import { AppMetadata } from "/components/AppMetadata/AppMetadata.jsx";
 
 <AppMetadata
   minSaleorVersion="3.10"

diff --git a/docs/developer/app-store/apps/invoices.mdx b/docs/developer/app-store/apps/invoices.mdx
@@ -3,7 +3,7 @@ title: Invoices
 sidebar_position: 4
 ---
 
-import { AppMetadata } from "/components/AppMetadata/AppMetadata.tsx";
+import { AppMetadata } from "/components/AppMetadata/AppMetadata.jsx";
 
 <AppMetadata
   minSaleorVersion="3.10"

diff --git a/docs/developer/app-store/apps/product-feed.mdx b/docs/developer/app-store/apps/product-feed.mdx
@@ -2,7 +2,7 @@
 title: Product Feed
 ---
 
-import { AppMetadata } from "/components/AppMetadata/AppMetadata.tsx";
+import { AppMetadata } from "/components/AppMetadata/AppMetadata.jsx";
 
 <AppMetadata
   minSaleorVersion="3.10"

diff --git a/docs/developer/app-store/apps/search.mdx b/docs/developer/app-store/apps/search.mdx
@@ -3,7 +3,7 @@ title: Search
 sidebar_position: 5
 ---
 
-import { AppMetadata } from "/components/AppMetadata/AppMetadata.tsx";
+import { AppMetadata } from "/components/AppMetadata/AppMetadata.jsx";
 
 <AppMetadata
   minSaleorVersion="3.10"

diff --git a/docs/developer/app-store/apps/segment.mdx b/docs/developer/app-store/apps/segment.mdx
@@ -3,7 +3,7 @@ title: Twilio Segment
 sidebar_position: 3
 ---
 
-import { AppMetadata } from "/components/AppMetadata/AppMetadata.tsx";
+import { AppMetadata } from "/components/AppMetadata/AppMetadata.jsx";
 
 <AppMetadata
   minSaleorVersion="3.14"

diff --git a/docs/developer/app-store/apps/smtp/overview.mdx b/docs/developer/app-store/apps/smtp/overview.mdx
@@ -4,7 +4,7 @@ sidebar_position: 1
 title: SMTP
 ---
 
-import { AppMetadata } from "/components/AppMetadata/AppMetadata.tsx";
+import { AppMetadata } from "/components/AppMetadata/AppMetadata.jsx";
 
 <AppMetadata
   minSaleorVersion="3.19"

diff --git a/examples/snippets/collections/CollectionList.query.graphql b/examples/snippets/collections/CollectionList.query.graphql
@@ -7,4 +7,4 @@ query CollectionList {
       }
     }
   }
-}
+}
diff --git a/examples/snippets/collections/CollectionListWithProducts.query.graphql b/examples/snippets/collections/CollectionListWithProducts.query.graphql
@@ -14,4 +14,4 @@ query CollectionListWithProducts {
       }
     }
   }
-}
+}
diff --git a/examples/snippets/products/ProductByID.query.graphql b/examples/snippets/products/ProductByID.query.graphql
@@ -10,4 +10,4 @@ query ProductByID($id: ID!) {
       name
     }
   }
-}
+}
diff --git a/examples/snippets/products/ProductByIDwithVariants.query.graphql b/examples/snippets/products/ProductByIDwithVariants.query.graphql
@@ -14,4 +14,4 @@ query ProductByID($id: ID!) {
       name
     }
   }
-}
+}
diff --git a/examples/snippets/products/SimpleProductList.query.graphql b/examples/snippets/products/SimpleProductList.query.graphql
@@ -7,4 +7,4 @@ query ProductGetTwelveElements {
       }
     }
   }
-}
+}
-Original file line number
+Diff line change
@@ Expand Up / @@ -7,4 +7,4 @@ query CollectionList { @@
           }
         }
       }
-    }
+    }