### PHP Encoding Example (UTF-8 without BOM)

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

Demonstrates the `encoding` rule, which ensures PHP files use UTF-8 encoding without a Byte Order Mark (BOM). The example shows the removal of a leading BOM.

```diff
-<?
+<?php

 echo "Hello!";

```

--------------------------------

### PHP Clean Namespace Example

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

Demonstrates the `clean_namespace` rule, which removes extraneous spacing and comments from namespace declarations, ensuring a clean and concise format.

```diff
<?php
-namespace Foo \ Bar;
+namespace Foo\Bar;

```

```diff
<?php
-echo foo /* comment */ \ bar();
+echo foo\bar();

```

--------------------------------

### PHP Class Definition Whitespace Examples

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

Illustrates the formatting of class definitions according to the `class_definition` rule. It shows how `extends` and `implements` clauses are consolidated or formatted for readability.

```diff
<?php

-class Foo
-extends Bar
-implements Baz, BarBaz
+class Foo extends Bar implements Baz, BarBaz
 {}

```

```diff
<?php

-class Foo
-extends Bar
-implements Baz
+class Foo extends Bar implements Baz
 {}

```

```diff
<?php

 interface Bar extends
-    Bar, BarBaz, FooBarBaz
+    Bar,
+    BarBaz,
+    FooBarBaz
 {}

```

--------------------------------

### PHP Compact Nullable Typehint Example

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

Applies the `compact_nullable_typehint` rule to remove unnecessary spaces within nullable type hints in PHP function signatures.

```diff
<?php
-function sample(? string $str): ? string
+function sample(?string $str): ?string
 {}

```

--------------------------------

### PHP Constant Casing Example

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

Illustrates the `constant_case` rule, which corrects the casing of `TRUE`, `FALSE`, and `NULL` to their standard lowercase forms.

```diff
<?php
-$a = FALSE;
-$b = True;
-$c = nuLL;
+$a = false;
+$b = true;
+$c = null;

```

--------------------------------

### PHP Brace Placement Examples

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

Illustrates the transformation of PHP code based on brace placement rules. It shows how `if` statements, function definitions, anonymous functions, classes, and anonymous classes are reformatted.

```diff
<?php
// control_structures_opening_brace = same_line
-if (foo())
-{
+if (foo()) {
    bar();
}

// functions_opening_brace = next_line_unless_newline_at_signature_end
-function foo() {
+function foo()
+{
}

// anonymous_functions_opening_brace = same_line
-$foo = function()
-{
+$foo = function() {
};

// classes_opening_brace = next_line_unless_newline_at_signature_end
-class Foo {
+class Foo
+{
}

// anonymous_classes_opening_brace = next_line_unless_newline_at_signature_end
-$foo = new class {
+$foo = new class
+{
};

// allow_single_line_empty_anonymous_classes = true
static::swap(
-    $fake = new class extends TestCampaignClass
-    {
+    $fake = new class extends TestCampaignClass {
        //...
    }
)

// allow_single_line_anonymous_functions = false
-$foo = function () { return true; };
+$foo = function () {
+    return true;
+};

```

--------------------------------

### PHP Class Attribute Separation Example

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

Shows how the `class_attributes_separation` rule reformats class definitions by ensuring a consistent number of blank lines between methods.

```diff
final class Sample
     protected function foo()
     {
     }
+
     protected function bar()
     {
     }
-
-
 }

```

--------------------------------

### PHP Declare Equal Normalize Example

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

Applies the `declare_equal_normalize` rule to ensure consistent spacing around the equals sign in `declare` statements.

```diff
<?php
-declare(ticks =  1);
+declare(ticks=1);

```

```diff
<?php
-declare(ticks=1);
+declare(ticks = 1);

```

--------------------------------

### PHP Elseif Keyword Example

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

Replaces `else if` with the single keyword `elseif` in PHP control structures for consistency, as per the `elseif` rule.

```diff
<?php
 if ($a) {
-}
 else if ($b) {
+}
 elseif ($b) {
 }

```

--------------------------------

### PHP Cast Spaces Examples

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

Demonstrates the application of the `cast_spaces` rule in PHP. It shows the removal of extra spaces between cast operators like `(string)` and `(int)` and their associated variables.

```diff
<?php
-$bar = ( string )  $a;
-$foo = (int)$b;
+$bar = (string) $a;
+$foo = (int) $b;

```

```diff
<?php
-$bar = ( string )  $a;
-$foo = (int)$b;
+$bar = (string) $a;
+$foo = (int) $b;

```

```diff
<?php
-$bar = ( string )  $a;
-$foo = (int)$b;
+$bar = (string)$a;
+$foo = (int)$b;

```

--------------------------------

### PHP Concatenation Spacing Example

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

Shows the effect of the `concat_space` rule on PHP string concatenation. It adds or removes spaces around the `.` operator based on the configuration.

```diff
<?php
-$foo = 'bar' . 3 . 'baz'.'qux';
+$foo = 'bar' . 3 . 'baz' . 'qux';

```

--------------------------------

### Duster Configuration Example (duster.json)

Source: https://context7.com/tighten/duster/llms.txt

An example `duster.json` file for customizing Duster's behavior. It includes options for specifying directories to include and exclude, defining custom lint and fix scripts, and setting a process timeout.

