xfi-create-rule

Define and guide creation of X-Fidelity analysis rules with JSON and archetypes.

1|1|Updated Dec 20, 2023
One-click install
npx skills add https://github.com/zotoio/x-fidelity --skill xfi-create-rule
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: xfi-create-rule
Source: https://github.com/zotoio/x-fidelity/tree/main/.cursor/skills/xfi-create-rule
Command: npx skills add https://github.com/zotoio/x-fidelity --skill xfi-create-rule

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill provides a structured, end-to-end guide for creating new X-Fidelity analysis rules, enabling teams to formalize rule purpose, required data, and implementation steps to ensure consistent governance across repositories.

Core Features & Use Cases

  • Stepwise workflow: define rule purpose, select necessary facts and operators, and craft JSON rules.
  • Archetype integration: show how to plug new rules into archetypes and configuration.
  • Validation and testing: guide through running tests and verifying behavior in CLI or config server.

Quick Start

Create and implement a new X-Fidelity rule by defining its purpose, selecting the appropriate facts and operators, drafting the rule JSON, adding it to an archetype, and validating it with tests.

Frequently Asked Questions about xfi-create-rule

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

FAQPage Schema
How do I create custom static analysis rules for code quality governance?

To create static analysis rules, define the rule purpose, select necessary facts and operators, draft the JSON rule definitions, and integrate them with archetypes for testing and validation.

What is the process for developing X-Fidelity rules end-to-end?

X-Fidelity rule development involves defining the rule's purpose, selecting appropriate facts and operators, drafting the JSON rule structure, adding it to an archetype, and validating its behavior through CLI or config server tests.

How do I test custom analysis rules using archetypes?

Testing custom rules with archetypes requires plugging the newly drafted JSON rules into the archetype configuration, running the validation tests, and verifying the expected behavior through the CLI or config server.

What facts and operators do I need to build a static analysis rule?

Building a static analysis rule requires selecting specific facts and operators that match your rule's defined purpose, which are then combined within the JSON rule structure to enforce code quality governance.

Can I validate new JSON rules without a full deployment?

Validating new JSON rules without full deployment is possible by running targeted tests locally through the CLI or config server to verify the rule behavior against integrated archetypes.

When should I formalize code quality checks into structured JSON rules?

Formalizing code quality checks into structured JSON rules is necessary when teams need consistent governance across multiple repositories, requiring defined rule purposes and standardized facts and operators.