convex-typecheck-guard

Execute pnpm convex typecheck on file changes under convex/.

2|4|Updated Jun 23, 2025
One-click install
npx skills add https://github.com/xrehpicx/vector --skill convex-typecheck-guard
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: convex-typecheck-guard
Source: https://github.com/xrehpicx/vector/tree/main/.agents/skills/convex-typecheck-guard
Command: npx skills add https://github.com/xrehpicx/vector --skill convex-typecheck-guard

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Manages and enforces the pnpm convex typecheck process, ensuring the integrity of Convex code whenever files in the convex/ directory are modified.

Core Features & Use Cases

  • Automated Type Checking: Executes type checking automatically after modifications to files in the convex/ directory.
  • Pre-Commit Safety: Helps in catching potential errors early in the development cycle, enhancing code quality and safety.
  • Use Case: For any Convex backend edit, schema change, permission update, migration, query, mutation, action, or generated API-affecting change.

Quick Start

Run the convex-typecheck-guard skill after modifying files under convex/ and before commit, push, or final handoff.

Frequently Asked Questions about convex-typecheck-guard

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automate type checking for my Convex backend code?

Automate Convex type checking by running a guard process that executes `pnpm convex typecheck` automatically whenever files under the `convex/` directory are modified. This enforces code integrity during development.

When should I run type checks on my Convex codebase?

Run Convex type checks after any backend edit, including schema changes, permission updates, migrations, queries, or mutations, and always before commit, push, or final handoff to catch errors early.

What do I need to set up to run automated Convex type checks?

You need a Convex environment capable of parsing and executing type checking scripts, along with the `pnpm` package manager to run the `convex typecheck` command on your codebase.

Can I catch Convex schema errors before committing code?

Yes, executing `pnpm convex typecheck` after modifying files in the `convex/` directory serves as pre-commit safety to catch potential schema and type errors early in the development cycle.

Does this type checking approach work with all Convex backend modifications?

Yes, this type checking process works with any Convex backend edit, covering schema changes, permission updates, migrations, queries, mutations, actions, and generated API-affecting changes.

Why does my Convex type check fail on file changes?

Convex type checking fails on file changes when modifications under the `convex/` directory introduce type errors or schema inconsistencies, which the `pnpm convex typecheck` script detects during validation.