acf-block-generator
v1.2.5
Published
A tool to generate ACF block templates with a given block name.
Downloads
9
Maintainers
Readme
ACF Block Generator
This package provides a simple command-line tool to generate the necessary files for an ACF (Advanced Custom Fields) block. It creates a directory with the block's name and populates it with a PHP template, a CSS file, and a JSON configuration file.
Installation
You can install this tool either globally or locally depending on your needs:
Globally
For global installation, use the following command:
npm install -g acf-block-generator
This will install acf-block-generator
globally, allowing you to use it in any project.
Locally
For local installation within your project, use:
npm install acf-block-generator --save-dev
This will install acf-block-generator
as a development dependency in your project.
Usage
After installation, you can generate an ACF block by running:
Globally
If installed globally, directly use:
create-acf-block 'Your Block Name'
Locally
If installed locally, use npx
to run the command:
npx create-acf-block 'Your Block Name'
In both cases, replace 'Your Block Name'
with the desired name for your block.
Template Options
To generate a block with the advanced template structure, add advanced at the end of the command:
npx create-acf-block 'Your Block Name' advanced
Features
- Generates a PHP template for the block with placeholders for block settings, attributes, and other necessary configurations.
- Creates a CSS file for block styling.
- Produces a
block.json
file with necessary configurations, including a dynamically generated keywords array based on the block's name. - All files are named based on a hyphenated version of the block's name for consistency.
Output
Upon successful execution, the tool will create a directory named after the block (in hyphenated form). Inside this directory, you'll find:
[block-name].php
: The PHP template for the block.[block-name].css
: The CSS file for block styling.block.json
: The JSON configuration file for the block.
License
This project is licensed under the MIT License - see the License file for details.