```json
{
    "include": [
        "app",
        "config",
        "database",
        "routes",
        "tests"
    ],
    "exclude": [
        "tests/Fixtures",
        "**/generated/**",
        "app/Legacy"
    ],
    "scripts": {
        "lint": {
            "phpstan": ["./vendor/bin/phpstan", "analyse"],
            "pest": ["./vendor/bin/pest", "--parallel"]
        },
        "fix": {
            "rector": ["./vendor/bin/rector", "process"]
        }
    },
    "processTimeout": 120
}
```

--------------------------------

### Duster CLI: Husky Hooks Setup

Source: https://context7.com/tighten/duster/llms.txt

Sets up Git pre-commit hooks using Husky and lint-staged for automatic code style enforcement before commits. Supports interactive setup and specific environment flags for containerized development environments like DDEV, Lando, Warden, and Sail.

```bash
# Interactive setup for Husky hooks
./vendor/bin/duster husky-hooks

# For containerized environments (DDEV, Lando, Warden, Sail)
./vendor/bin/duster husky-hooks --env=ddev
./vendor/bin/duster husky-hooks --env=lando
./vendor/bin/duster husky-hooks --env=warden
./vendor/bin/duster husky-hooks --env=sail
```

--------------------------------

### PHP Fully Qualified Strict Types Example

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

Transforms imported fully qualified class names (FQCN) in function arguments and return types to their shorter, imported versions, adhering to the `fully_qualified_strict_types` rule.

```php
<?php

use App\Domain\Entity\User;

function processUser(User $user): User
{
    // ...
}

```

--------------------------------

### GitHub Actions Workflow Example (Lint)

Source: https://context7.com/tighten/duster/llms.txt

An example GitHub Actions workflow file (`duster-lint.yml`) that uses the `tighten/duster-action` to perform linting on push or pull request events. It checks out the code and then runs the Duster lint command.

```yaml
name: Duster Lint

on:
    push:
        branches: [ main ]
    pull_request:

jobs:
  duster:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4
        with:
          ref: ${{ github.event.pull_request.head.ref }}
          repository: ${{ github.event.pull_request.head.repo.full_name }}
      - name: "Duster Lint"
        uses: tighten/duster-action@v3
        with:
          args: lint
```

--------------------------------

### Order PHPDoc annotations

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

This rule enforces a specific order for PHPDoc annotations, prioritizing @param, then @throws, and finally @return. The configuration specifies this order, and the example shows a diff for a PHP docblock.

```php
/**
  * Hello there!
  *
- * @throws Exception|RuntimeException foo
  * @custom Test!
- * @return int  Return the number of changes.
  * @param string $foo
  * @param bool   $bar Bar
+ * @throws Exception|RuntimeException foo
+ * @return int  Return the number of changes.
  */

```

--------------------------------

### Install Dev Dependencies with Composer

Source: https://github.com/tighten/duster/blob/3.x/CONTRIBUTING.md

Installs development dependencies for the project using Composer. It specifies a development-specific composer file for installation.

```bash
COMPOSER=composer-dev.json composer install
```

--------------------------------

### Prefer Auth Helper Over Facade

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

Encourages the use of the `auth()` helper function instead of the `Auth` facade for accessing authentication information, promoting cleaner code.

```diff
@extends('layouts.app')
-@if (!\Illuminate\Support\Facades\Auth::check())
+-@if (!auth()->check())
    <label for="email">Email</label>
    <input id="email" class="form-control" type="email" name="email" required>
@else
    <input id="email" type="hidden" name="email" value="{{ auth()->user()->email }}" required>
@endif
```

--------------------------------

### Use Correct Casing for Native PHP Functions

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

Ensures that built-in PHP functions are called using their correct, standard casing. For example, 'strlen()' should be used instead of 'STRLEN()'.

```php
<?php
-STRLEN($str);
+strlen($str);

```

--------------------------------

### Trim whitespace from PHPDoc

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

This rule ensures that PHPDoc blocks start and end with content, excluding leading and trailing blank lines within the docblock itself. The example shows a PHP class docblock with extraneous blank lines removed.

```php
<?php
 /**
- *
  * Foo must be final class.
- *
- *
  */
 final class Foo {}

```

--------------------------------

### Use request() Helper Function Directly in PHP

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

This formatter replaces `request()->get()` or similar methods with the direct `request()` helper function for accessing request values. This simplifies code and promotes the use of Laravel's built-in helpers.

```php
<?php

namespace App;

class Controller
{
    public function index()
    {
-        return SavedVehicle::findOrFail(request()->get('savedVehicleId'));
+        return SavedVehicle::findOrFail(request('savedVehicleId'));
    }
}

```

--------------------------------

### Duster with Containerized Environment

Source: https://github.com/tighten/duster/blob/3.x/README.md

Installs Duster's Husky hooks while specifying a containerized environment like ddev, useful when PHP is not installed locally.

```bash
./vendor/bin/duster husky-hooks --env=ddev
```

--------------------------------

### PHP Explicit String Variable Example

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

Transforms implicit variables in double-quoted strings and heredoc syntax into explicit ones using curly braces, as required by the `explicit_string_variable` rule.

