format.sh

#!/usr/bin/env bash
set -x

# Initialize default source directories
default_src="src/zenml tests examples docs/mkdocstrings_helper.py scripts"
# Initialize SRC as an empty string
SRC=""

# Initialize SKIP_YAMLFIX as false
SKIP_YAMLFIX=false

# Process arguments
for arg in "$@"
do
    # Check for the --no-yamlfix flag
    if [ "$arg" = "--no-yamlfix" ]; then
        SKIP_YAMLFIX=true
    else
        # If it's not the flag, treat it as a source directory
        # Append the argument to SRC, separated by space
        if [ -z "$SRC" ]; then
            SRC="$arg"
        else
            SRC="$SRC $arg"
        fi
    fi
done

# If no source directories were provided, use the default
if [ -z "$SRC" ]; then
    SRC="$default_src"
fi

export ZENML_DEBUG=1
export ZENML_ANALYTICS_OPT_IN=false

# autoflake replacement: removes unused imports and variables
ruff check $SRC --select F401,F841 --fix --exclude "__init__.py" --isolated

# sorts imports
ruff check $SRC --select I --fix --ignore D
ruff format $SRC

# standardises / formats CI yaml files
if [ "$SKIP_YAMLFIX" = false ]; then
    yamlfix .github tests --exclude "dependabot.yml"
fi

set +x
# Adds scarf snippet to docs files where it is missing
# Text to be searched in each file
search_text='https://static.scarf.sh/a.png?x-pxid=f0b4f458-0a54-4fcd-aa95-d5ee424815bc'

# Text block to be appended
append_text='<!-- For scarf -->
<figure><img alt="ZenML Scarf" referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=f0b4f458-0a54-4fcd-aa95-d5ee424815bc" /></figure>

'

# Find all .md files in ./docs/book, excluding toc.md
while IFS= read -r file; do
    # Check if the file does not contain the search text
    if ! grep -qF "$search_text" "$file"; then
        echo "Appending scarf to file '$file'."
        # Append the text block and a final blank line
        echo "$append_text" >> "$file"
    fi
done < <(find docs/book -type f -name '*.md' ! -name 'toc.md')

echo "Any needed / missing scarfs have now been added."
set -x