Added format script to simplify avoiding .semgrep directory #2946
Conversation
scripts/format.sh
Outdated
| # Build a list of all the top-level directories in the project. | ||
| for DIRECTORY in */ ; do | ||
| GOGLOB="$GOGLOB ${DIRECTORY%/}" | ||
| done | ||
| GOGLOB="${GOGLOB/ docs/}" | ||
| GOGLOB="${GOGLOB/ vendor/}" | ||
|
|
||
| GOFMT_LINES=`gofmt -s -l $GOGLOB | tr '\\\\' '/' | wc -l | xargs` | ||
|
|
||
| if [[ $GOFMT_LINES -ne 0 ]]; then | ||
| FMT_FILES=`gofmt -s -l $GOGLOB | tr '\\\\' '/' | xargs` | ||
| for FILE in $FMT_FILES; do | ||
| echo "Running: gofmt -s -w $FILE" | ||
| `gofmt -s -w $FILE` | ||
| done | ||
| fi |
There was a problem hiding this comment.
How about adding above code in makefile? With this change,
.phoney: format
// code....
- User can run
make formatcommand to rungofmt - Also we can update
validate.shto runmake formatcommand. This will eliminate code duplication between format.sh and validate.sh files
There was a problem hiding this comment.
This is good point! I'll see what I can do
There was a problem hiding this comment.
@onkarvhanumante please see these changes ff28932
I did not put a bash script itself to the Makefile, instead it calls this script from the sh file. I think it looks cleaner and aligns with overall style of the Makefile and validate.sh script. What do you think?
| GOFMT_LINES=`gofmt -s -l $GOGLOB | tr '\\\\' '/' | wc -l | xargs` | ||
|
|
||
| if [[ $GOFMT_LINES -ne 0 ]]; then | ||
| if $AUTOFMT; then |
There was a problem hiding this comment.
$AUTOFMT is currently not defined in format.sh. Script should accept $AUTOFMT as a command-line input. If no value is provided when running the script, $AUTOFMT will default to false. Also should update callers to pass $AUTOFMT value from format.sh callers
There was a problem hiding this comment.
Good catch, fixed!
Resolves #2925