goravel-type-check

Verify type consistency between Go structs and TypeScript interfaces.

16|11|Updated Jun 12, 2025

Search Tags:#typescript #golang #frontend-backend #type-check #json-tag

Ready to run

npx skills add https://github.com/liwoo/goravel-inertia-tw-starter --skill goravel-type-check

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: goravel-type-check
Source: https://github.com/liwoo/goravel-inertia-tw-starter/tree/main/.claude/skills/goravel-type-check
Command: npx skills add https://github.com/liwoo/goravel-inertia-tw-starter --skill goravel-type-check

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Ensures Go backend models and requests stay in sync with TypeScript interfaces, preventing runtime type errors by validating parity across backend and frontend types.

Core Features & Use Cases

Cross-checks Go models in app/models and Go requests in app/http/requests against TS types in resources/js/types.
Validates field presence, JSON tag alignment, and nullable handling to guarantee API shape consistency.
Use case: when implementing a new feature that touches both backend and frontend types, run this check to surface mismatches and generate a remediation plan.

Quick Start

Run the type-consistency check on your Go models, requests, and TS types to surface any mismatches.

Frequently Asked Questions about goravel-type-check

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

FAQPage Schema

How do I check type consistency between Go backend structs and TypeScript interfaces?▼

To check type consistency between Go and TypeScript, analyze Go model and request structs alongside TS interfaces to verify field presence, type mappings, and JSON tag alignment. This surfaces mismatches to prevent frontend runtime errors.

Why do my TypeScript types not match the JSON tags in my Go models?▼

TypeScript types may not match Go JSON tags due to unsynchronized tag names or nullable field handling. A type-consistency check validates JSON tag alignment and required/optional fields, returning a report of mismatches to resolve.

What is the best way to sync Go request structs with TypeScript frontend types?▼

The best way to sync Go request structs with TypeScript types is to validate parity across backend and frontend types. Cross-checking files under app/http/requests and resources/js/types enforces strict type mappings and JSON tag synchronization.

Does this type checker work with standard Goravel project directory structures?▼

Yes, this type checker works with standard Goravel structures by targeting models under app/models and requests under app/http/requests, paired with TypeScript types in resources/js/types to verify API shape consistency.

Can I validate nullable field handling and required fields across Go and TS?▼

You can validate nullable field handling and required fields by cross-checking Go backend models and requests against TypeScript interfaces. This enforces strict type mappings to guarantee API shape consistency.

What are the limitations of automated type checking for Go and TypeScript parity?▼

Automated type checking for Go and TypeScript parity is limited to specific directory paths, requiring Go models in app/models, requests in app/http/requests, and TS types in resources/js/types to accurately generate a remediation report.