QuarkEditor
Extension
ExtensionDescription
This class provides methods to facilitate easy editing and validation of a Quark file, as well as notifications when fields are changed.
Class Methods
.new
Create a new editor for a quark file.
Arguments:
| path |
Path to a .quark file or directory. |
| create |
Boolean. If true, create a new quark if the specified path doesn't exist. |
Instance Methods
.name
Get/set the "name" field of the quark file.
.dependencies
Get/set the "dependencies" field of the quark file. This field takes/returns a list of strings.
.schelp
Get/set the "schelp" field of the quark file.
.version
Get/set the "version" field of the quark file.
.isCompatible
Get/set the "isCompatible" field of the quark file.
.since
Get/set the "since" field of the quark file.
.summary
Get/set the "summary" field of the quark file.
.test
Get/set the "test" field of the quark file. This should point to an .scd file that runs unit tests for the Quark.
.copyright
Get/set the "copyright" field of the quark file.
.license
Get/set the "license" field of the quark file.
.url
Get/set the "url" field of the quark file.
.author
Get/set the "author" field of the quark file.
.scversion
Get/set the "scversion" field of the quark file.
.save
Save changes to the quark file.
.load
Load data from the quark file. This will destroy any unsaved changes made via the QuarkEditor.
.validate
Validate the Quark file. This will detect possible problems including missing fields, unlisted dependencies, etc. Note that this operation is asynchronous, so the results may not be immediately available in the QuarkValidator that is returned.
Arguments:
| doneAction |
A function to be executed when the validation has finished. The first argument is the QuarkValidator object. |
Returns:
.createHelpFiles
Create template schelp files for any undocumented classes defined in the Quark.
.addDependency
Add a dependency to the list of dependencies.
Arguments:
| dependency |
A string of the form "Dependency" or "Dependency@1.2.3". |