Integration of Prettier with Updated Configuration (#128)

* added prettier package ans script * fix prettier to all files * change prettier config * added semocolon to end of the line using prettier
Real-Dev-Squad · Jan 20, 2024 · 0ef2ab3 · 0ef2ab3
1 parent 44bbb22
commit 0ef2ab3
Show file tree

Hide file tree

Showing 133 changed files with 11,622 additions and 8,578 deletions.
diff --git a/.gitignore b/.gitignore
@@ -34,3 +34,7 @@ yarn-error.log*
 # typescript
 *.tsbuildinfo
 next-env.d.ts
+
+# yarn
+.yarnrc.yml
+.yarn/*
diff --git a/.prettierignore b/.prettierignore
@@ -0,0 +1,8 @@
+# Ignore all files in the "node_modules" directory
+node_modules/
+
+# Ignore all files in the coverage directory
+/coverage/*
+
+# Ignore all files in the .next directory
+/.next/*
diff --git a/.prettierrc b/.prettierrc
@@ -0,0 +1,11 @@
+{
+  "semi": true,
+  "singleQuote": true,
+  "tabWidth": 2,
+  "useTabs": false,
+  "printWidth": 80,
+  "arrowParens": "always",
+  "trailingComma": "all",
+  "bracketSpacing": true,
+  "endOfLine": "lf"
+}
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -125,4 +125,4 @@ Now go to your forked repository and you'll see that **This branch is xx commits
 
 Wait for it to get reviewed, make the changes required (if any) , commit your changes and hit **Pull Request** again, your commits will be added to the same pull request you had opened earlier (if it is NOT closed).
 
-12. **Congratulations on making your first Pull Request! 🎉**
+12. **Congratulations on making your first Pull Request! 🎉**
diff --git a/README.md b/README.md
@@ -9,26 +9,25 @@ This page is hosted on: https://members.realdevsquad.com/
 
 You can find a detailed guide [here](./CONTRIBUTING.md)!
 
-
 # Coding Conventions
 
-### There are only 2 things in computer science: cache invalidation & naming things  — *********Phil Karlton*********
+### There are only 2 things in computer science: cache invalidation & naming things — \***\*\*\*\***Phil Karlton\***\*\*\*\***
+
+## Imports Order
 
-## Imports Order 
-- External Libraries 
+- External Libraries
 - Internal Libraries
-- Components 
-- Types 
-- Images 
-- CSS 
+- Components
+- Types
+- Images
+- CSS
 
 ## Commits style:
 
 - Make Atomic commits of changes, even if they are across multiple files in logical units.
-    - Add displayName to make the Header clear
-    - Remove unused date format
-    - Chore change library version
-
+  - Add displayName to make the Header clear
+  - Remove unused date format
+  - Chore change library version
 - It's alright to add a Description even if it's big we want to understand things just by reading the commit description at times.
 
 ## Branch Naming:
@@ -52,13 +51,13 @@ refact: for  cleanup and refactor
 example
 
 ```jsx
-	/*BAD*/
-const value = 5 //what is this value ?
-const isPagination = true // what does it do ?
+/*BAD*/
+const value = 5; //what is this value ?
+const isPagination = true; // what does it do ?
 
 /*GOOD*/
 const initialIndexValue = 5;
-const isPaginationEnabled = true 
+const isPaginationEnabled = true;
 ```
 
 ## Sanity:
@@ -67,12 +66,12 @@ const isPaginationEnabled = true
 
 ```jsx
 //bad
-const onItmClk =()=>{}
+const onItmClk = () => {};
 
 //good
-const onItemClick = () => {}
+const onItemClick = () => {};
 
-const onProceedBtnClick = () => {}
+const onProceedBtnClick = () => {};
 ```
 
 ## Folder structure:

diff --git a/constants/NavConstants.ts b/constants/NavConstants.ts
@@ -1,40 +1,40 @@
-interface NavObject{
-    id: Number,
-    name: String,
-    link: String
+interface NavObject {
+  id: Number;
+  name: String;
+  link: String;
 }
 
 const navItems: Array<NavObject> = [
-    {
-        id: 0,
-        name: 'Home',
-        link: 'https://realdevsquad.com/',
-    },
-    {
-        id: 1,
-        name: 'Welcome',
-        link: 'https://welcome.realdevsquad.com/',
-    },
-    {
-        id: 0,
-        name: 'Events',
-        link: 'https://www.realdevsquad.com/events',
-    },
-    {
-        id: 0,
-        name: 'Members',
-        link: 'https://members.realdevsquad.com/',
-    },
-    {
-        id: 0,
-        name: 'Crypto',
-        link: 'https://crypto.realdevsquad.com/',
-    },
-    {
-        id: 0,
-        name: 'Status',
-        link: 'https://status.realdevsquad.com/',
-    },
-]
+  {
+    id: 0,
+    name: 'Home',
+    link: 'https://realdevsquad.com/',
+  },
+  {
+    id: 1,
+    name: 'Welcome',
+    link: 'https://welcome.realdevsquad.com/',
+  },
+  {
+    id: 0,
+    name: 'Events',
+    link: 'https://www.realdevsquad.com/events',
+  },
+  {
+    id: 0,
+    name: 'Members',
+    link: 'https://members.realdevsquad.com/',
+  },
+  {
+    id: 0,
+    name: 'Crypto',
+    link: 'https://crypto.realdevsquad.com/',
+  },
+  {
+    id: 0,
+    name: 'Status',
+    link: 'https://status.realdevsquad.com/',
+  },
+];
 
-export default navItems
+export default navItems;
diff --git a/constants/NotFound.ts b/constants/NotFound.ts
@@ -1,3 +1,4 @@
 export const NOT_FOUND_CONSTANT = {
-  PAGE_NOT_FOUND: "The page you're trying to find doesn't exist, please go to members page to see all the members of RDS",
-}
+  PAGE_NOT_FOUND:
+    "The page you're trying to find doesn't exist, please go to members page to see all the members of RDS",
+};
diff --git a/jest.config.js b/jest.config.js
@@ -1,13 +1,13 @@
-const nextJest = require("next/jest");
-
-const createJestConfig = nextJest({
-  dir: "./",
-});
-
-const customJestConfig = {
-  setupFilesAfterEnv: ["<rootDir>/jest.setup.js"],
-  moduleDirectories: ["node_modules", "<rootDir>/"],
-  testEnvironment: "jest-environment-jsdom",
-};
-
-module.exports = createJestConfig(customJestConfig);
+const nextJest = require('next/jest');
+
+const createJestConfig = nextJest({
+  dir: './',
+});
+
+const customJestConfig = {
+  setupFilesAfterEnv: ['<rootDir>/jest.setup.js'],
+  moduleDirectories: ['node_modules', '<rootDir>/'],
+  testEnvironment: 'jest-environment-jsdom',
+};
+
+module.exports = createJestConfig(customJestConfig);
diff --git a/jest.setup.js b/jest.setup.js
@@ -1,8 +1,8 @@
-import "@testing-library/jest-dom";
-import "./setupTests";
-import "whatwg-fetch";
-
-// jest.config.js
-module.exports = {
-  setupFilesAfterEnv: ["@testing-library/jest-dom", "./jest.setup.ts"],
-};
+import '@testing-library/jest-dom';
+import './setupTests';
+import 'whatwg-fetch';
+
+// jest.config.js
+module.exports = {
+  setupFilesAfterEnv: ['@testing-library/jest-dom', './jest.setup.ts'],
+};
diff --git a/next.config.js b/next.config.js
@@ -10,4 +10,4 @@ const nextConfig = {
   },
 };
 
-module.exports = nextConfig
+module.exports = nextConfig;
diff --git a/package.json b/package.json
@@ -7,9 +7,13 @@
     "build:production": "cp ./env/.env.production .env && next build",
     "start": "next start",
     "test": "jest --watch",
-    "lint": "next lint",
+    "lint:check": "next lint",
+    "lint:fix": "next lint --fix",
     "build:staging": "cp ./env/.env.staging .env && next build",
-    "coverage": "jest --collect-coverage"
+    "coverage": "jest --collect-coverage",
+    "prettier:check": "prettier --check .",
+    "prettier:fix": "prettier --write .",
+    "fix": "yarn prettier:fix && yarn lint:fix"
   },
   "dependencies": {
     "@chakra-ui/icons": "^2.0.19",
@@ -46,6 +50,7 @@
     "jest-environment-jsdom": "^29.3.1",
     "msw": "^0.49.1",
     "postcss": "^8.4.19",
+    "prettier": "^3.1.1",
     "tailwindcss": "^3.2.4"
   }
 }
diff --git a/pages/404.tsx b/pages/404.tsx
@@ -2,7 +2,5 @@ import { NOT_FOUND_CONSTANT } from '@/constants/NotFound';
 import NotFound from '@/src/components/NotFound';
 
 export default function NotFoundPage() {
-  return (
-    <NotFound text={NOT_FOUND_CONSTANT.PAGE_NOT_FOUND} />
-  );
+  return <NotFound text={NOT_FOUND_CONSTANT.PAGE_NOT_FOUND} />;
 }
diff --git a/pages/[memberprofile]/index.tsx b/pages/[memberprofile]/index.tsx
@@ -1,17 +1,17 @@
-import { GetServerSidePropsContext } from "next";
-import { Box, Flex } from "@chakra-ui/react";
+import { GetServerSidePropsContext } from 'next';
+import { Box, Flex } from '@chakra-ui/react';
 
-import { wrapper } from "@/src/store";
+import { wrapper } from '@/src/store';
 
-import MemberProfileCard from "src/components/MemberProfileCard";
-import MemberContributions from "@/src/components/MemberContribution";
+import MemberProfileCard from 'src/components/MemberProfileCard';
+import MemberContributions from '@/src/components/MemberContribution';
 
-import serverApi from "@/src/services/serverApi";
+import serverApi from '@/src/services/serverApi';
 
-import styles from "./memberProfileWrapper.module.css";
-import { useGetIsSuperUser } from "@/src/utils/customHooks";
-import NotFound from "@/src/components/NotFound";
-import { useRouter } from "next/router";
+import styles from './memberProfileWrapper.module.css';
+import { useGetIsSuperUser } from '@/src/utils/customHooks';
+import NotFound from '@/src/components/NotFound';
+import { useRouter } from 'next/router';
 
 export default function MembersProfile(props: any) {
   const { userData, userContribution, userActiveTask, error } = props;
@@ -31,14 +31,14 @@ export default function MembersProfile(props: any) {
   return (
     <Box
       sx={{
-        display: "flex",
-        justifyContent: "center",
+        display: 'flex',
+        justifyContent: 'center',
       }}
-      width={"100%"}
+      width={'100%'}
     >
       <Flex
-        width={"70%"}
-        justifyContent={"center"}
+        width={'70%'}
+        justifyContent={'center'}
         className={styles.memberProfile_wrapper}
       >
         <MemberProfileCard userData={user} />
@@ -60,13 +60,13 @@ export const getServerSideProps = wrapper.getServerSideProps(
     try {
       store.dispatch(serverApi.endpoints.getUser.initiate(memberprofile));
       store.dispatch(
-        serverApi.endpoints.getContributions.initiate(memberprofile)
+        serverApi.endpoints.getContributions.initiate(memberprofile),
       );
       store.dispatch(
-        serverApi.endpoints.getUserActiveTask.initiate(memberprofile)
+        serverApi.endpoints.getUserActiveTask.initiate(memberprofile),
       );
       const [userDetails, userContribution, activeTask] = await Promise.all(
-        store.dispatch(serverApi.util.getRunningQueriesThunk())
+        store.dispatch(serverApi.util.getRunningQueriesThunk()),
       );
       const userData = userDetails?.data ?? null;
       const userActiveTask = activeTask?.data ?? null;
@@ -88,5 +88,5 @@ export const getServerSideProps = wrapper.getServerSideProps(
     } catch (e) {
       console.error(e);
     }
-  }
+  },
 );
diff --git a/pages/_app.tsx b/pages/_app.tsx
@@ -22,27 +22,27 @@ function App({ Component, ...rest }: AppProps) {
   const emotionCache = createCache({
     key: 'emotion-css-cache',
     prepend: true,
-  })
+  });
 
   return (
     <>
       <Head>
         <title>Real Dev Squad</title>
-        <link rel='icon' href='/images/Real-Dev-Squad@1x.svg' />
+        <link rel="icon" href="/images/Real-Dev-Squad@1x.svg" />
       </Head>
       <CacheProvider value={emotionCache}>
-      <ChakraProvider theme={theme}>
-        <Provider store={store}>
-          <LayoutComponent>
-            <AuthHandler>
-              <KeyboardEventHandler>
-                <Component {...props.pageProps} />
-              </KeyboardEventHandler>
-            </AuthHandler>
-          </LayoutComponent>
-        </Provider>
-        <Toast />
-      </ChakraProvider>
+        <ChakraProvider theme={theme}>
+          <Provider store={store}>
+            <LayoutComponent>
+              <AuthHandler>
+                <KeyboardEventHandler>
+                  <Component {...props.pageProps} />
+                </KeyboardEventHandler>
+              </AuthHandler>
+            </LayoutComponent>
+          </Provider>
+          <Toast />
+        </ChakraProvider>
       </CacheProvider>
       <Loader />
     </>