sqlspec-writing-style

Enforce SQLSpec writing style and code requirements for code, documentation, and tests.

15|4|Updated Jan 20, 2026
One-click install
npx skills add https://github.com/cofin/flow --skill sqlspec-writing-style
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: sqlspec-writing-style
Source: https://github.com/cofin/flow/tree/main/skills/sqlspec-writing-style
Command: npx skills add https://github.com/cofin/flow --skill sqlspec-writing-style

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill ensures that all code, documentation, and tests adhere to the established SQLSpec writing style and quality requirements, preventing inconsistencies and maintaining high standards.

Core Features & Use Cases

  • Code Standards Enforcement: Guides developers on type annotations, import ordering, and code structure.
  • Testing Guidelines: Specifies requirements for writing effective tests, including the use of pytest and temporary files.
  • Quality Gate Adherence: Ensures that code meets predefined quality metrics.
  • Use Case: When writing a new SQLSpec feature, use this Skill to review your draft code and documentation against the official style guide and quality gates before submission.

Quick Start

Review the provided code snippet against the SQLSpec writing style and code requirements.

Frequently Asked Questions about sqlspec-writing-style

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

FAQPage Schema
How do I enforce SQLSpec coding standards for Python type annotations and imports?

You can enforce SQLSpec coding standards by applying this Skill to review Python code against rules for type annotations, import ordering, and guard clauses. It evaluates draft code to ensure adherence to predefined structural quality requirements.

What is the required format for Python docstrings and pytest tests in SQLSpec?

The required format for Python docstrings in SQLSpec is Google-style. For pytest tests, the Skill enforces specific testing conventions, including the use of temporary files for SQLite pooling tests to maintain isolation and quality standards.

How do I review Python code against SQLSpec function size limits and guard clauses?

Review Python code against SQLSpec function size limits by using this Skill to analyze your draft code. It guides adherence to guard clauses and function size restrictions, ensuring your code structure meets the established quality gates before submission.

Does the SQLSpec writing style require updates to documentation for new patterns?

Yes, the SQLSpec writing style mandates updates to the specs/guides/ directory for emerging patterns and requirements. This maintains alignment with Claude-style workflows and ensures documentation accurately reflects new code standards.

Why do SQLite pooling tests need temporary files when writing SQLSpec tests?

SQLite pooling tests need temporary files to ensure test isolation and prevent database state leakage. The SQLSpec writing style enforces this pytest convention to maintain high testing standards and reliable quality gate adherence.

Can I use this Skill to check both Python documentation and code quality together?

Yes, you can use this Skill to check both Python documentation and code quality together. It enforces SQLSpec writing style requirements across code, documentation, and tests, preventing inconsistencies and maintaining high standards.