Code Style - v1.0.5

Welcome to the documentation for the ArtisanPack UI Code Standards package. This documentation will help you understand how to use the package, configure it for your projects, and customize it to meet your specific needs.

Overview

ArtisanPack UI Code Standards is a custom PHP code style standard based on PHPStorm settings. This package provides custom sniffs for PHP_CodeSniffer that enforce consistent code style across your PHP projects.

Table of Contents

Getting Started

• Installation - How to install the package
• Troubleshooting - Common issues and solutions

Usage & Configuration

• Usage Guide - Basic usage instructions
• Customization - How to customize the standard

Sniffs Reference

• All Custom Sniffs - Complete overview of all sniffs
• Security Sniffs - Security-focused sniffs documentation

Contributing

• Contributing Guidelines - How to contribute to the project
• AI Guidelines - Guidelines for AI-assisted development

Quick Start

Installation

composer require artisanpack-ui/code-style --dev

Basic Configuration

Create a phpcs.xml file in your project root:

<?xml version="1.0"?>
<ruleset name="YourProjectStandard">
    <description>Your project's coding standard</description>

    <!-- Use ArtisanPackUI standard -->
    <rule ref="ArtisanPackUIStandard"/>

    <!-- Specify paths to check -->
    <file>app</file>
    <file>src</file>
    <file>tests</file>

    <!-- Exclude paths -->
    <exclude-pattern>*/vendor/*</exclude-pattern>
    <exclude-pattern>*/node_modules/*</exclude-pattern>
</ruleset>

Running PHP_CodeSniffer

./vendor/bin/phpcs --standard=ArtisanPackUIStandard .

Or if you've set up a custom phpcs.xml file:

./vendor/bin/phpcs

For more detailed information, please refer to the specific documentation sections linked in the table of contents.