chore(deps): update dependency prettier to v3 (#92)

* chore(deps): update dependency prettier to v3

* style: prettier

* Empty commit to trigger test run

---------

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Create or Update Pull Request Action <[email protected]>
Co-authored-by: Keegan Campbell <[email protected]>

Author: 3 people

README.md

@@ -55,7 +55,7 @@ const { repository } = await octokit.graphql.paginate(
         }
       }
     }
-  }`
+  }`,
 );
 
 console.log(`Found ${repository.issues.nodes.length} issues!`);
@@ -95,7 +95,7 @@ const pageIterator = octokit.graphql.paginate.iterator(
         }
       }
     }
-  }`
+  }`,
 );
 
 for await (const response of pageIterator) {
@@ -127,7 +127,7 @@ await octokit.graphql.paginate(
     `,
   {
     organization: "octokit",
-  }
+  },
 );
 ```
 
@@ -153,7 +153,7 @@ await octokit.graphql.paginate(
   {
     organization: "octokit",
     cursor: "initialValue",
-  }
+  },
 );
 ```
 

package-lock.json

@@ -39,7 +39,7 @@
     "glob": "^10.2.6",
     "jest": "^29.0.0",
     "npm-run-all": "^4.1.5",
-    "prettier": "2.8.8",
+    "prettier": "3.0.0",
     "semantic-release-plugin-update-version-in-files": "^1.0.0",
     "ts-jest": "^29.0.0",
     "typescript": "^5.0.0"

package.json

@@ -3,15 +3,15 @@ import type { CursorValue, PageInfoContext } from "./page-info";
 // Todo: Add link to explanation
 const generateMessage = (path: string[], cursorValue: CursorValue): string =>
   `The cursor at "${path.join(
-    ","
+    ",",
   )}" did not change its value "${cursorValue}" after a page transition. Please make sure your that your query is set up correctly.`;
 
 class MissingCursorChange extends Error {
   override name = "MissingCursorChangeError";
 
   constructor(
     readonly pageInfo: PageInfoContext,
-    readonly cursorValue: CursorValue
+    readonly cursorValue: CursorValue,
   ) {
     super(generateMessage(pageInfo.pathInQuery, cursorValue));
 
@@ -29,8 +29,8 @@ class MissingPageInfo extends Error {
       `No pageInfo property found in response. Please make sure to specify the pageInfo in your query. Response-Data: ${JSON.stringify(
         response,
         null,
-        2
-      )}`
+        2,
+      )}`,
     );
 
     if (Error.captureStackTrace) {

src/errors.ts

@@ -6,7 +6,7 @@ import { MissingCursorChange } from "./errors";
 const createIterator = (octokit: Octokit) => {
   return <ResponseType = any>(
     query: string,
-    initialParameters: Record<string, any> = {}
+    initialParameters: Record<string, any> = {},
   ) => {
     let nextPageExists = true;
     let parameters = { ...initialParameters };
@@ -18,7 +18,7 @@ const createIterator = (octokit: Octokit) => {
 
           const response = await octokit.graphql<ResponseType>(
             query,
-            parameters
+            parameters,
           );
 
           const pageInfoContext = extractPageInfos(response);

src/iterator.ts

@@ -2,7 +2,7 @@ import { findPaginatedResourcePath, get, set } from "./object-helpers";
 
 const mergeResponses = <ResponseType extends object = any>(
   response1: ResponseType,
-  response2: ResponseType
+  response2: ResponseType,
 ): ResponseType => {
   if (Object.keys(response1).length === 0) {
     return Object.assign(response1, response2);

src/merge-responses.ts

@@ -6,7 +6,7 @@ const isObject = (value: any) =>
 function findPaginatedResourcePath(responseData: any): string[] {
   const paginatedResourcePath = deepFindPathToProperty(
     responseData,
-    "pageInfo"
+    "pageInfo",
   );
   if (paginatedResourcePath.length === 0) {
     throw new MissingPageInfo(responseData);
@@ -17,7 +17,7 @@ function findPaginatedResourcePath(responseData: any): string[] {
 const deepFindPathToProperty = (
   object: any,
   searchProp: string,
-  path: string[] = []
+  path: string[] = [],
 ): string[] => {
   for (const key of Object.keys(object)) {
     const currentPath = [...path, key];
@@ -31,7 +31,7 @@ const deepFindPathToProperty = (
       const result = deepFindPathToProperty(
         currentValue,
         searchProp,
-        currentPath
+        currentPath,
       );
       if (result.length > 0) {
         return result;

src/object-helpers.ts

@@ -18,7 +18,7 @@ type PageInfoContext = {
 };
 
 const isForwardSearch = (
-  givenPageInfo: PageInfo
+  givenPageInfo: PageInfo,
 ): givenPageInfo is PageInfoForward => {
   return givenPageInfo.hasOwnProperty("hasNextPage");
 };

src/page-info.ts

@@ -6,12 +6,12 @@ const createPaginate = (octokit: Octokit) => {
   const iterator = createIterator(octokit);
   return async <ResponseType extends object = any>(
     query: string,
-    initialParameters: Record<string, any> = {}
+    initialParameters: Record<string, any> = {},
   ): Promise<ResponseType> => {
     let mergedResponse: ResponseType = {} as ResponseType;
     for await (const response of iterator<ResponseType>(
       query,
-      initialParameters
+      initialParameters,
     )) {
       mergedResponse = mergeResponses<ResponseType>(mergedResponse, response);
     }

src/paginate.ts

@@ -6,7 +6,7 @@ const PatchedOctokit = Octokit.plugin(paginateGraphql);
 const token = process.env.E2E_GITHUB_TOKEN;
 if (!token) {
   throw new Error(
-    "Executing the E2E Tests requires you to pass a GitHub Token as an environment variable named E2E_GITHUB_TOKEN"
+    "Executing the E2E Tests requires you to pass a GitHub Token as an environment variable named E2E_GITHUB_TOKEN",
   );
 }
 
@@ -30,7 +30,7 @@ describe("paginate-graphql-js E2E Test", () => {
             }
           }
         }
-      }`
+      }`,
     );
     expect(result).toBeDefined();
     expect(result.repository.repositoryTopics.nodes).toHaveLength(3);
@@ -55,7 +55,7 @@ describe("paginate-graphql-js E2E Test", () => {
             }
           }
         }
-      }`
+      }`,
     );
 
     let iterations = 0;

test/paginate-graphql.e2e.ts

@@ -118,7 +118,7 @@ describe("pagination", () => {
         }
       }
     `,
