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

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Nicholas Lim <[email protected]>

.github/workflows/test.yaml

@@ -20,5 +20,8 @@ jobs:
       - name: Install Task
         run: curl -sL https://taskfile.dev/install.sh | sudo bash -s -- -b /usr/local/bin/
 
+      - name: Lint
+        run: task default lint
+
       - name: Test
         run: task default test

.prettierignore

@@ -0,0 +1 @@
+projects/optic/src/__tests__/integration/workspaces

.prettierrc

@@ -1,5 +1,6 @@
 {
   "semi": true,
   "singleQuote": true,
-  "arrowParens": "always"
+  "arrowParens": "always",
+  "trailingComma": "es5"
 }

Taskfile.yml

@@ -29,6 +29,11 @@ tasks:
     cmds:
       - yarn workspaces foreach -pv --no-private run clean
 
+  lint:
+    desc: Lint
+    cmds:
+      - yarn run lint
+
   test:
     desc: Test
     cmds:

package.json

@@ -16,13 +16,13 @@
   "scripts": {
     "release": "gh release create --target=$(git branch --show-current) v$(node -e \"process.stdout.write(require('./package.json').version)\")",
     "version": "yarn workspaces foreach -v version",
-    "prepare": "husky install"
+    "prepare": "husky install",
+    "lint": "prettier --check 'projects/*/src/**/*.(js|jsx|ts|tsx|json|css)'"
   },
   "devDependencies": {
-    "@types/prettier": "^2",
     "husky": "^8.0.0",
     "lint-staged": "^13.1.0",
-    "prettier": "^2.8.1"
+    "prettier": "^3.0.0"
   },
   "lint-staged": {
     "**/*.+(js|jsx|ts|tsx|json|css)": [

projects/json-pointer-helpers/package.json

@@ -25,7 +25,7 @@
     "@types/node": "^18.0.0",
     "babel-jest": "^29.3.1",
     "jest": "^29.3.1",
-    "prettier": "^2.8.1",
+    "prettier": "^3.0.0",
     "ts-jest": "^29.0.3",
     "ts-node": "^10.9.1",
     "typescript": "^5.0.0"

projects/json-pointer-helpers/src/index.ts

@@ -1,2 +1,2 @@
-import jsonPointerHelpers from "./json-pointers/json-pointer-helpers";
+import jsonPointerHelpers from './json-pointers/json-pointer-helpers';
 export { jsonPointerHelpers };

projects/openapi-io/package.json

@@ -31,7 +31,7 @@
     "@types/semver": "^7.3.10",
     "babel-jest": "^29.3.1",
     "jest": "^29.3.1",
-    "prettier": "^2.8.1",
+    "prettier": "^3.0.0",
     "ts-jest": "^29.0.3",
     "ts-node": "^10.9.1",
     "typescript": "^5.0.0"

projects/openapi-io/src/write/yaml-roundtrip.ts

@@ -59,7 +59,7 @@ export function applyOperationsToYamlString(
     }
   });
 
