xfi-create-plugin

Scaffold X-Fidelity plugins from the template with tests and registration guidance.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Creates a repeatable blueprint for building new X-Fidelity plugins from the official template, helping teams add analyses and extend the plugin system without starting from scratch.

Core Features & Use Cases

  • Structured plugin scaffold: Provides a ready-to-use directory layout with index.ts, facts/, operators/, and sampleRules/ to accelerate plugin development.
  • Test-driven development: Includes test skeletons for facts and operators to ensure reliability and maintainability.
  • Registration and extension guidance: Documents how to register the new plugin in the main registry and link it to sample rules for demonstration.

Quick Start

Follow this guide to scaffold a new plugin from the template and validate it with the included tests.

Frequently Asked Questions about xfi-create-plugin

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

FAQPage Schema
How do I scaffold a new X-Fidelity plugin from a template?

To scaffold an X-Fidelity plugin, this tool automates creating a structured directory layout from the official template, including index.ts, facts, operators, sampleRules, and test files.

What is the best way to add a custom analysis to an X-Fidelity plugin architecture?

The best way to add custom analyses is to generate a new plugin scaffold, which provides dedicated directories for facts and operators, then register the plugin in the main index.

How do I set up TypeScript tests for new facts and operators in a plugin?

Setting up TypeScript tests for new facts and operators is handled automatically by the scaffolding process, which includes test skeletons to ensure reliability and maintainability.

Do I need to manually register a new X-Fidelity plugin in the main registry?

Yes, you need to register the new plugin in the main registry. The scaffolding process provides guidance for plugin registration and demonstrates linking it to sample rules.

What directory structure is required for X-Fidelity plugin development?

X-Fidelity plugin development requires a structured directory layout containing an index.ts file, facts, operators, sampleRules, and a tests directory, all generated by the scaffold.