```diff
<?php
-$a = "My name is $name !";
-$b = "I live in $state->country !";
-$c = "I have $farm[0] chickens !";
+$a = "My name is {$name} !";
+$b = "I live in {$state->country} !";
+$c = "I have {$farm[0]} chickens !";

```

--------------------------------

### No empty PHPDoc blocks

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

This rule disallows empty PHPDoc blocks (`/** */`). It ensures that PHPDoc blocks, when present, contain meaningful documentation.

```php
-<?php /**  */
+<?php

```

--------------------------------

### Group and separate PHPDoc annotations

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

This rule enforces grouping of similar PHPDoc annotations and separation of different groups with a blank line. The configuration defines the groups, and the example shows a PHP docblock with correct spacing.

```php
<?php
 /**
  * Description.
- * @param string $foo
- *
  *
+ * @param string $foo
  * @param bool   $bar Bar
+ *
  * @throws Exception|RuntimeException
+ *
  * @return bool
  */
 function fnc($foo, $bar) {}

```

--------------------------------

### Include/Require statement formatting

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

Ensures that include/require statements have a single space between the keyword and the file path, and that the file path is not enclosed in brackets. This standardizes the syntax for file inclusion.

```php
<?php
-require ("sample1.php");
-require_once  "sample2.php";
-include       "sample3.php";
-include_once("sample4.php");
+require "sample1.php";
+require_once "sample2.php";
+include "sample3.php";
+include_once "sample4.php";
```

--------------------------------

### One import per statement (PHP)

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

Ensures that each 'use' keyword is followed by only one imported namespace or class. This applies to both individual imports and group uses, promoting a consistent import style.

```diff
<?php
-use Foo, Sample, Sample\Sample as Sample2;
+use Foo;
+use Sample;
+use Sample\Sample as Sample2;
```

```diff
<?php
-use Space\Models\ {
-    TestModelA,
-    TestModelB,
-    TestModel,
-};
+use Space\Models\TestModelA;
+use Space\Models\TestModelB;
+use Space\Models\TestModel;
```

--------------------------------

### Use statement for class alias

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

Demonstrates how to use a 'use' statement to alias a class from a namespace, simplifying its usage in the code. This is useful for reducing the verbosity of fully qualified names.

```php
use Foo\Bar;

 class SomeClass
 {
-    public function doSomething(\Foo\Bar $foo)
+    public function doSomething(Bar $foo)
     {
     }
 }
```

```php
use Foo\Bar\Baz;

 class SomeClass
 {
-    public function doSomething(\Foo\Bar $foo): \Foo\Bar\Baz
+    public function doSomething(Bar $foo): Baz
     {
     }
 }
```

--------------------------------

### PHP_CodeSniffer Configuration for Duster

Source: https://github.com/tighten/duster/blob/3.x/README.md

Example `.phpcs.xml.dist` file to configure PHP_CodeSniffer with the Tighten preset for Duster.

```xml
<?xml version="1.0"?>
<ruleset>
    <file>app</file>
    <file>config</file>
    <file>database</file>
    <file>public</file>
    <file>resources</file>
    <file>routes</file>
    <file>tests</file>

    <rule ref="Tighten"/>
</ruleset>
```

--------------------------------

### Use correct case for standard PHP types in PHPDoc

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

Ensures that standard PHP types in PHPDoc annotations use the correct casing (e.g., 'string' instead of 'STRING', 'int' instead of 'inT'). Examples cover @param and @return annotations in PHP.

```php
<?php
 /**
- * @param STRING|String[] $bar
+ * @param string|string[] $bar
  *
- * @return inT[]
+ * @return int[]
  */

```

```php
<?php
 /**
- * @param BOOL $foo
+ * @param bool $foo
  *
  * @return MIXED
  */

```

--------------------------------

### Install Duster via Composer

Source: https://github.com/tighten/duster/blob/3.x/README.md

Installs the Duster package as a development dependency in your Laravel project using Composer.

```bash
composer require tightenco/duster --dev
```

--------------------------------

### Use scalar types in PHPDoc

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

Ensures consistent and correct casing for scalar type hints in PHPDoc, using 'int' instead of 'integer', 'bool' instead of 'boolean', and 'float' instead of 'real' or 'double'. Examples cover both @param and @return annotations in PHP.

```php
<?php
 /**
- * @param integer $a
- * @param boolean $b
- * @param real $c
+ * @param int $a
+ * @param bool $b
+ * @param float $c
  *
- * @return double
+ * @return float
  */
 function sample($a, $b, $c)
 {
}

```

```php
<?php
 /**
  * @param integer $a
- * @param boolean $b
+ * @param bool $b
  * @param real $c
  */
 function sample($a, $b, $c)
 {
}

```

--------------------------------

### Disable Missing Namespace Rule

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

Configuration to exclude test and database files from the PSR1.Classes.ClassDeclaration.MissingNamespace rule, as these files may not always require namespaces.

```xml
<exclude-pattern>*/database/*</exclude-pattern>
<exclude-pattern>*/tests/*</exclude-pattern>
```

--------------------------------

### Custom Controller Order Configuration

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

Defines a custom order for controller class elements, including traits, properties, constants, and methods, to ensure a consistent and organized structure.