-  return doc.toString({collectionStyle: 'block'});
+  return doc.toString({ collectionStyle: 'block' });
 }
 
 function insert<T>(arr: T[], index: number, item: any) {

projects/openapi-utilities/package.json

@@ -32,7 +32,7 @@
     "@types/node": "^18.0.0",
     "babel-jest": "^29.3.1",
     "jest": "^29.3.1",
-    "prettier": "^2.8.1",
+    "prettier": "^3.0.0",
     "ts-jest": "^29.0.3",
     "ts-node": "^10.9.1",
     "typescript": "^5.0.0"

projects/openapi-utilities/src/diff/array-identifiers.ts

@@ -1,4 +1,6 @@
-export const isParameterObject = (value: any): value is { name: string; in: string } =>
+export const isParameterObject = (
+  value: any
+): value is { name: string; in: string } =>
   typeof value === 'object' &&
   !Array.isArray(value) &&
   value !== null &&

projects/openapi-utilities/src/diff/diff.ts

@@ -48,7 +48,7 @@ type StackItem<T extends JSONObject | JSONArray = JSONObject | JSONArray> = [
   {
     value: T;
     path: string;
-  }
+  },
 ];
 
 export function typeofDiff(

projects/openapi-utilities/src/openapi3/__tests__/fact-mock.ts

@@ -1,4 +1,4 @@
-import { IFact } from "../sdk/types";
+import { IFact } from '../sdk/types';
 
 export const FactsMock = [
   {

projects/openapi-utilities/src/openapi3/implementations/openapi3/sourcemap-reader.ts

@@ -25,21 +25,24 @@ export function resolveJsonPointerInYamlAst(
 
   if (isEmpty) return node;
 
-  const found: YAMLNode | undefined = decoded.reduce((current, path) => {
-    if (!current) return undefined;
-    const node: YAMLNode = current.key ? current.value : current;
-    const isNumericalKey =
-      !isNaN(Number(path)) && (node as any).hasOwnProperty('items');
-
-    if (isNumericalKey) {
-      return (node as YAMLSequence).items[Number(path)];
-    } else {
-      const field = node.mappings.find(
-        (i: YAMLMapping) => i.key.value === path
-      );
-      return field;
-    }
-  }, node as YAMLNode | undefined);
+  const found: YAMLNode | undefined = decoded.reduce(
+    (current, path) => {
+      if (!current) return undefined;
+      const node: YAMLNode = current.key ? current.value : current;
+      const isNumericalKey =
+        !isNaN(Number(path)) && (node as any).hasOwnProperty('items');
+
+      if (isNumericalKey) {
+        return (node as YAMLSequence).items[Number(path)];
+      } else {
+        const field = node.mappings.find(
+          (i: YAMLMapping) => i.key.value === path
+        );
+        return field;
+      }
+    },
+    node as YAMLNode | undefined
+  );
 
   return found;
 }

projects/openapi-utilities/src/openapi3/sdk/facts-to-changelog.ts

@@ -52,7 +52,7 @@ export function factsToChangelog(past: IFact[], current: IFact[]): IChange[] {
         location: added.location,
         added: added.value,
         changeType: ChangeType.Added,
-      } as IChange)
+      }) as IChange
   );
 
   const removedChanges = removed.map(
@@ -63,7 +63,7 @@ export function factsToChangelog(past: IFact[], current: IFact[]): IChange[] {
           before: removed.value,
         },
         changeType: ChangeType.Removed,
-      } as IChange)
+      }) as IChange
   );
 
   const changedChanges = updated.map((past) => {

projects/openapi-utilities/src/utilities/sentry.ts

@@ -19,7 +19,7 @@ export const initSentry = (sentryUrl: string | undefined, version: string) => {
 
 export const wrapActionHandlerWithSentry = <
   Args extends any[],
-  Return extends any
+  Return extends any,
 >(
   fn: (...args: Args) => Promise<Return>
 ): ((...args: Args) => Promise<Return>) => {

projects/optic-ci/package.json

@@ -38,7 +38,7 @@
     "babel-plugin-transform-inline-environment-variables": "^0.4.3",
     "dotenv": "^16.0.3",
     "jest": "^29.3.1",
-    "prettier": "^2.8.1",
+    "prettier": "^3.0.0",
     "ts-jest": "^29.0.3",
     "ts-node": "^10.9.1",
     "typescript": "^5.0.0"

projects/optic-ci/src/cli/clients/gitlab-client.ts

@@ -4,7 +4,10 @@ import urljoin from 'url-join';
 import { JsonHttpClient } from './JsonHttpClient';
 
 export class GitlabClient extends JsonHttpClient {
-  constructor(private baseUrl: string, private authToken: string) {
+  constructor(
+    private baseUrl: string,
+    private authToken: string
+  ) {
     super();
   }
 

projects/optic-ci/src/cli/commands/bulk-compare/__tests__/bulk-compare.test.ts

@@ -1,4 +1,4 @@
-import { jest, test, expect, describe } from '@jest/globals'
+import { jest, test, expect, describe } from '@jest/globals';
 import { parseJsonComparisonInput } from '../input-generators';
 import { loadFile } from '../../utils';
 

projects/optic-ci/src/cli/commands/bulk-compare/__tests__/input-generators.test.ts

@@ -1,4 +1,4 @@
-import { test, expect, describe } from '@jest/globals'
+import { test, expect, describe } from '@jest/globals';
 import { applyGlobFilters } from '../input-generators';
 
 describe('applyGlobFilters', () => {

projects/optic-ci/src/cli/commands/compare/__tests__/upload.test.ts

@@ -1,4 +1,4 @@
-import { jest, test, expect, beforeEach, afterEach } from '@jest/globals'
+import { jest, test, expect, beforeEach, afterEach } from '@jest/globals';
 
 import { v4 as uuidv4 } from 'uuid';
 

projects/optic-ci/src/cli/commands/create-context/context-readers/github/__tests__/circle-ci.test.ts

@@ -1,4 +1,4 @@
-import { test, expect, afterAll } from '@jest/globals'
+import { test, expect, afterAll } from '@jest/globals';
 import { UserError } from '@useoptic/openapi-utilities';
 import { getContextFromCircleCiEnvironment } from '../circle-ci';
 

projects/optic-ci/src/cli/commands/create-context/context-readers/github/__tests__/github-actions.test.ts

@@ -1,4 +1,4 @@
-import { jest, test, expect, afterAll } from '@jest/globals'
+import { jest, test, expect, afterAll } from '@jest/globals';
 import fs from 'fs/promises';
 import { UserError } from '@useoptic/openapi-utilities';
 import { getContextFromGithubEnvironment } from '../github-actions';
@@ -63,21 +63,22 @@ test('get head sha from github context', async () => {
   process.env.GITHUB_SHA = 'asdasd';
   process.env.GITHUB_REPOSITORY = 'optidev/monorail';
   process.env.GITHUB_HEAD_REF = 'feature-1';
-  mockReadFile.mockImplementation(() =>
-    Promise.resolve(
-      Buffer.from(
-        JSON.stringify({
-          pull_request: {
-            head: {
-              user: {
-                login: 'lou',
+  mockReadFile.mockImplementation(
+    () =>
+      Promise.resolve(
+        Buffer.from(
+          JSON.stringify({
+            pull_request: {
+              head: {
+                user: {
+                  login: 'lou',
+                },
+                sha: '7d3736f2b38af7f69fd51e43465fd74375aaca2d',
               },
-              sha: '7d3736f2b38af7f69fd51e43465fd74375aaca2d',
             },
-          },
-        })
-      )
-    ) as any
+          })
+        )
+      ) as any
   );
 
   expect(await getContextFromGithubEnvironment()).toEqual({

projects/optic-ci/src/cli/commands/create-context/context-readers/gitlab/__tests__/gitlab-ci.test.ts

@@ -1,4 +1,4 @@
-import { test, expect, afterAll } from '@jest/globals'
+import { test, expect, afterAll } from '@jest/globals';
 import { getContextFromGitlabEnvironment } from '../gitlab-ci';
 
 const originalEnv = {

projects/optic-ci/src/cli/commands/create-context/create-github-context.ts

@@ -35,7 +35,7 @@ export const registerCreateContext = (cli: Command, hideCommand: boolean) => {
         async ({
           provider,
         }: {
-          provider: typeof SUPPORTED_GITHUB_CI_PROVIDERS[number];
+          provider: (typeof SUPPORTED_GITHUB_CI_PROVIDERS)[number];
         }) => {
           console.warn(
             '[DEPRECATION WARNING] - This command will be deprecated in the future, please use `create-github-context` instead'
@@ -86,7 +86,7 @@ export const registerCreateGithubContext = (
         async ({
           provider,
         }: {
-          provider: typeof SUPPORTED_GITHUB_CI_PROVIDERS[number];
+          provider: (typeof SUPPORTED_GITHUB_CI_PROVIDERS)[number];
         }) => {
           if (!provider) {
             throw new UserError('Cannot create context without a provider');
@@ -105,7 +105,7 @@ export const registerCreateGithubContext = (
 };
 
 const createContext = async (
-  provider: typeof SUPPORTED_GITHUB_CI_PROVIDERS[number]
+  provider: (typeof SUPPORTED_GITHUB_CI_PROVIDERS)[number]
 ) => {
   let normalizedContext: NormalizedCiContext;
   if (provider === 'github') {

projects/optic-ci/src/cli/commands/create-context/create-gitlab-context.ts

@@ -40,7 +40,7 @@ export const registerCreateGitlabContext = (
         async ({
           provider,
         }: {
-          provider: typeof SUPPORTED_GITLAB_CI_PROVIDERS[number];
+          provider: (typeof SUPPORTED_GITLAB_CI_PROVIDERS)[number];
         }) => {
           if (!provider) {
             throw new UserError('Cannot create context without a provider');
@@ -59,7 +59,7 @@ export const registerCreateGitlabContext = (
 };
 
 const createContext = (
-  provider: typeof SUPPORTED_GITLAB_CI_PROVIDERS[number]
+  provider: (typeof SUPPORTED_GITLAB_CI_PROVIDERS)[number]
 ) => {
   let normalizedContext: NormalizedCiContext;
   if (provider === 'gitlab') {

projects/optic-ci/src/cli/commands/utils/__tests__/context-parsers.test.ts

@@ -1,4 +1,4 @@
-import { jest, test, expect, describe } from '@jest/globals'
+import { jest, test, expect, describe } from '@jest/globals';
 import {
   readAndValidateCircleCiContext,
   readAndValidateGithubContext,

projects/optic-ci/src/cli/commands/utils/__tests__/count-exemptions.test.ts

@@ -1,4 +1,4 @@
-import { jest, test, expect, describe } from '@jest/globals'
+import { jest, test, expect, describe } from '@jest/globals';
 import { ChangeType, IChange } from '@useoptic/openapi-utilities';
 import { newExemptionsCount } from '../count-exemptions';
 

projects/optic/package.json

@@ -50,7 +50,7 @@
     "babel-plugin-transform-inline-environment-variables": "^0.4.3",
     "bent": "^7.3.12",
     "jest": "^29.3.1",
-    "prettier": "^2.8.1",
+    "prettier": "^3.0.0",
     "ts-jest": "^29.0.3",
     "ts-node": "^10.9.1",
     "typescript": "^5.0.0"

projects/optic/src/commands/history.ts

@@ -300,9 +300,11 @@ const logEndpointsChanges = (
     );
     return changeType === 'added' || changeType === 'removed'
       ? `${changeType} \`${param?.name}\` ${param?.in} parameter`
-      : `${changeType} \`${param?.name}\` ${
-          param?.in
-        } parameter ${getChangeDescription(segments.slice(5), spec, segments)}`;
+      : `${changeType} \`${param?.name}\` ${param?.in} parameter ${getChangeDescription(
+          segments.slice(5),
+          spec,
+          segments
+        )}`;
   };
 
   const getRequestBodyChange = (

projects/optic/src/commands/oas/coverage/api-coverage.ts

@@ -23,7 +23,7 @@ export class ApiCoverageCounter {
       Object.entries(methods || {}).forEach((entry) => {
         const [method, operation] = entry as [
           OpenAPIV3.HttpMethods,
-          OpenAPIV3.OperationObject
+          OpenAPIV3.OperationObject,
         ];
 
         if (Object.values(OpenAPIV3.HttpMethods).includes(method)) {

projects/optic/src/commands/oas/specs/files/reconcilers/stringify.ts

@@ -6,7 +6,7 @@ import invariant from 'ts-invariant';
 import { Result, Ok, Err } from 'ts-results';
 
 export const applyPatch: SpecFileReconciler<Config> = async function applyPatch<
-  Config
+  Config,
 >(
   filePath: string,
   fileContents: string,