Developer Tools

Developer Tools 1.5.0

No permission to download
Overview Updates (36) Reviews (1) History Discussion
Compatible XF 2.x versions
  1. 2.1
  2. 2.2
  3. 2.3
Additional requirements
PHP: 7.3
XenForo 2.1.7+
Standard Library by Xon v1.20.1+
License
MIT
Visible branding
No

Developer Tools for XenForo 2.1.7+​

Description​

This add-on provides enhancements for add-on developers.

Features​

  • Show display order...
    • Option group
    • Options
    • Permission groups
    • Permission
  • Test template modification against specific style
  • Show breadcrumb for style property group
  • Show template modification type in breadcrumb
  • Show option group when adding option
  • Show execution order for template modifications, class extensions and code event listeners (Since 1.2)
  • Show style property group name and display order (Since 1.4)
  • Show warnings when attempted to check for permissions or permission groups that do not exist (Since 1.2)
  • Allow creating permission via permission interface even if permissions already exist (Since 1.2)
  • Automatically fill out code event listener callback class and method as well creating listener file or adding just the function
  • Exclude files or directories via exclude_files and exclude_directories respectively via build.json from add-on archive
  • Create multiple phrases at once
  • Build add-on archive from ACP
  • View template modifications applied on a specific template
  • Minify JavaScript files locally
  • Lookup what email HTML and plain text was sent (Since 1.3)
  • Ability to use full width in admin control panel to make use entire screen (Since 1.4)
  • Ability to quickly copy-paste template name shown in template error without needing to change the type (Since 1.4)
  • Automatically generate README.md...
    • The following information will be available in README with description whenever possible:
      • Add-on title
      • Add-on description
      • Add-on requirements
      • Options
      • Permissions
      • Admin permissions
      • BB codes
      • BB code media sites
      • Style properties
      • Advertising positions
      • Widget positions
      • Widget definitions
      • Cron entries
      • REST API scopes
      • CLI Commands
    • Further more, you can add your own blocks by creating HTML files named after the hook positions:
      • 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
    • When an add-on is built, following READMEvariants will be created:
      • BB code version at _dev/resource_description.txt for resource descriptions
      • Markdown version at README.md for any VCS repository

Requirements​

  • PHP 7.3.0+
  • PHP's Intl extension
  • PHP's DOM extension
  • PHP's JSON extension
  • Standard Library by Xon v1.20.1+

Options​

Developer Tools (Debug only)​

NameDescription
Disable hash checkingFor development purposes disabling XF's hash check is required to hotpatch code
Disable XF Template watchingXF'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 panelIf checked, admin control panel will have fluid width instead of fixed width.

CLI Commands​

CommandDescription
tck-devtools:generate-schema-addonGenerates schema codes from add-on.
tck-devtools:create-class-extensionCreates an XF class-extension for an add-on and writes out a basic template file.
tck-devtools:build-readmeBuilds README files for provided add-on.
tck-devtools:clamp-versionsEnsures an add-on does not have phrases or templates with version id's above the addon.json file.
tck-devtools:generate-schema-entityGenerates schema code from an entity
tck-devtools:finder-class-propertiesApplies class properties to type hint relations.
tck-devtools:better-exportExports the XML files for an add-on and applies class properties to type hint columns, getters and relations
tck-devtools:create-entity-from-tableCreates an XF entity for an add-on from a table.
tck-devtools:add-phraseCreates a phrase for an add-on.
tck-devtools:entity-class-propertiesApplies class properties to type hint columns, relations and getters

Scripts​

There are some wrapper scripts under scripts directory provided by Xon which can be helpful.

License​

This project is licensed under the MIT License - see the LICENSE.md file for details.
  • Like
  • Love
Reactions: philmckrackon, Andy.N, Old Nick and 30 others
Author
TickTackk
Downloads
309
Views
7,571
First release
Last update

Ratings

5.00 star(s) 1 ratings
Join the discussion More information Get support

More resources from TickTackk

Share this resource

Latest updates

  1. 1.5.0

    New: Add tck-devtools:finder-class-properties command to apply class properties to type hint...

  2. 1.4.3

    Fix: Command tck-dt:entity-class-properties does not set getters and relations make use of...

  3. 1.4.2

    Fix: Command tck-dt:entity-class-properties duplicates class hint for getters (#120)
Read more…

Latest reviews

XFA
Very useful add-ons dedicated to developers and providing several improvements to ease life, a real time saver !
Upvote 4 Downvote
Read more…
Back
Top Bottom