```php
[
  'order' => [
    'use_trait',
    'property_public_static',
    'property_protected_static',
    'property_private_static',
    'constant_public',
    'constant_protected',
    'constant_private',
    'property_public',
    'property_protected',
    'property_private',
    'construct',
    'method:__invoke',
    'method_public_static',
    'method_protected_static',
    'method_private_static',
    'method:index',
    'method:create',
    'method:store',
    'method:show',
    'method:edit',
    'method:update',
    'method:destroy',
    'method_public',
    'method_protected',
    'method_private',
    'magic',
  ],
]
```

--------------------------------

### Exclude Config Directory from UseConfigOverEnv Rule

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

Configuration to exclude the `/config` directory from the Tighten.PHP.UseConfigOverEnv rule, allowing the use of `env()` within configuration files.

```xml
<exclude-pattern>/config/*</exclude-pattern>
```

--------------------------------

### Fix PHPDoc @link and @tutorial tags

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

Ensures that PHPDoc @link and @tutorial tags are correctly formatted, typically by changing curly braces to square brackets. This rule applies to PHP code.

```php
<?php
 /**
- * @{TUTORIAL}
- * {{ @link }}
+ * {@TUTORIAL}
+ * {@link}
  * @inheritDoc
  */

```

```php
<?php
 /**
- * @{TUTORIAL}
+ * {@TUTORIAL}
  * {{ @link }}
  * @inheritDoc
  */

```

--------------------------------

### Correct Casing for PHP Magic Constants

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

Ensures that magic constants in PHP, like '__DIR__', are always written in uppercase as per the standard.

```php
<?php
-echo __dir__;
+echo __DIR__;

```

--------------------------------

### Disable PSR1.Files.SideEffects Rule

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

Configuration to exclude the `public/index.php` file from the PSR1.Files.SideEffects rule, allowing it to contain both declarations and side effects.

```xml
<exclude-pattern>/public/index.php</exclude-pattern>
```

--------------------------------

### PHP Blank Line After Opening Tag Fix

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

Ensures that there is no code on the same line as the opening PHP tag (`<?php`) and that it is followed by a blank line. This promotes cleaner file structures.

```diff
-<?php $a = 1;
+<?php
+
+$a = 1;
 $b = 1;
```

--------------------------------

### Format Blade Whitespace

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

Ensures consistent spacing around Blade rendered content, converting `{{1 + 1}}` to `{{ 1 + 1 }}` for improved readability.

```diff
-@if(true)
+@if (true)
    This is true.
-@elseif(false)
+@elseif (false)
    This is false.
@endif

-@unless(true)
+@unless (true)
    This isn't true.
@endunless
```

```diff
-{{1 + 1}}
+{{ 1 + 1 }}

-{{ 1 + 1 }} {{1 + 1}}
+{{ 1 + 1 }} {{ 1 + 1 }}

-{{1 + 1    }}
+{{ 1 + 1 }}
```

--------------------------------

### Standardize Ternary Operator Spaces

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

Ensures consistent spacing around the ternary operator (?:). This rule adds or removes spaces to maintain a uniform style.

```php
<?php $a = $a ? 1 : 0;

```

--------------------------------

### No blank lines after class opening brace

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

This rule prevents empty lines immediately following the opening brace `{` of a class definition. It aims for more compact and direct class structure.

```php
<?php
 final class Sample
 {
- 
     protected function foo()
     {
     }

```

--------------------------------

### PHP: Ordered Imports

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

Sorts `use` statements in PHP files according to a defined order, typically alphabetically or by type (const, class, function). This enhances code organization and maintainability.

```php
<?php
-use const BBB;
 use const AAAA;
+use const BBB;

-use Acme;
 use AAC;
+use Acme;
 use Bar;

-use function DDD;
 use function CCC\AA;
+use function DDD;
```

--------------------------------

### Single blank line before namespace declaration (PHP)

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

Requires exactly one blank line before a namespace declaration. This improves readability by visually separating the namespace definition from preceding code.

```diff
-
+<?php
+
+namespace A {}
```

```diff
<?php

-
 namespace A{}
```

--------------------------------

### PHP: PHPDoc Indentation Normalization

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

Ensures that PHPDoc blocks in PHP have the same indentation level as the code element they document. This maintains consistent formatting for documentation.

```php
<?php
 class DocBlocks
 {
-/**
- * Test constants
- */
+    /**
+     * Test constants
+     */
     const INDENT = 1;
 }
```

--------------------------------

### Configure Concatenation Spacing in PHP

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

Sets the spacing around concatenation operators (`.`) in PHP strings. The configuration can enforce one space or no spaces, ensuring consistency.

```php
[
  'spacing' => 'one',
]
```

--------------------------------

### PHP Blank Line Before Statement Fix

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

Adds an empty line before specific configured statements like `continue` and `return`. This enhances the readability of control flow within code blocks.

```diff
foreach ($foo as $bar) {
     if ($bar->isTired()) {
         $bar->sleep();
+
         continue;
     }
 }
```

```diff
if (true) {
     $foo = $bar;
+
     return;
 }
```

--------------------------------

### Correct Casing for PHP Magic Methods

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

This rule enforces the correct lowercase casing for magic method definitions and calls in PHP, such as '__sleep()' and '__invoke()'.

```php
<?php
 class Foo
 {
-    public function __Sleep()
+    public function __sleep()
     {
     }
 }

```

```php
<?php
-$foo->__INVOKE(1);
+$foo->__invoke(1);

```