-      { cursor: "initialValue", organization: "octokit" }
+      { cursor: "initialValue", organization: "octokit" },
     );
 
     expect(getPassedVariablesForCall(1)).toEqual({
@@ -225,7 +225,7 @@ describe("pagination", () => {
             }
           }
         }
-      }`
+      }`,
     );
 
     expect(getCallCount()).toBe(2);
@@ -258,7 +258,7 @@ describe("pagination", () => {
             }
           }
         }
-      }`
+      }`,
     );
 
     const allIssues: any[] = [];
@@ -305,13 +305,13 @@ describe("pagination", () => {
               }
             }
           }
-      }`
+      }`,
       );
       throw new Error("Should not succeed!");
     } catch (err: any) {
       expect(err).toBeInstanceOf(MissingCursorChange);
       expect(err.message).toMatch(
-        /The cursor at "repository.issues" did not change its value "endCursor1".*/
+        /The cursor at "repository.issues" did not change its value "endCursor1".*/,
       );
     }
   });
@@ -349,8 +349,8 @@ describe("pagination", () => {
         `No pageInfo property found in response. Please make sure to specify the pageInfo in your query. Response-Data: ${JSON.stringify(
           response,
           null,
-          2
-        )}`
+          2,
+        )}`,
       );
     }
   });
@@ -389,7 +389,7 @@ describe("pagination", () => {
       .catch((error) => {
         expect(error.message).toEqual(
           "Request failed due to following response errors:\n" +
-            " - Field 'bioHtml' doesn't exist on type 'User'"
+            " - Field 'bioHtml' doesn't exist on type 'User'",
         );
         expect(error.errors).toStrictEqual(mockResponse.errors);
         expect(error.request.query).toEqual(query);

test/paginate.test.ts

@@ -16,7 +16,7 @@ const MockOctokit = ({ responses = [{}] }: { responses?: any[] } = {}) => {
       callCount = callCount + 1;
       return { data: responses.shift() };
     },
-    { repeat: responses.length }
+    { repeat: responses.length },
   );
 
   const octokit = new PatchedOctokit({