This add-on provides enhancements for add-on developers.
exclude\_files
and exclude\_directories
respectively via build.json
from add-on archiveREADME.md
...
BEFORE_TITLE
AFTER_TITLE
BEFORE_DESCRIPTION
AFTER_DESCRIPTION
BEFORE_REQUIREMENTS
AFTER_REQUIREMENTS
BEFORE_RECOMMENDATIONS
AFTER_RECOMMENDATIONS
BEFORE_OPTIONS
AFTER_OPTIONS
BEFORE_PERMISSIONS
AFTER_PERMISSIONS
BEFORE_ADMIN_PERMISSIONS
AFTER_ADMIN_PERMISSIONS
BEFORE_BB_CODES
AFTER_BB_CODES
BEFORE_BB_CODE_MEDIA_SITES
AFTER_BB_CODE_MEDIA_SITES
BEFORE_STYLE_PROPERTIES
AFTER_STYLE_PROPERTIES
BEFORE_ADVERTISING_POSITIONS
AFTER_ADVERTISING_POSITIONS
BEFORE_WIDGET_POSITIONS
AFTER_WIDGET_POSITIONS
BEFORE_WIDGET_DEFINITIONS
AFTER_WIDGET_DEFINITIONS
BEFORE_CRON_ENTRIES
AFTER_CRON_ENTRIES
BEFORE_REST_API_SCOPES
AFTER_REST_API_SCOPES
BEFORE_CLI_COMMANDS
AFTER_CLI_COMMANDS
README
variants will be created:
_dev/resource_description.txt
for resource descriptionsREADME.md
for any VCS repositoryName | Description |
---|---|
Disable hash checking | For development purposes disabling XF's hash check is required to hotpatch code |
Disable XF Template watching | XF's template watching causes a large amount of IO per page, and doesn't touch phrases to template modification. Disable for a boost in performance if it isn't required. |
Use full width for admin control panel | If checked, admin control panel will have fluid width instead of fixed width. |
Command | Description |
---|---|
tck-devtools:generate-schema-addon |
Generates schema codes from add-on. |
tck-devtools:create-class-extension |
Creates an XF class-extension for an add-on and writes out a basic template file. |
tck-devtools:build-readme |
Builds README files for provided add-on. |
tck-devtools:clamp-versions |
Ensures an add-on does not have phrases or templates with version id's above the addon.json file. |
tck-devtools:generate-schema-entity |
Generates schema code from an entity |
tck-devtools:finder-class-properties |
Applies class properties to type hint relations. |
tck-devtools:better-export |
Exports the XML files for an add-on and applies class properties to type hint columns, getters and relations |
tck-devtools:create-entity-from-table |
Creates an XF entity for an add-on from a table. |
tck-devtools:add-phrase |
Creates a phrase for an add-on. |
tck-devtools:entity-class-properties |
Applies class properties to type hint columns, relations and getters |
There are some wrapper scripts under scripts
directory provided by Xon which can be helpful.
This project is licensed under the MIT License - see the LICENSE.md file for details.