--------------------------------

### Configure Forbidden Functions

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

Defines a list of forbidden functions, including `compact`, `dd`, `dump`, `var_dump`, and `ray`, to enforce cleaner and more controlled debugging practices.

```xml
<properties>
    <property name="forbiddenFunctions" type="array">
        <element key="compact" value="null"/>
        <element key="dd" value="null"/>
        <element key="dump" value="null"/>
        <element key="var_dump" value="null"/>
        <element key="ray" value="null"/>
    </property>
</properties>
```

--------------------------------

### No spaces after function/method name in calls

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

This rule mandates that there should be no space between a function or method name and its opening parenthesis `(` when making a call. This is a common convention for function calls.

```php
<?php
-require ('sample.php');
-echo (test (3));
-exit  (1);
-$func ();
+require('sample.php');
+echo(test(3));
+exit(1);
+$func();

```

--------------------------------

### Configure Constant Casing in PHP

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

Enforces the correct casing for PHP's built-in constants `true`, `false`, and `null`. The configuration specifies the desired case, typically lower or upper.

```php
[
  'case' => 'lower',
]
```

--------------------------------

### Function type hint spacing

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

Enforces a single space between a function's argument and its type hint. This improves the readability of function signatures, especially when type hinting is used.

```php
<?php
-function sample(array$a)
+function sample(array $a)
 {}
```

```php
<?php
-function sample(array  $a)
+function sample(array $a)
 {}
```

--------------------------------

### Remove @access annotation from PHPDoc

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

This rule enforces the omission of the @access annotation from PHPDoc blocks, promoting cleaner documentation. It is demonstrated with a PHP class example.

```php
class Foo
 {
     /**
      * @internal
-     * @access private
      */
     private $bar;
 }

```

--------------------------------

### PHP Blank Line After Namespace Fix

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

Requires exactly one blank line after a namespace declaration in PHP files. This improves the visual separation between the namespace and the subsequent code.

```diff
<?php
 namespace Sample\Sample;

- 
 $a;
```

```diff
<?php
 namespace Sample\Sample;
+
 Class Test{}
```

--------------------------------

### Prefer Array Parameters for View Data in PHP

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

This formatter suggests using an array for view parameters instead of the `->with()` method. It aims to simplify view data passing in Laravel applications.

```php
<?php

namespace App;

class Controller
{
    function index()
    {
-        return view('test.view')->with('testing', '1212');
+        return view('test.view', ['testing' => '1212']);
    }
}
```

--------------------------------

### PHP: Remove Unused Imports

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

Removes `use` statements that are not actually used in the PHP file. This helps to keep the import section clean and reduces potential confusion.

```php
<?php
 use \DateTime;
-use \Exception;

 new DateTime();
```

--------------------------------

### Opening tag line ending

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

Ensures that there is no code on the same line as the opening PHP tag `<?php`. This promotes cleaner code structure and avoids potential parsing issues.

```php
-<?php $a = 1;
+<?php
+$a = 1;
 $b = 3;
```

--------------------------------

### Import Facades Using Full Namespace in PHP

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

This formatter enforces the use of fully qualified namespaces for facades. It replaces shorter, imported facade names with their complete namespace paths, improving code clarity and reducing potential naming conflicts.

```php
<?php

namespace Test;

-use DB;
-use Storage;
+use Illuminate\Support\Facades\DB;
+use Illuminate\Support\Facades\Storage;

```

--------------------------------

### Remove @package and @subpackage annotations from PHPDoc

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

This rule ensures that @package and @subpackage annotations are removed from PHPDoc blocks, simplifying documentation structure. The example shows a PHP class.

```php
<?php
 /**
  * @internal
- * @package Foo
- * subpackage Bar
  */
 class Baz
 {
}

```

--------------------------------

### Control Braces Usage with 'new' Keyword in PHP

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

This rule governs the use of braces after the 'new' keyword. It can be configured to enforce or forbid braces for both named and anonymous classes.

```php
<?php

-$y = new class() {};
+$y = new class {};

```

```php
<?php

-$x = new X();
+$x = new X;

```

--------------------------------

### Configure Class Definition Whitespace in PHP

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

Enforces consistent whitespace around keywords in class, trait, enum, and interface definitions. It can format multi-line extends and implements clauses.

```php
[
  'multi_line_extends_each_single_line' => true,
  'single_item_single_line' => true,
  'single_line' => true,
]
```

--------------------------------

### Fix Switch Case Spacing

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

Standardizes spacing around switch case statements. This rule ensures consistent formatting for 'case' and 'default' keywords within switch blocks.

```php
<?php
     switch($a) {
        case 1:
            break;
        default:
            return 2;
     }

```

--------------------------------

### Remove Doc Blocks from Migration up() and down() Methods in PHP

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

This formatter removes unnecessary doc block comments from the `up()` and `down()` methods in Laravel migrations. It streamlines migration files by eliminating redundant documentation.

```php
<?php

use Illuminate\Support\Facades\Schema;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Database\Migrations\Migration;

class CreateBuyRequestsTable extends Migration
{
-    /**
-     * Run the migrations.
-     *
-     * @return void
-     */
    public function up()
    {
        //
    }

-    /**
-     * Reverse the migrations.
-     *
-     * @return void
-     */
    public function down()
    {
        //
    }
}

```

