convention-audit

Detect deviations from coding standards, directory structures, naming conventions, and import practices across project files.

1.0k|71|Updated Apr 1, 2025
One-click install
npx skills add https://github.com/ChenyCHENYU/Robot_Admin --skill convention-audit
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: convention-audit
Source: https://github.com/ChenyCHENYU/Robot_Admin/tree/main/.github/skills/convention-audit
Command: npx skills add https://github.com/ChenyCHENYU/Robot_Admin --skill convention-audit

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill helps developers and code reviewers automatically identify deviations from project coding standards and best practices, reducing manual effort and ensuring consistency.

Core Features & Use Cases

  • Code Structure Compliance: Checks adherence to directory naming conventions, file naming, and required file types in project structures.
  • Naming and Comment Standards: Validates variable, function, and component naming conventions, as well as the presence of proper file headers and documentation.
  • Style and Import Audits: Ensures code style consistency, proper import order, and avoidance of forbidden patterns.
  • Quick Start: Describe to the AI to review a specific code file for style and structural issues as per project standards.

Quick Start

Use the convention-audit skill to review the code in src/components/Header.vue for compliance with project conventions.

Frequently Asked Questions about convention-audit

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

FAQPage Schema
How do I automatically check code compliance with naming conventions and directory structures?

To check code compliance, parse project files to automatically detect deviations from directory structures, naming conventions, and import practices. This continuous enforcement reduces manual effort and ensures consistency across large codebases.

Can I use this for pre-merge checks and code reviews in large codebases?

Yes, you can use this for pre-merge checks and code reviews in large codebases. It automatically detects style compliance issues, improper imports, and structural deviations, ensuring continuous code quality enforcement before merging.

What is the best way to validate variable naming conventions and file headers?

The best way to validate variable naming conventions and file headers is to parse the code for style and required documentation. This process identifies deviations from established standards and ensures proper documentation is present.

How do I audit import order and avoid forbidden patterns in my project files?

To audit import order and avoid forbidden patterns, run an automated style and import audit across project files. This detects non-compliant import practices and enforces code style consistency according to your project standards.

Does this code review process require any specific dependencies or linting tools?

No specific dependencies or external linting tools are required. The code review process operates independently by parsing code directly for style, headers, imports, and directory structures to identify deviations from coding standards.