Laravel のプロジェクトディレクトリで実行することで Faker のチートシートを作成する.

create_faker_cheat_sheet.sh

#!/bin/sh

###                             ###
### Create a Faker Cheat Sheet. ###
###                             ###

function extract_methods() {
    while read line; do
        if [[ $line =~ ^\*[[:space:]]@example[[:space:]](.*) ]]; then
            example=${BASH_REMATCH[1]}
        fi

        if [[ $line =~ ^\*[[:space:]]@return[[:space:]](.*) ]]; then
            type=${BASH_REMATCH[1]}
        fi

        if [[ $line =~ ^\*[[:space:]](Return.*|Generate.*) ]]; then
            description=${BASH_REMATCH[1]}
        fi

        if [[ $line =~ ^public.*function[[:space:]](.*) ]]; then
            method=${BASH_REMATCH[1]}

            if [[ $method != *"__construct"* ]]; then
                echo "| \`$method\` | \`$type\` | \`$example\` | $description |" >> $markdown
            fi

            example=''
            type=''
            method=''
            description=''
        fi
    done < $1
}

markdown="faker_cheat_sheet.md"
echo "# Faker Cheat Sheet" > $markdown

for entry in vendor/fakerphp/faker/src/Faker/Provider/*.php; do
    filename=$(basename "$entry" .php)
    echo "Reading $filename..."

    echo "" >> $markdown
    echo "" >> $markdown
    echo "## Provider/$filename.php" >> $markdown
    echo "" >> $markdown
    echo "| Method | Type | Example | Description |" >> $markdown
    echo "|:--|:--|:--|:--|" >> $markdown

    extract_methods $entry
done

for entry in vendor/fakerphp/faker/src/Faker/Provider/ja_JP/*.php; do
    filename=$(basename "$entry" .php)
    echo "Reading $filename..."

    echo "" >> $markdown
    echo "" >> $markdown
    echo "## Provider/ja_JP/$filename.php" >> $markdown
    echo "" >> $markdown
    echo "| Method | Type | Example | Description |" >> $markdown
    echo "|:--|:--|:--|:--|" >> $markdown

    extract_methods $entry
done