--------------------------------

### Standardize Type Hint Spaces

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

Enforces a single space or no space around union and intersection type operators in type hints. This rule applies to catch clauses and function parameters.

```php
try
 {
     new Foo();
} catch (ErrorA | ErrorB $e) {
 echo'error';}

```

```php
try
 {
     new Foo();
} catch (ErrorA|ErrorB $e) {
 echo'error';}

```

```php
<?php
function foo(int | string $x)
 {
 }

```

```php
<?php
function foo(int|string $x)
 {
 }

```

--------------------------------

### Line ending consistency

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

Ensures that all PHP files use the same line ending convention (e.g., LF or CRLF). Consistent line endings are important for cross-platform compatibility and version control.

```php

```

--------------------------------

### PHP Binary Operator Spacing Fix

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

Ensures binary operators in PHP are surrounded by a single space, as configured. This standardizes spacing around operators like `+`, `-`, `*`, `/`, etc.

```diff
<?php
-$a= 1  + $b^ $d !==  $e or   $f;
+$a = 1 + $b ^ $d !== $e or $f;
```

--------------------------------

### Duster CLI: GitHub Actions Setup

Source: https://context7.com/tighten/duster/llms.txt

Generates a GitHub Actions workflow file for automated linting or fixing in your CI/CD pipeline. This command interactively prompts for the primary branch name and the desired workflow type (lint only, fix and commit, or fix and update blame ignore).

```bash
# Interactive setup for GitHub Actions
./vendor/bin/duster github-actions
```

--------------------------------

### Heredoc to Nowdoc conversion

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

Converts Heredoc syntax to Nowdoc syntax when the content does not contain variables or escape sequences. This simplifies string literals that are intended to be treated as raw text.

```php
<?php

-$a = <<<"TEST"
+$a = <<<'TEST'
 Foo
 TEST;
```

--------------------------------

### Remove Leading Slashes from Route Paths in PHP

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

This formatter removes leading slashes from route paths defined in Laravel. It enforces a consistent convention where route paths do not start with a forward slash.

```php
<?php

-Route::get('/home', function () {
+Route::get('home', function () {
    return '';
});

```

--------------------------------

### Remove useless @inheritdoc from PHPDoc

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

This rule removes the @inheritdoc tag from PHPDoc blocks when the class does not inherit from another class, preventing unnecessary documentation. Examples are provided for both class and method contexts in PHP.

```php
<?php
-/** {@inheritdoc} */
+/** */
 class Sample
 {
 }

```

```php
class Sample
 {
     /**
-     * @inheritdoc
+     *
      */
     public function Test()
     {
}

```

--------------------------------

### Remove binary string prefix

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

This rule prohibits the use of the binary string prefix `b''` or `b''`. It ensures that strings are declared using standard quoting mechanisms.

```php
-<?php $a = b'foo';
+<?php $a = 'foo';

```

```php
-<?php $a = b<<<EOT
+<?php $a = <<<EOT
 foo
 EOT;

```

--------------------------------

### View Duster Commands

Source: https://github.com/tighten/duster/blob/3.x/README.md

Displays a list of all available commands and options provided by the Duster tool.

```bash
./vendor/bin/duster
```

```bash
./vendor/bin/duster commands
```

--------------------------------

### One class element per statement (PHP)

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

Enforces that each property or constant declaration in a class must be on its own statement. This rule applies to 'const' and 'property' elements and improves code clarity.

```php
[
  'elements' => [
    0 => 'const',
    1 => 'property',
  ],
]
```

```diff
<?php
 final class Example
 {
-    const FOO_1 = 1, FOO_2 = 2;
-    private static $bar1 = array(1,2,3), $bar2 = [1,2,3];
+    const FOO_1 = 1;
+    const FOO_2 = 2;
+    private static $bar1 = array(1,2,3);
+    private static $bar2 = [1,2,3];
 }
```

--------------------------------

### Configure Class Attribute Separation in PHP

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

Controls the separation between elements within a class, trait, or interface definition. It allows specifying the number of blank lines between methods, properties, etc.

```php
[
  'elements' => [
    'method' => 'one',
  ],
]
```

--------------------------------

### Remove name from @var and @type annotations for class properties

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

This rule enforces that @var and @type annotations for class properties should not include the property name. Examples are provided for PHP class properties using both @var and @type.

```php
final class Foo
 {
     /**
-     * @var int $bar
+     * @var int
      */
     public $bar;

     /**
-     * @type $baz float
+     * @type float
      */
     public $baz;
 }

```

--------------------------------

### Enforce Visibility Declaration

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

Mandates that all properties and methods must have explicit visibility declared (public, protected, private). Abstract and final declarations must precede visibility, while static must follow it.

```php
<?php
 class Sample
 {
    public $a;
    protected static $var_foo2;

    public function A()
     {
     }
 }

```

--------------------------------

### Single line after imports block (PHP)

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

Mandates that each namespace use statement must be on its own line, and there must be exactly one blank line following the entire block of use statements. This enhances the separation between imports and the rest of the code.

```diff
namespace Foo;

 use Bar;
 use Baz;
+
 final class Example
 {
 }

```

```diff
namespace Foo;
 use Bar;
 use Baz;

-
 final class Example
 {
 }

```

--------------------------------

