@toolbox-wp/build-block

⚠️ EARLY DEVELOPMENT NOTICE: This project is in active development (v0.1.x) and APIs are subject to change.

Similar to @wordpress/create-block with modern tooling, enhanced TypeScript support, default interactivity api integration, and readily available config files.

Built With

• 

• 

  • libs

    This project is built to generate projects adhering to the modern Block Editor Paradigm

    • Package References

      • Interactivity
      • Blocks
      • Components
      • Element

• 

• 

• 

• 

• 

• 

• 

RoadMap

• Rework Validator Error handling. Current system does not provide meaningful messages and is overly complex. Validation has been relaxed in some areas to accommodate this (e.g. urls are just validated to be strings)
• Extend and improve interactive cli
  • Allow dynamic selection of options to configure to allow full configuration from the cli without a config file.
• Finish Package.json input configuration handling
• Integrate more of the WP Plugin Check rules/recommendations directly
• Document
  • Logo/Banner
  • Installation
  • Examples/Guides
  • Changelog
  • Contributing
  • Table of Content
  • Generated files and structure
  • Features
  • Comments
  • Coverage, Dependencies (dep-cruiser)
• Implement CI/CD pipeline
• Complete testing/coverage (include validation of every input config method)
• Centralize more template data like shared ignore files
• Add optional library installations like validator
• Add and automate PHPUnit testing integration
• Set-up composer to use psr4 auto-loading
• Add and automate Prettier PHP-Plugin set-up/configuration

Features

Flexible configuration

• Interactive CLI: Guides you through setting up a project using the terminal.
• build-block.(json|ts|js)
  • TypeScript/JavaScript modules: TypeScript is recommended for typechecking ensuring no runtime errors when generating. Import the config function or Builder class from the api and export the result.
  • JSON: Use the JSON schema for guidance and validation.

WordPress.org Compatibility

• WordPress.org Ready - Built to pass WordPress Organization guidelines and requirements
  • WordPress Plugin Check compliance
  
• Proper .distignore configuration for clean distribution packages (use the plugin-zip script provided by wp-scripts to remove non-compliant hidden-files)

License

Copyright © 2025 Nolan Gajdascz

Email | GitHub

Distributed under GPLv2+ in compliance with WordPress licensing requirements. See LICENSE for more information.

(back to top)