Skip to content

README.md

Latest commit

 

History

History
19 lines (19 loc) · 1.08 KB

README.md

File metadata and controls

19 lines (19 loc) · 1.08 KB

PiranhaGo

PiranhaGo is runnable now. Instructions:-

  1. To build the package run go build -o piranha. Dependencies will install automatically and they are given in go.mod file.
  2. Below are the instructions for running for the single file.
Inputs from args
Usage: ./piranha [-h] -p PROPERTIES -s SOURCE_FILE -f STALE_FLAG -mode MODE_NAME [-o OUTPUT]
Required arguments:
		-s SOURCE_FILE: Path of the file to be refactored.
		-p PROPERTIES: Configuration file (json format) for Piranha.
		-f STALE_FLAG: Name of the stale flag.
		-mode MODE_NAME: If MODE_NAME=treated, then flag is treated,
			otherwise MODE_NAME=control, it is control.
Optional arguments:
		-h: Show the options and exit.
		-o OUTPUT: Destination of the refactored output from piranha. If -o is not provided, then the source file is updated in place.
  1. To do a test run, run piranha on example/testExample.go. Run ./piranha -p properties.json -s ./example/testExample.go -o ./example/treatedExample.go -f staleFlag -mode control command in root directory. You will get your refactored file as /example/treatedExample.go.