### Force PHPDoc tags to be regular or inline

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

This rule enforces a specific format for PHPDoc tags, allowing them to be either regular annotations or inline. The configuration specifies that '@inheritdoc' should be inline. The example shows the transformation in a PHP docblock.

```php
<?php
 /**
- * @inheritdoc
+ * {@inheritdoc}
  */

```

--------------------------------

### Proper spacing for single-line @var in PHPDoc

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

Ensures correct spacing within single-line @var annotations in PHPDoc. The example shows a diff where the spacing around the type and variable name is corrected in a PHP code snippet.

```php
-<?php /**@var   MyClass   $a   */
+<?php /** @var MyClass $a */
 $a = test();

```

--------------------------------

### Global namespace import and qualification

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

Configures the import and full qualification of global classes, functions, and constants. This rule helps manage dependencies and avoid naming conflicts by explicitly importing or using fully qualified names.

```php
<?php

 namespace Foo;
+use DateTimeImmutable;
+use function count;
+use const M_PI;

-if (\count($x)) {
-    /** @var \DateTimeImmutable $d */
-    $d = new \DateTimeImmutable();
-    $p = \M_PI;
+if (count($x)) {
+    /** @var DateTimeImmutable $d */
+    $d = new DateTimeImmutable();
+    $p = M_PI;
 }
```

--------------------------------

### Add or remove @test annotation for PHPUnit tests

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

This rule adds or removes @test annotations from PHPUnit test methods based on the configured style. The example shows adding the @test annotation to a test method in a PHP class.

```php
<?php
 class Test extends \PhpUnit\FrameWork\TestCase
 {
-public function testItDoesSomething() {}
+/**
+ * @test
+ */
+public function itDoesSomething() {}
}

```

--------------------------------

### Shorten scalar type casts (PHP)

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

Converts longer scalar type cast names to their shorter equivalents. For example, '(boolean)' becomes '(bool)', '(integer)' becomes '(int)', '(double)' and '(real)' become '(float)', and '(binary)' becomes '(string)'.

```diff
<?php
-$a = (boolean) $b;
-$a = (integer) $b;
-$a = (double) $b;
-$a = (real) $b;
+$a = (bool) $b;
+$a = (int) $b;
+$a = (float) $b;
+$a = (float) $b;

-$a = (binary) $b;
+$a = (string) $b;
```

```diff
<?php
-$a = (boolean) $b;
-$a = (integer) $b;
-$a = (double) $b;
+$a = (bool) $b;
+$a = (int) $b;
+$a = (float) $b;

-$a = (binary) $b;
+$a = (string) $b;
```

--------------------------------

### Duster Tool Execution Order

Source: https://github.com/tighten/duster/blob/3.x/README.md

Demonstrates how to specify a custom order or selection of tools to be executed by Duster using the `--using` flag.

```bash
./vendor/bin/duster lint --using="phpstan,tlint,pint"
```

--------------------------------

### PHPDoc summary must end with punctuation

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

This rule mandates that the summary line of a PHPDoc block must end with a full stop, exclamation mark, or question mark. The example demonstrates adding a period to a PHP function's docblock summary.

```php
<?php
 /**
- * Foo function is great
+ * Foo function is great.
  */
 function foo () {}

```

--------------------------------

### TLint Configuration

Source: https://context7.com/tighten/duster/llms.txt

Configure TLint rules by creating a `tlint.json` file in your project root. This file allows you to specify presets, disable specific rules, and exclude directories from linting.

```json
{
    "preset": "Tighten",
    "disabled": [
        "NoDocBlocksForMigrationUpDown"
    ],
    "excluded": [
        "tests/Fixtures"
    ]
}
```

--------------------------------

### Use '//' for single-line comments (PHP)

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

Enforces the use of '//' for single-line comments and multi-line comments containing only one line of content. It specifically targets the 'hash' comment style, converting it to the '//' syntax for consistency.

```php
[
  'comment_types' => [
    0 => 'hash',
  ],
]
```

```diff
<?php # comment
+<?php // comment
```

--------------------------------

### GitHub Actions: Duster Lint and Fix Workflows

Source: https://context7.com/tighten/duster/llms.txt

This snippet demonstrates two GitHub Actions workflows: one for linting code with Duster and another for automatically fixing code style issues. It utilizes the `tighten/duster-action` and `stefanzweifel/git-auto-commit-action` for seamless integration.

```yaml
name: Code Style

on:
  push:
    branches: [main, develop]
  pull_request:

jobs:
  duster-lint:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: "Duster Lint"
        uses: tighten/duster-action@v3
        with:
          args: lint

  duster-fix:
    runs-on: ubuntu-latest
    permissions:
      contents: write
    steps:
      - uses: actions/checkout@v4
        with:
          ref: ${{ github.event.pull_request.head.ref }}
      - name: "Duster Fix"
        uses: tighten/duster-action@v3
        with:
          args: fix
      - uses: stefanzweifel/git-auto-commit-action@v5
        with:
          commit_message: "style: Apply code style fixes"
```

--------------------------------

### Use consistent echo or print construct

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

This rule enforces the consistent use of either the `echo` or `print` language construct throughout the codebase, based on configuration. This improves uniformity in output operations.

```php
-<?php print 'example';
+<?php echo 'example';

```

--------------------------------

