Refactoring support for the LiveCode Script Editor
Brings refactoring support to the LiveCode Script Editor.
Place the plugin into your user Plugins folder.
After launching the script editor there will be a new Refactoring menuItem in the Edit menu.
The Refactoring menuItem will also appear in the contextual menu of the Script Editor.
The Refactoring menu is inspired by the JetBrains refactoring support in RubyMine, etc.
If you just want to download the Plugin itself, it's now in the "Plugin" folder. You don't need all the script files unless you want to submit pull requests.
Allows you to rename in just the current script or all scripts in the stack.
If you are renaming or changing the signature of a handler in a script and want to effect this operation across all scripts in the same stack, calls to that handler will be renamed/modified unless there is a handler of the same name in that script, in which case you will be notified that the script will not be changed.
Both Rename Handler and Rename Variable change all uses of the object.
Creates a constant for the selected literal value.
For instance, converts the string literal "hello" to
constant kHello = "hello"
and changes all references of "hello" to use kHello, i.e.,
put kHello into tVariable
instead of
put "hello" into tVariable
Change the parameter list for a command or function. For instance, change "myCommand pKey" to "myCommand pKey, pValue" Modifying parameters will modify calls to the handler in all scripts in the stack.
If you are renaming or changing the signature of a handler in a script and want to effect this operation across all scripts in the same stack, calls to that handler will be renamed/modified unless there is a handler of the same name in that script, in which case you will be notified that the script will not be changed.
Only deletes the handler/variable if nothing is using it. Otherwise you get a warning specifying where it's used.
These allow you to select a new home for the selected handler.
Allow external access to a script local variable. The handlers will be named after the variable name:
local ArrayName
becomes
command setArrayNameTo pValue
and
function ArrayName()
Creates documentation for a handler in the form
/**
* HandlerName
* parameters
* Returns (if a function)
* returnValues
*/
The documentation format is stored as a custom property template and can be modified if desired.
Adds a template unit test for the selected handler to a file in the same folder as the stack. The file has the same name as the stack with the ".tests" extension. The tests file is intended to be run using Ah, Software's TestRunner unit testing stack. The unit test format is stored as a custom property template. Modifying it will probably cause it to cease functioning.
- Script Local
- Getter and Setter
- Property
- Script Local
- Parameter
- Property
Creates a new handler from the selected block of code in the current script.
Displays a list of unused local variables, unused parameters, uncalled handlers, duplicate handlers, possibly leftover breakpoints and put statements with no destination container. If you do not have strict compilation mode set it will also find undeclared variables to help in debugging. Select a list item to select it in the script editor. You can use the checkboxes to filter the displayed list by type.
There's a full undo first-in-last-out stack mechanism for those oops moments. Issues a warning if you attempt to undo changes already saved to disk.
Not strictly part of a refactoring process, but since I was reworking the Edit menu anyway... After a "Go to definition" call, this gets you back to where you were.
An attempt at getting Cyclomatic Code Complexity scores for LiveCode scripts. Still a Work In Progress, so don't take it too seriously. For reference: https://en.wikipedia.org/wiki/Cyclomatic_complexity