Undebt: Command Line Interface

Install it

$ git clone https://github.com/Yelp/undebt.git
$ cd undebt
$ pip install .

Read it

$ undebt --help
usage: undebt [-h] --pattern MODULE [--verbose] [--dry-run]
              [FILE [FILE...]]

positional arguments:
  FILE [FILE...]
                        paths to files to be modified (if not passed uses

optional arguments:
  -h, --help                  show this help message and exit
  --pattern MODULE, -p MODULE
                              pattern definition modules
  --verbose, -v
  --dry-run, -d               only print to stdout; do not overwrite files

Try it out

$ undebt -p undebt.examples.method_to_function ./tests/inputs/method_to_function_input.txt
$ git diff
diff --git a/tests/inputs/method_to_function_input.txt b/tests/inputs/method_to_function_input.txt
index f268ab9..7681c63 100644
--- a/tests/inputs/method_to_function_input.txt
+++ b/tests/inputs/method_to_function_input.txt
@@ -1,13 +1,14 @@
+from function_lives_here import function
 something before code pattern
 def some_function(self, abc, xyz):
     """herp the derp while also derping and herping"""
     cde = fgh(self.l)
     ijk = cde.herp(
-        opq_foo=FOO(abc).method()
+        opq_foo=function(FOO(abc))
     lmn = cde.herp(
-        opq_foo=FOO(xyz).method()
+        opq_foo=function(FOO(xyz))
 bla bla bla
     for str_data in derp_data['data']['strs']:
@@ -16,8 +17,8 @@ bla bla bla
                 "derp {derp_foo} herp {herp_foo}".format(
-                    derp_foo=FOO(derp_foo).method(),
-                    herp_foo=FOO(herp_foo).method(),
+                    derp_foo=function(FOO(derp_foo)),
+                    herp_foo=function(FOO(herp_foo)),
 something after code pattern

Tips and Tricks

Most of these will make use of xargs

Using with grep/git grep to find files

grep -l <search-text> **/*.css | xargs undebt -p <pattern-module>

# Use git grep if you only want to search tracked files
git grep -l <search-text> | xargs undebt -p <pattern-module>

Using find to limit to a particular extension

find -name '*.js' | xargs grep -l <search-text> | xargs undebt -p <pattern-module>

Using xargs to work in parallel

xargs takes a -P flag, which specifies the maximum number of processes to use.

git grep -l <search-text> | xargs -P <numprocs> undebt -p <pattern-module>