feat: prettier Integration (#154)

* Prettier file

* New package

* Script

* Husky

* Prettier

.github/ISSUE_TEMPLATE/bug.yml

@@ -28,8 +28,8 @@ body:
     id: steps
     attributes:
       label: Steps to Reproduce
-      description:  To help us recreate the bug, provide a numbered list of the exact steps taken to trigger the buggy behavior.
-      value:  | 
+      description: To help us recreate the bug, provide a numbered list of the exact steps taken to trigger the buggy behavior.
+      value: |
         If you know the steps, follow the below format and provide steps to reproduce
 
         For example:

.husky/pre-commit

@@ -1 +1,4 @@
 npm run lint
+# npm test
+
+npm run format:check

.prettierrc

@@ -0,0 +1,4 @@
+{
+  "tabWidth": 2,
+  "useTabs": false
+}

README.md

@@ -88,8 +88,8 @@ The default badge is "flat" but there are other styles if you prefer. This is do
 
 Here are the options with examples:
 
-| style         | badge                                                                                                                 |
-| :------------ | :-------------------------------------------------------------------------------------------------------------------- |
+| style         | badge                                                                                                                  |
+| :------------ | :--------------------------------------------------------------------------------------------------------------------- |
 | flat          | ![flat](https://repo-rater.eddiehub.org/api/badge?owner=EddieHubCommunity&name=RepoRater&style=flat)                   |
 | flat-square   | ![flat-square](https://repo-rater.eddiehub.org/api/badge?owner=EddieHubCommunity&name=RepoRater&style=flat-square)     |
 | for-the-badge | ![for-the-badge](https://repo-rater.eddiehub.org/api/badge?owner=EddieHubCommunity&name=RepoRater&style=for-the-badge) |
@@ -106,8 +106,8 @@ The default badge format is to show the average rating out of `5`. You can also
 [![RepoRater](https://repo-rater.eddiehub.org/api/badge?owner=EddieHubCommunity&name=RepoRater)](https://repo-rater.eddiehub.org/rate?owner=EddieHubCommunity&name=RepoRater&format=percentage)
 ```
 
-| format     | badge                                                                                                                                                                                         |
-| :--------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| format     | badge                                                                                                                                                                                           |
+| :--------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | number     | [![RepoRater](https://repo-rater.eddiehub.org/api/badge?owner=EddieHubCommunity&name=RepoRater&format=number)](https://repo-rater.eddiehub.org/rate?owner=EddieHubCommunity&name=RepoRater)     |
 | percentage | [![RepoRater](https://repo-rater.eddiehub.org/api/badge?owner=EddieHubCommunity&name=RepoRater&format=percentage)](https://repo-rater.eddiehub.org/rate?owner=EddieHubCommunity&name=RepoRater) |
 

package.json

@@ -7,7 +7,9 @@
     "build": "next build",
     "start": "next start",
     "lint": "next lint",
-    "prepare": "husky"
+    "prepare": "husky",
+    "format:write": "prettier . --write",
+    "format:check": "prettier . --check"
   },
   "dependencies": {
     "@headlessui/react": "^1.7.17",
@@ -31,6 +33,7 @@
     "eslint-config-next": "14.0.4",
     "husky": "^9.0.11",
     "postcss": "^8",
+    "prettier": "3.3.3",
     "tailwindcss": "^3.3.0"
   }
 }

postcss.config.js

@@ -3,4 +3,4 @@ module.exports = {
     tailwindcss: {},
     autoprefixer: {},
   },
-}
+};

src/app/api/activity/route.js

@@ -15,7 +15,7 @@ export async function GET() {
   let ratings = await new Databases(clientAdmin()).listDocuments(
     process.env.NEXT_PUBLIC_APPWRITE_DATABASE_ID,
     process.env.NEXT_PUBLIC_APPWRITE_COLLECTION_RATINGS_ID,
-    [Query.orderDesc("$updatedAt"), Query.limit(25)]
+    [Query.orderDesc("$updatedAt"), Query.limit(25)],
   );
 
   ratings = ratings.documents.map((rating) => {
@@ -26,7 +26,7 @@ export async function GET() {
       owner: path.owner,
       name: path.name,
       timeAgo: timeAgo.format(
-        Math.floor(new Date(rating.$updatedAt).getTime())
+        Math.floor(new Date(rating.$updatedAt).getTime()),
       ),
       updatedAt: rating.$updatedAt,
     };

src/app/api/badge/route.js

@@ -17,7 +17,11 @@ export async function GET(request) {
   const repos = await new sdk.Databases(clientAdmin()).listDocuments(
     process.env.NEXT_PUBLIC_APPWRITE_DATABASE_ID,
     process.env.NEXT_PUBLIC_APPWRITE_COLLECTION_REPOS_ID,
-    [Query.equal("owner", [owner]), Query.equal("name", [name]), Query.limit(1)]
+    [
+      Query.equal("owner", [owner]),
+      Query.equal("name", [name]),
+      Query.limit(1),
+    ],
   );
   const data = repos.documents[0];
 
@@ -29,7 +33,7 @@ export async function GET(request) {
       data.$id,
       {
         badgeViews: data.badgeViews + 1,
-      }
+      },
     );
   }
 

src/app/api/leaderboard/route.js

@@ -8,7 +8,7 @@ export async function GET() {
   const ratings = await new Databases(clientAdmin()).listDocuments(
     process.env.NEXT_PUBLIC_APPWRITE_DATABASE_ID,
     process.env.NEXT_PUBLIC_APPWRITE_COLLECTION_RATINGS_ID,
-    [Query.limit(1000)]
+    [Query.limit(1000)],
   );
   const users = ratings.documents.reduce((acc, rating) => {
     if (!acc[rating.username]) {

src/app/api/popular/route.js

@@ -26,11 +26,11 @@ export async function GET(request) {
       Query.orderDesc("votes"),
       Query.greaterThanEqual("votes", parseInt(minimumVotes) || 5),
       Query.limit(100),
-    ]
+    ],
   );
 
   const data = repos.documents.map((repo) =>
-    Object.fromEntries(fields.map((field) => [[field], repo[field]]))
+    Object.fromEntries(fields.map((field) => [[field], repo[field]])),
   );
 
   return Response.json(data);

src/app/api/rate/route.js

@@ -50,15 +50,15 @@ export async function POST(request) {
     await new sdk.Databases(clientAdmin()).listDocuments(
       process.env.NEXT_PUBLIC_APPWRITE_DATABASE_ID,
       process.env.NEXT_PUBLIC_APPWRITE_COLLECTION_APP_ID,
-      [Query.limit(1)]
+      [Query.limit(1)],
     )
   ).documents[0];
 
   // 1. check if user already rated this repo
   const userRepoRating = await new sdk.Databases(clientAdmin()).listDocuments(
     process.env.NEXT_PUBLIC_APPWRITE_DATABASE_ID,
     process.env.NEXT_PUBLIC_APPWRITE_COLLECTION_RATINGS_ID,
-    [Query.equal("url", [urlClean]), Query.equal("username", [username])]
+    [Query.equal("url", [urlClean]), Query.equal("username", [username])],
   );
 
   // 2a. update in ratings collection
@@ -72,7 +72,7 @@ export async function POST(request) {
         username: username,
         url: urlClean,
         rating: rating,
-      }
+      },
     );
   } else {
     // 2b. create in ratings collection
@@ -85,7 +85,7 @@ export async function POST(request) {
         username: username,
         url: urlClean,
         rating: rating,
-      }
+      },
     );
   }
 
@@ -98,15 +98,15 @@ export async function POST(request) {
     {
       ratings: appTotal.ratings + 1,
       stars: appTotal.stars + rating,
-    }
+    },
   );
 
   // 3. check if repo exists
   console.info(`Checking if repo ${urlClean} exists in database`);
   const repos = await new sdk.Databases(clientAdmin()).listDocuments(
     process.env.NEXT_PUBLIC_APPWRITE_DATABASE_ID,
     process.env.NEXT_PUBLIC_APPWRITE_COLLECTION_REPOS_ID,
-    [Query.equal("url", [urlClean])]
+    [Query.equal("url", [urlClean])],
   );
 
   // 4a. update in repos collection + calculate new rating
@@ -116,7 +116,7 @@ export async function POST(request) {
     const ratings = await new sdk.Databases(clientAdmin()).listDocuments(
       process.env.NEXT_PUBLIC_APPWRITE_DATABASE_ID,
       process.env.NEXT_PUBLIC_APPWRITE_COLLECTION_RATINGS_ID,
-      [Query.equal("url", [urlClean])]
+      [Query.equal("url", [urlClean])],
     );
 
     // save new repo rating
@@ -131,12 +131,12 @@ export async function POST(request) {
         ...githubRepo,
         rating: averageRating,
         votes: ratings.total,
-      }
+      },
     );
   } else {
     // 4a. create in repos collection
     console.info(
-      `Repo ${urlClean} not found in database create repo and ratings`
+      `Repo ${urlClean} not found in database create repo and ratings`,
     );
     await new sdk.Databases(clientAdmin()).createDocument(
       process.env.NEXT_PUBLIC_APPWRITE_DATABASE_ID,
@@ -147,7 +147,7 @@ export async function POST(request) {
         url: urlClean,
         rating: rating,
         votes: 1,
-      }
+      },
     );
     // 4b. update app repo count
     console.info("Increment app total repos");
@@ -157,7 +157,7 @@ export async function POST(request) {
       appTotal.$id,
       {
         repos: appTotal.repos + 1,
-      }
+      },
     );
   }
 

src/app/api/repos/route.js

@@ -47,11 +47,11 @@ export async function GET(request) {
       minimumVotes && Query.greaterThanEqual("votes", parseInt(minimumVotes)),
       Query.limit(100),
       keyword && Query.search("url", keyword),
-    ]
+    ],
   );
 
   const data = repos.documents.map((repo) =>
-    Object.fromEntries(fields.map((field) => [[field], repo[field]]))
+    Object.fromEntries(fields.map((field) => [[field], repo[field]])),
   );
 
   return Response.json(data);

src/app/api/stats/route.js

@@ -9,7 +9,7 @@ export async function GET() {
     await new Databases(clientAdmin()).listDocuments(
       process.env.NEXT_PUBLIC_APPWRITE_DATABASE_ID,
       process.env.NEXT_PUBLIC_APPWRITE_COLLECTION_APP_ID,
-      [Query.limit(1)]
+      [Query.limit(1)],
     )
   ).documents[0];
 

src/app/layout.js

@@ -7,7 +7,7 @@ import { classNames } from "@/utils/classNames";
 const inter = Inter({ subsets: ["latin"] });
 
 export const metadata = {
-  title: "RepoRater: Rate GitHub Repos for Developer Experience"
+  title: "RepoRater: Rate GitHub Repos for Developer Experience",
 };
 
 export default function RootLayout({ children }) {

src/app/rankings/page.js

@@ -5,7 +5,7 @@ import Users from "@/components/Users";
 export const dynamic = "force-dynamic";
 
 export const metadata = {
-  title: "User Rankings - RepoRater" 
+  title: "User Rankings - RepoRater",
 };
 
 export default function Page() {

src/app/rate/Form.js

@@ -39,7 +39,7 @@ export default function Form({ name = "", owner = "" }) {
       setSending(false);
       const info = urlToOwnerAndName(formData.get("url"));
       redirect(
-        `/?alert=success&message=Rating saved for ${info.owner}/${info.name} 🎉`
+        `/?alert=success&message=Rating saved for ${info.owner}/${info.name} 🎉`,
       );
     }
 

src/components/Repos.js

@@ -48,7 +48,7 @@ export default function Repos({ minimumVotes = 5, keyword, sort }) {
       params.push(`sort=${sort}`);
     }
     const res = await fetch(
-      `/api/repos${params.length ? `?${params.join("&")}` : ""}`
+      `/api/repos${params.length ? `?${params.join("&")}` : ""}`,
     );
 
     const data = await res.json();
@@ -113,7 +113,9 @@ export default function Repos({ minimumVotes = 5, keyword, sort }) {
                     <span className="absolute inset-0" />
                   </Link>
                 </h2>
-                {repo.language && <p className="text-xs text-gray-400">({repo.language})</p>}
+                {repo.language && (
+                  <p className="text-xs text-gray-400">({repo.language})</p>
+                )}
                 {repo.stars && (
                   <p className="text-xs hidden sm:inline-block text-gray-400">
                     ({abbreviateNumber(repo.stars)} ⭐️)

src/components/SideNav.js

@@ -10,7 +10,7 @@ import {
   ServerIcon,
   StarIcon,
   XMarkIcon,
-  PuzzlePieceIcon
+  PuzzlePieceIcon,
 } from "@heroicons/react/24/outline";
 import { Bars3Icon, MagnifyingGlassIcon } from "@heroicons/react/20/solid";
 
@@ -30,7 +30,7 @@ export default function SideNav({ setKeyword, children }) {
     account.createOAuth2Session(
       "github",
       `${process.env.NEXT_PUBLIC_BASE_URL}/`,
-      `${process.env.NEXT_PUBLIC_BASE_URL}/`
+      `${process.env.NEXT_PUBLIC_BASE_URL}/`,
     );
   };
 
@@ -86,11 +86,10 @@ export default function SideNav({ setKeyword, children }) {
     {
       name: "Download Browser Extension",
       href: "https://github.com/EddieHubCommunity/RepoRater-Chrome",
-      current:false,
+      current: false,
       external: true,
       icon: PuzzlePieceIcon,
-
-    }
+    },
   ];
 
   const secure = [

src/components/Users.js

@@ -23,7 +23,7 @@ export default async function Users() {
   const ratings = await new Databases(clientAdmin()).listDocuments(
     process.env.NEXT_PUBLIC_APPWRITE_DATABASE_ID,
     process.env.NEXT_PUBLIC_APPWRITE_COLLECTION_RATINGS_ID,
-    [Query.limit(1000)]
+    [Query.limit(1000)],
   );
   const users = ratings.documents.reduce((acc, rating) => {
     if (!acc[rating.username]) {

src/config/app.json

@@ -1,3 +1,4 @@
 {
   "version": "0.5.1"
-}
+}
+