### Custom Ordered Class Elements Configuration

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

Specifies a custom order for general class elements, including traits, properties, constants, constructor, methods, and magic methods, to maintain code consistency.

```php
[
  'order' => [
    'use_trait',
    'property_public_static',
    'property_protected_static',
    'property_private_static',
    'constant_public',
    'constant_protected',
    'constant_private',
    'property_public',
    'property_protected',
    'property_private',
    'construct',
    'method:__invoke',
    'method_public_static',
    'method_protected_static',
    'method_private_static',
    'method_public',
    'method_protected',
    'method_private',
    'magic',
  ],
]
```

--------------------------------

### Update Dependencies with Composer

Source: https://github.com/tighten/duster/blob/3.x/CONTRIBUTING.md

Updates project dependencies to their latest versions using Composer. Includes commands for both production and development environments.

```bash
# Production
composer require friendsofphp/php-cs-fixer laravel-zero/framework laravel/pint squizlabs/php_codesniffer tightenco/tlint --dev

# Development
COMPOSER=composer-dev.json composer require friendsofphp/php-cs-fixer laravel-zero/framework laravel/pint squizlabs/php_codesniffer tightenco/tlint  --dev
```

--------------------------------

### Running Custom Scripts with Duster

Source: https://context7.com/tighten/duster/llms.txt

Execute custom scripts defined in `duster.json` using the `lint` or `fix` commands. You can run all scripts, specific scripts using the `--using` flag, or combine built-in tools with custom scripts.

```bash
# Runs tlint, phpcs, php-cs-fixer, pint, AND phpstan, pest
./vendor/bin/duster lint

# Run only specific custom script
./vendor/bin/duster lint --using="phpstan"

# Combine built-in tools with custom scripts
./vendor/bin/duster lint --using="pint,phpstan"
```

--------------------------------

### Whitespace After Comma in Array

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

Requires a whitespace character after each comma within array declarations. This ensures consistent formatting for array elements.

```php
<?php
$sample = array(1, 'a', $b, );

```

--------------------------------

### Standardize not equals operator (PHP)

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

Replaces all occurrences of the `<>` inequality operator with the `!=` operator. This standardizes the inequality comparison syntax across the codebase.

```diff
<?php
-$a = $b <> $c;
+$a = $b != $c;
```

--------------------------------

### Configure Brace Placement in PHP

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

Defines the placement of opening braces for control structures, functions, anonymous functions, classes, and anonymous classes. It also includes settings for single-line anonymous classes and functions.

```php
[ 
  'control_structures_opening_brace' => 'same_line',
  'functions_opening_brace' => 'next_line_unless_newline_at_signature_end',
  'anonymous_functions_opening_brace' => 'same_line',
  'classes_opening_brace' => 'next_line_unless_newline_at_signature_end',
  'anonymous_classes_opening_brace' => 'next_line_unless_newline_at_signature_end',
  'allow_single_line_empty_anonymous_classes' => true,
  'allow_single_line_anonymous_functions' => false,
]
```

--------------------------------

### Pint Configuration

Source: https://context7.com/tighten/duster/llms.txt

Customize Laravel Pint formatting rules by creating a `pint.json` file. You can set the preset, define specific rules for code style, and specify files or directories to exclude from formatting.

```json
{
    "preset": "laravel",
    "rules": {
        "blank_line_between_import_groups": true,
        "concat_space": {
            "spacing": "one"
        },
        "ordered_imports": {
            "sort_algorithm": "alpha",
            "imports_order": ["const", "class", "function"]
        },
        "php_unit_test_annotation": {
            "style": "annotation"
        },
        "global_namespace_import": {
            "import_classes": true,
            "import_constants": true,
            "import_functions": true
        }
    },
    "exclude": [
        "tests/Fixtures"
    ]
}
```

--------------------------------

### Duster CLI: Lint Commands

Source: https://context7.com/tighten/duster/llms.txt

Analyzes your codebase for style violations without modifying files. Supports linting all files, dirty files, files changed since a specific branch, specific paths, and using only selected tools. Available tools include tlint, phpcs, php-cs-fixer, and pint.

```bash
# Lint all files in the project
./vendor/bin/duster lint

# Lint only files with uncommitted Git changes
./vendor/bin/duster lint --dirty

# Lint only files changed since branching from main
./vendor/bin/duster lint --diff=main

# Lint specific paths
./vendor/bin/duster lint app/Http/Controllers app/Models

# Lint using only specific tools (comma-separated)
./vendor/bin/duster lint --using="tlint,pint"
```

--------------------------------

### PHPDoc tag renaming

Source: https://github.com/tighten/duster/blob/3.x/style-guide.md

Renames specific PHPDoc tags to their preferred or standardized equivalents. This ensures consistency in documentation comments across the project.

```php
<?php
 /**
- * @inheritDocs
- * {@inheritdocs}
+ * @inheritDoc
+ * {@inheritDoc}
  */
```

```php
<?php
 /**
  * @inheritDocs
- * {@inheritdocs}
+ * {@inheritDoc}
  */
```

```php
<?php
 /**
- * @inheritDocs
+ * @inheritDoc
  * {@inheritdocs}
  */
```

```php
<?php
 /**
- * @inheritDocs
+ * @inheritDoc
  * {@inheritdocs}
  */
```