Standardize prettier config and format

Author: ianmacartney

.expo/README.md

@@ -1,8 +1,14 @@
-> Why do I have a folder named ".expo" in my project?
-The ".expo" folder is created when an Expo project is started using "expo start" command.
-> What do the files contain?
-- "devices.json": contains information about devices that have recently opened this project. This is used to populate the "Development sessions" list in your development builds.
-- "settings.json": contains the server configuration that is used to serve the application manifest.
-> Should I commit the ".expo" folder?
-No, you should not share the ".expo" folder. It does not contain any information that is relevant for other developers working on the project, it is specific to your machine.
-Upon project creation, the ".expo" folder is already added to your ".gitignore" file.
+> Why do I have a folder named ".expo" in my project? The ".expo" folder is
+> created when an Expo project is started using "expo start" command. What do
+> the files contain?
+
+- "devices.json": contains information about devices that have recently opened
+  this project. This is used to populate the "Development sessions" list in your
+  development builds.
+- "settings.json": contains the server configuration that is used to serve the
+  application manifest.
+  > Should I commit the ".expo" folder? No, you should not share the ".expo"
+  > folder. It does not contain any information that is relevant for other
+  > developers working on the project, it is specific to your machine. Upon
+  > project creation, the ".expo" folder is already added to your ".gitignore"
+  > file.

.prettierrc.json

@@ -0,0 +1,4 @@
+{
+  "trailingComma": "all",
+  "proseWrap": "always"
+}

CLAUDE.md

@@ -1,7 +1,9 @@
 # Claude Development Notes
 
 ## Codegen Command
+
 After making changes to component functions, run codegen with:
+
 ```bash
 cd example/ && npm run dev -- --once
 ```
@@ -10,18 +12,23 @@ cd example/ && npm run dev -- --once
 
 When adding new functions to this Convex component:
 
-1. **Client function** (`src/client/index.ts`): 
-   - Add method to `PushNotifications` class that calls `ctx.runMutation(this.component.public.functionName, { ...args, logLevel: this.config.logLevel })`
+1. **Client function** (`src/client/index.ts`):
+
+   - Add method to `PushNotifications` class that calls
+     `ctx.runMutation(this.component.public.functionName, { ...args, logLevel: this.config.logLevel })`
    - Follow existing patterns for argument types and return types
 
 2. **Component function** (`src/component/public.ts`):
+
    - Define args schema using `v.object()`
    - Export mutation/query with proper return type
    - Call `ensureCoordinator(ctx)` after processing for coordination
 
 3. **Batch functions**:
-   - Use existing handler functions (like `sendPushNotificationHandler`) in loops
+
+   - Use existing handler functions (like `sendPushNotificationHandler`) in
+     loops
    - Call `ensureCoordinator` once after all processing
    - Return array of results matching individual function return types
 
-4. **Always run codegen** after changes to regenerate types
+4. **Always run codegen** after changes to regenerate types

README.md

@@ -4,8 +4,10 @@
 
 <!-- START: Include on https://convex.dev/components -->
 
