diff mbox series

formatting_script: Add formatting script

Message ID 20220302184255.35984-1-ohilyard@iol.unh.edu (mailing list archive)
State Accepted
Headers show
Series formatting_script: Add formatting script | expand

Checks

Context Check Description
ci/Intel-dts-suite-test warning SKIPPED

Commit Message

Owen Hilyard March 2, 2022, 6:42 p.m. UTC
From: Owen Hilyard <ohilyard@iol.unh.edu>

Added a formatting script to run black an isort with. By default, it
will run in the current working directory. If $1 is specified and not
either "-h" or "--help", it will run in that directory instead. This
does not allow checking for a git diff after formatting (for rejecting
patches in CI), but that should be fairly easy to implement in a wrapper
script.

Signed-off-by: Owen Hilyard <ohilyard@iol.unh.edu>
---
 format.sh | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)
 create mode 100755 format.sh

Comments

Owen Hilyard March 2, 2022, 6:52 p.m. UTC | #1
Sorry for the double reply. The mailing list notified me that the file was
too large, so here's an xzipped version.
Tu, Lijuan March 16, 2022, 6:29 a.m. UTC | #2
Applied, thanks

> -----Original Message-----
> From: ohilyard@iol.unh.edu <ohilyard@iol.unh.edu>
> Sent: 2022年3月3日 2:43
> To: dts@dpdk.org
> Cc: Tu, Lijuan <lijuan.tu@intel.com>; Owen Hilyard <ohilyard@iol.unh.edu>
> Subject: [PATCH] formatting_script: Add formatting script
> 
> From: Owen Hilyard <ohilyard@iol.unh.edu>
> 
> Added a formatting script to run black an isort with. By default, it will run in the
> current working directory. If $1 is specified and not either "-h" or "--help", it will
> run in that directory instead. This does not allow checking for a git diff after
> formatting (for rejecting patches in CI), but that should be fairly easy to
> implement in a wrapper script.
> 
> Signed-off-by: Owen Hilyard <ohilyard@iol.unh.edu>
> ---
>  format.sh | 35 +++++++++++++++++++++++++++++++++++
>  1 file changed, 35 insertions(+)
>  create mode 100755 format.sh
> 
> diff --git a/format.sh b/format.sh
> new file mode 100755
> index 00000000..d35c0bf1
> --- /dev/null
> +++ b/format.sh
> @@ -0,0 +1,35 @@
> +#!/usr/bin/env bash
> +
> +function main() {
> +    # The directory to work on is either passed in as argument 1,
> +    # or is the current working directory
> +    DIRECTORY=${1:-`pwd`}
> +    LINE_LENGTH=88
> +
> +    isort \
> +      --overwrite-in-place \
> +      --profile black \
> +      -j `nproc` \
> +      --line-length $LINE_LENGTH \
> +      --python-version auto \
> +      $DIRECTORY
> +
> +    black \
> +      --line-length $LINE_LENGTH \
> +      --required-version 22.1.0 \
> +      --target-version py38 \
> +      --safe \
> +      $DIRECTORY
> +}
> +
> +function help() {
> +  echo "usage: format.sh <directory>"
> +}
> +
> +if [ "$1" == "-h" ] || [ "$1" == "--help" ]; then
> +  help
> +  exit 0
> +fi
> +
> +main "$1"
> +
> --
> 2.30.2
diff mbox series

Patch

diff --git a/format.sh b/format.sh
new file mode 100755
index 00000000..d35c0bf1
--- /dev/null
+++ b/format.sh
@@ -0,0 +1,35 @@ 
+#!/usr/bin/env bash
+
+function main() {
+    # The directory to work on is either passed in as argument 1,
+    # or is the current working directory
+    DIRECTORY=${1:-`pwd`}
+    LINE_LENGTH=88
+
+    isort \
+      --overwrite-in-place \
+      --profile black \
+      -j `nproc` \
+      --line-length $LINE_LENGTH \
+      --python-version auto \
+      $DIRECTORY
+
+    black \
+      --line-length $LINE_LENGTH \
+      --required-version 22.1.0 \
+      --target-version py38 \
+      --safe \
+      $DIRECTORY
+}
+
+function help() {
+  echo "usage: format.sh <directory>"
+}
+
+if [ "$1" == "-h" ] || [ "$1" == "--help" ]; then
+  help
+  exit 0
+fi
+
+main "$1"
+