test suite reviews and discussions
 help / color / mirror / Atom feed
From: ohilyard@iol.unh.edu
To: dts@dpdk.org
Cc: lijuan.tu@intel.com, Owen Hilyard <ohilyard@iol.unh.edu>
Subject: [PATCH] formatting_script: Add formatting script
Date: Wed,  2 Mar 2022 13:42:56 -0500	[thread overview]
Message-ID: <20220302184255.35984-1-ohilyard@iol.unh.edu> (raw)

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


             reply	other threads:[~2022-03-02 18:43 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-03-02 18:42 ohilyard [this message]
     [not found] ` <CAHx6DYBRH5p9HCPg3Ogds6usRgT1nrSMXTKaHaODyqCRzKhSRw@mail.gmail.com>
2022-03-02 18:52   ` Owen Hilyard
2022-03-16  6:29 ` Tu, Lijuan

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20220302184255.35984-1-ohilyard@iol.unh.edu \
    --to=ohilyard@iol.unh.edu \
    --cc=dts@dpdk.org \
    --cc=lijuan.tu@intel.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).