README

This plugin checks what's inside the files.

Requirements

Supported files

• php
• txt
• stub

Available Expectations

toReturnLowercase

Make sure a file or directory files returns an array with all lowercase values.

expect('file.php')->toReturnLowercase();

toReturnUppercase

Make sure a file or directory files returns an array with all uppercase values.

expect('file.php')->toReturnUppercase();

toReturnUnique

Make sure a file or directory files returns an array with unique values.

expect('file.php')->toReturnUnique();

toReturnSingleWords

Make sure a file or directory files returns an array with single words.

expect('file.php')->toReturnSingleWords();

toBeOrdered

Make sure a file or directory files returns an array with words that are ordered.

expect('file.php')->toBeOrdered();

toReturnStrings

Make sure a file or directory files returns only string values.

expect('file.php')->toReturnStrings();

forbidEmpty

Make sure a file or directory files does not return any empty value.

expect('file.php')->forbidEmpty();

Success

<?php

// lowercase.php

return [
    'lower',
    'case',
    'lowercase',
    'array' => [
        'lower',
        'case',
    ],
];

expect('lowercase.php')->toReturnLowercase();

Failure

<?php

// notlowercase.php

return [
    'lower',
    'caSe',
    'lowercase',
];

expect('notlowercase.php')->toReturnLowercase();

Scan directory

directory
├── file.js
├── file.php
├── subdirectory
    ├── file.json
    ├── file1.php
    ├── file2.php

• To scan all the php files in directory and all its subdirectories (file.php, file1.php and file2.php), we can use:

expect('directory')->toReturnLowercase();

• We can also specify the scan depth using depth.

expect('directory')->toReturnLowercase(depth:0);

In this case it will only scan direct php file which is file.php.