-This is a Convex component that integrates with [Expo's push notification API](https://docs.expo.dev/push-notifications/overview/)
-to allow sending mobile push notifications to users of your app. It will batch calls to Expo's API and handle retrying delivery.
+This is a Convex component that integrates with
+[Expo's push notification API](https://docs.expo.dev/push-notifications/overview/)
+to allow sending mobile push notifications to users of your app. It will batch
+calls to Expo's API and handle retrying delivery.
 
 <details>
   <summary>Demo GIF</summary>
@@ -51,11 +53,12 @@ export const sendPushNotification = mutation({
 
 ## Pre-requisite: Convex
 
-You'll need an existing Convex project to use the component.
-Convex is a hosted backend platform, including a database, serverless functions,
-and a ton more you can learn about [here](https://docs.convex.dev/get-started).
+You'll need an existing Convex project to use the component. Convex is a hosted
+backend platform, including a database, serverless functions, and a ton more you
+can learn about [here](https://docs.convex.dev/get-started).
 
-Run `npm create convex` or follow any of the [quickstarts](https://docs.convex.dev/home) to set one up.
+Run `npm create convex` or follow any of the
+[quickstarts](https://docs.convex.dev/home) to set one up.
 
 ## Installation
 
@@ -65,7 +68,8 @@ Install the component package:
 npm i @convex-dev/expo-push-notifications
 ```
 
-Create a `convex.config.ts` file in your app's `convex/` folder and install the component by calling `use`:
+Create a `convex.config.ts` file in your app's `convex/` folder and install the
+component by calling `use`:
 
 ```ts
 // convex/convex.config.ts
@@ -88,21 +92,24 @@ import { PushNotifications } from "@convex-dev/expo-push-notifications";
 const pushNotifications = new PushNotifications(components.pushNotifications);
 ```
 
-It takes in an optional type parameter (defaulting to `Id<"users">`) for the type to use as a unique identifier for push notification recipients:
+It takes in an optional type parameter (defaulting to `Id<"users">`) for the
+type to use as a unique identifier for push notification recipients:
 
 ```ts
 import { PushNotifications } from "@convex-dev/expo-push-notifications";
 
 export type Email = string & { __isEmail: true };
 
 const pushNotifications = new PushNotifications<Email>(
-  components.pushNotifications
+  components.pushNotifications,
 );
 ```
 
 ## Registering a user for push notifications
 
-Get a user's push notification token following the Expo documentation [here](https://docs.expo.dev/push-notifications/push-notifications-setup/#registering-for-push-notifications), and record it using a Convex mutation:
+Get a user's push notification token following the Expo documentation
+[here](https://docs.expo.dev/push-notifications/push-notifications-setup/#registering-for-push-notifications),
+and record it using a Convex mutation:
 
 ```ts
 // convex/example.ts
@@ -118,9 +125,11 @@ export const recordPushNotificationToken = mutation({
 });
 ```
 
-You can pause and resume push notification sending for a user using the `pausePushNotifications` and `resumePushNotifications` methods.
+You can pause and resume push notification sending for a user using the
+`pausePushNotifications` and `resumePushNotifications` methods.
 
-To determine if a user has a token and their pause status, you can use `getStatusForUser`.
+To determine if a user has a token and their pause status, you can use
+`getStatusForUser`.
 
 ## Send notifications
 
@@ -139,21 +148,24 @@ export const sendPushNotification = mutation({
 });
 ```
 
-You can use the ID returned from `sendPushNotifications` to query the status of the notification using `getNotification`.
-Using this in a query allows you to subscribe to the status of a notification.
+You can use the ID returned from `sendPushNotifications` to query the status of
+the notification using `getNotification`. Using this in a query allows you to
+subscribe to the status of a notification.
 
 You can also view all notifications for a user with `getNotificationsForUser`.
 
 ## Troubleshooting
 
-To add more logging, provide `PushNotifications` with a `logLevel` in the constructor:
+To add more logging, provide `PushNotifications` with a `logLevel` in the
+constructor:
 
 ```ts
 const pushNotifications = new PushNotifications(components.pushNotifications, {
   logLevel: "DEBUG",
 });
 ```
 
-The push notification sender can be shutdown gracefully, and then restarted using the `shutdown` and `restart` methods.
+The push notification sender can be shutdown gracefully, and then restarted
+using the `shutdown` and `restart` methods.
 
 <!-- END: Include on https://convex.dev/components -->

example/.expo/README.md

@@ -1,8 +1,14 @@
-> Why do I have a folder named ".expo" in my project?
-The ".expo" folder is created when an Expo project is started using "expo start" command.
-> What do the files contain?
-- "devices.json": contains information about devices that have recently opened this project. This is used to populate the "Development sessions" list in your development builds.
-- "settings.json": contains the server configuration that is used to serve the application manifest.
-> Should I commit the ".expo" folder?
-No, you should not share the ".expo" folder. It does not contain any information that is relevant for other developers working on the project, it is specific to your machine.
-Upon project creation, the ".expo" folder is already added to your ".gitignore" file.
+> Why do I have a folder named ".expo" in my project? The ".expo" folder is
+> created when an Expo project is started using "expo start" command. What do
+> the files contain?
+
+- "devices.json": contains information about devices that have recently opened
+  this project. This is used to populate the "Development sessions" list in your
+  development builds.
+- "settings.json": contains the server configuration that is used to serve the
+  application manifest.
+  > Should I commit the ".expo" folder? No, you should not share the ".expo"
+  > folder. It does not contain any information that is relevant for other
+  > developers working on the project, it is specific to your machine. Upon
+  > project creation, the ".expo" folder is already added to your ".gitignore"
+  > file.

example/.expo/types/router.d.ts

@@ -1,14 +1,52 @@
 /* eslint-disable */
-import * as Router from 'expo-router';
+import * as Router from "expo-router";
 
-export * from 'expo-router';
+export * from "expo-router";
 
-declare module 'expo-router' {
+declare module "expo-router" {
   export namespace ExpoRouter {
     export interface __routes<T extends string | object = string> {
-      hrefInputParams: { pathname: Router.RelativePathString, params?: Router.UnknownInputParams } | { pathname: Router.ExternalPathString, params?: Router.UnknownInputParams } | { pathname: `/App`; params?: Router.UnknownInputParams; } | { pathname: `/Demo`; params?: Router.UnknownInputParams; } | { pathname: `/_sitemap`; params?: Router.UnknownInputParams; };
-      hrefOutputParams: { pathname: Router.RelativePathString, params?: Router.UnknownOutputParams } | { pathname: Router.ExternalPathString, params?: Router.UnknownOutputParams } | { pathname: `/App`; params?: Router.UnknownOutputParams; } | { pathname: `/Demo`; params?: Router.UnknownOutputParams; } | { pathname: `/_sitemap`; params?: Router.UnknownOutputParams; };
-      href: Router.RelativePathString | Router.ExternalPathString | `/App${`?${string}` | `#${string}` | ''}` | `/Demo${`?${string}` | `#${string}` | ''}` | `/_sitemap${`?${string}` | `#${string}` | ''}` | { pathname: Router.RelativePathString, params?: Router.UnknownInputParams } | { pathname: Router.ExternalPathString, params?: Router.UnknownInputParams } | { pathname: `/App`; params?: Router.UnknownInputParams; } | { pathname: `/Demo`; params?: Router.UnknownInputParams; } | { pathname: `/_sitemap`; params?: Router.UnknownInputParams; };
+      hrefInputParams:
+        | {
+            pathname: Router.RelativePathString;
+            params?: Router.UnknownInputParams;
+          }
+        | {
+            pathname: Router.ExternalPathString;
+            params?: Router.UnknownInputParams;
+          }
+        | { pathname: `/App`; params?: Router.UnknownInputParams }
+        | { pathname: `/Demo`; params?: Router.UnknownInputParams }
+        | { pathname: `/_sitemap`; params?: Router.UnknownInputParams };
+      hrefOutputParams:
+        | {
+            pathname: Router.RelativePathString;
+            params?: Router.UnknownOutputParams;
+          }
+        | {
+            pathname: Router.ExternalPathString;
+            params?: Router.UnknownOutputParams;
+          }
+        | { pathname: `/App`; params?: Router.UnknownOutputParams }
+        | { pathname: `/Demo`; params?: Router.UnknownOutputParams }
+        | { pathname: `/_sitemap`; params?: Router.UnknownOutputParams };
+      href:
+        | Router.RelativePathString
+        | Router.ExternalPathString
+        | `/App${`?${string}` | `#${string}` | ""}`
+        | `/Demo${`?${string}` | `#${string}` | ""}`
+        | `/_sitemap${`?${string}` | `#${string}` | ""}`
+        | {
+            pathname: Router.RelativePathString;
+            params?: Router.UnknownInputParams;
+          }
+        | {
+            pathname: Router.ExternalPathString;
+            params?: Router.UnknownInputParams;
+          }
+        | { pathname: `/App`; params?: Router.UnknownInputParams }
+        | { pathname: `/Demo`; params?: Router.UnknownInputParams }
+        | { pathname: `/_sitemap`; params?: Router.UnknownInputParams };
     }
   }
 }

example/README.md

@@ -1,5 +1,4 @@
 # Example app
 
-Components need an app that uses them in order to run codegen. An example app is also useful
-for testing and documentation.
-
+Components need an app that uses them in order to run codegen. An example app is
+also useful for testing and documentation.

example/app/+html.tsx

@@ -1,5 +1,5 @@
-import { ScrollViewStyleReset } from 'expo-router/html';
-import { type PropsWithChildren } from 'react';
+import { ScrollViewStyleReset } from "expo-router/html";
+import { type PropsWithChildren } from "react";
 
 /**
  * This file is web-only and used to configure the root HTML for every web page during static rendering.
@@ -11,7 +11,10 @@ export default function Root({ children }: PropsWithChildren) {
       <head>
         <meta charSet="utf-8" />
         <meta httpEquiv="X-UA-Compatible" content="IE=edge" />
-        <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no" />
+        <meta
+          name="viewport"
+          content="width=device-width, initial-scale=1, shrink-to-fit=no"
+        />
 
         {/*
           Disable body scrolling on web. This makes ScrollView components work closer to how they do on native.

example/app/Demo.tsx

@@ -43,7 +43,7 @@ async function registerForPushNotificationsAsync() {
     }
     if (finalStatus !== "granted") {
       handleRegistrationError(
-        "Permission not granted to get push token for push notification!"
+        "Permission not granted to get push token for push notification!",
       );
       return;
     }
@@ -79,7 +79,7 @@ export function Demo() {
   const [notifId, setNotifId] = useState<string | null>(null);
   const notificationState = useQuery(
     api.example.getNotificationStatus,
-    notifId ? { id: notifId } : "skip"
+    notifId ? { id: notifId } : "skip",
   );
   const allUsers = useQuery(api.example.getUsers) ?? [];
 
@@ -116,7 +116,7 @@ export function Demo() {
               (error: unknown) => {
                 alert(`Error registering for push notifications: ${error}`);
                 return undefined;
-              }
+              },
             );
             if (token !== undefined) {
               await convex

src/client/index.ts

@@ -26,7 +26,7 @@ export class PushNotifications<UserType extends string = GenericId<"users">> {
     public component: ComponentApi,
     config?: {
       logLevel?: LogLevel;
-    }
+    },
   ) {
     this.component = component;
     this.config = {
@@ -42,7 +42,7 @@ export class PushNotifications<UserType extends string = GenericId<"users">> {
    */
   recordToken(
     ctx: RunMutationCtx,
-    args: { userId: UserType; pushToken: string }
+    args: { userId: UserType; pushToken: string },
   ): Promise<null> {
     return ctx.runMutation(this.component.public.recordPushNotificationToken, {
       ...args,
@@ -92,7 +92,7 @@ export class PushNotifications<UserType extends string = GenericId<"users">> {
       userId: UserType;
       notification: NotificationFields;
       allowUnregisteredTokens?: boolean;
-    }
+    },
   ) {
     return ctx.runMutation(this.component.public.sendPushNotification, {
       ...args,
@@ -115,7 +115,7 @@ export class PushNotifications<UserType extends string = GenericId<"users">> {
         notification: NotificationFields;
       }>;
       allowUnregisteredTokens?: boolean;
-    }
+    },
   ) {
     return ctx.runMutation(this.component.public.sendPushNotificationBatch, {
       ...args,
@@ -139,7 +139,7 @@ export class PushNotifications<UserType extends string = GenericId<"users">> {
    */
   getNotificationsForUser(
     ctx: RunQueryCtx,
-    args: { userId: UserType; limit?: number }
+    args: { userId: UserType; limit?: number },
   ) {
     return ctx.runQuery(this.component.public.getNotificationsForUser, {
       ...args,