Skip to content
Snippets Groups Projects
ensure-deps.sh 1.18 KiB
Newer Older
#!/usr/bin/env bash

# The script is meant to check if the rules regarding packages
# dependencies are satisfied.
# The general format is:
# [top-lvl-dir]<[crate-name-prefix]

# For instance no crate within `./client` directory
# is allowed to import any crate with a directory path containing `paint`.
# Such rule is just: `client<paint`.

# The script should be run from the main repo directory!

set -u

PLEASE_DONT=(
	"client<paint"
	"client<node"
	"paint<node"
	"paint<client"
	"primitives<paint"
	"primitives<client"
)

VIOLATIONS=()
PACKAGES=()

for rule in "${PLEASE_DONT[@]}"
do
	from=$(echo $rule | cut -f1 -d\<)
	to=$(echo $rule | cut -f2 -d\<)

	cd $from
	echo "Checking rule $rule"
	packages=$(find -name Cargo.toml | xargs grep -wn "path.*$to")
	has_references=$(echo -n $packages | wc -c)
	if [ "$has_references" != "0" ]; then
		VIOLATIONS+=("$rule")
		# Find packages that violate:
		PACKAGES+=("$packages")
	fi
	cd - > /dev/null
done

# Display violations and fail
I=0
for v in "${VIOLATIONS[@]}"
do
	cat << EOF

===========================================
======= Violation of rule: $v
===========================================
${PACKAGES[$I]}


EOF
	I=$I+1
done

exit ${#VIOLATIONS[@]}