new-constraint

Plan end-to-end implementation steps for a new evitaDB query constraint.

70|7|Updated Feb 22, 2023
One-click install
npx skills add https://github.com/FgForrest/evitaDB --skill new-constraint
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: new-constraint
Source: https://github.com/FgForrest/evitaDB/tree/main/.claude/skills/new-constraint
Command: npx skills add https://github.com/FgForrest/evitaDB --skill new-constraint

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill helps engineering teams plan and execute the full integration of a new evitaDB query constraint (filter, order, or require) by producing a detailed, layer-spanning implementation plan with exact file paths.

Core Features & Use Cases

  • Gather requirements from stakeholders to define constraint type, behavior, and scope.
  • Identify the closest existing constraint template and trace its influence across all layers (query model, EvitaQL grammar, engine translation, serializer, tests, and docs).
  • Produce a complete plan listing every target file path to create or modify, plus notes on deviations from the template, and save the plan to docs/plans with a clear filename.
  • Validate critical rules (Kryo registration, grammar regeneration, test coverage guidelines) to ensure a production-ready rollout.

Quick Start

Provide a complete end-to-end plan for a new constraint and save it to docs/plans with a descriptive filename.

Frequently Asked Questions about new-constraint

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

FAQPage Schema
How do I plan end-to-end implementation for a new evitaDB constraint?

To plan a new evitaDB constraint, gather requirements to define its type and behavior, then trace an existing template constraint across all layers to generate a complete file manifest with exact paths for modification.

What files need to be modified when adding a new filter or order constraint in evitaDB?

Adding a new evitaDB constraint requires modifying files across the query model, EvitaQL grammar, engine translators, Kryo serializers, external APIs, tests, and documentation, ensuring all Kryo registration rules are followed.

How does evitaDB constraint planning handle EvitaQL grammar generation and Kryo serialization?

evitaDB constraint planning validates critical rules by tracing template constraints through EvitaQL grammar regeneration and Kryo serializer registration to ensure the new constraint is production-ready across all engine layers.

Can I use an existing constraint as a template to implement a new require constraint in evitaDB?

Yes, you can identify the closest existing constraint template and trace its influence across all layers to produce a complete implementation plan, noting any deviations from the original template behavior and scope.

What is the best way to document a new evitaDB constraint implementation plan?

The best way to document a new evitaDB constraint plan is to save the complete end-to-end implementation steps, including exact file paths and deviation notes, to the docs/plans directory with a clear, descriptive filename.

Does a new evitaDB constraint require test coverage across all integration layers?

Yes, a new evitaDB constraint requires test coverage validated against guidelines, ensuring the query model, EvitaQL grammar, engine translation, and external APIs all function correctly before production rollout.