Skip to content

Latest commit

 

History

History
44 lines (31 loc) · 1.2 KB

README.md

File metadata and controls

44 lines (31 loc) · 1.2 KB
Raw

refac

A tool for moving and refactoring python code. It supports moving files or entire directories (refac file). Also supports moving specific symbols inside a file (refac symbol) or specific imports (refac import).

Checks

Quickstart

pip install refac
refac file /path/to/src.py /path/to/dst.py

and add the following to your .libcst.codemod.yaml at the root of your project:

modules:
  - "refac.visitors"
usage:
    refac [file|symbol|import] <src> <dst>

  examples:
    refac file /path/to/src.py /path/to/dst.py
    refac symbol path.to.SrcClass path.to.DstClass
    refac symbol path.to.src_func1,path.to.src_func2 path.to.dst_func1,path.to.dst_func2
    refac import path.to.src_import path.to.dst_import

Contributing

Contributions are welcomed and appreciated. Check out ARCHITECTURE.md for an overview of the codebase.

To run tests:

# Must be using Python >3.9
python -m pip install -r requirements.txt
python -m unittest tests/**/*.py

Please file GitHub issues for any bugs.