itsatman

---
description: Clean Code Guidelines. Guidelines for writing clean, maintainable, and human-readable code. Apply these rules when writing or reviewing code to ensure consistency and quality
globs: 
---

# Clean Code Guidelines

## Constants Over Magic Numbers
- Replace hard-coded values with named constants
- Use descriptive constant names that explain the value's purpose

itsatman

---
description: Git Workflow Guidelines. Apply these rules when performing git operations
globs: 
---

# Git Workflow Guidelines

## Main Branches

### Main (or Master)

itsatman

name: Convex Reviewer

on:
  issue_comment:
    types: [created]

concurrency:
  group: convex-reviewer-${{ github.event.issue.number }}
  cancel-in-progress: true

itsatman

"use client";

import envClient from "@/env/client";
import { useAuthActions, useAuthToken } from "@convex-dev/auth/react";
import Script from "next/script";
import { useEffect, useRef, useState } from "react";

export default function GoogleOneTap() {
  const { signIn } = useAuthActions();
  const userToken = useAuthToken();

itsatman

---
description: Must-follow patterns for Convex mutations, queries, and usage of `api.` or `internal.`
alwaysApply: false
---
# Convex API Reference Patterns

## Overview

To avoid TypeScript deep instantiation errors (TS2589) when working with Convex's generated API objects, we use lightweight function references created with `makeFunctionReference` instead of importing `api` or `internal` from `convex/_generated/api`.

itsatman

import { parse } from 'dotenv';
import { readFile } from 'fs/promises';
import { watch } from "fs";

const ENV_FILE = '.env.local';

console.log(`Watching for changes in ${ENV_FILE}...`);

const watcher = watch(ENV_FILE, (event, filename) => {
  if (event === 'change') {

itsatman

This document serves as some special instructions when working with Convex.

Schemas

When designing the schema please see this page on built in System fields and data types available: https://docs.convex.dev/database/types

Here are some specifics that are often mishandled:

v (https://docs.convex.dev/api/modules/values#v)

itsatman

---
description: Guidelines for performing data migrations on convex
globs: convex/**
alwaysApply: false
---
Data migrations are really easy on Convex. 
# Adding a new field
Here's the general flow for adding a new field. Let's say we have a messages table
```ts
// convex/schema.ts

itsatman

# Convex guidelines

## Function guidelines

### New function syntax

- ALWAYS use the new function syntax for Convex functions. For example:

  ```ts
  import { query } from "./_generated/server";