This repo has been archived

Please use @wordpress/create-block as an alternative.

WDS Block Starter

A Gutenberg block starter for WebDevStudios projects. For more info on the WordPress Block API, check out the Gutenberg Handbook.

Requirements

• Node LTS
• Composer

We highly recommend NVM so you can easily switch between Node versions.

Setup

Automatic Installation

Easily scaffold a block via CLI:

npx @webdevstudios/create-block WebDevStudios/TodoList
cd todo-list
npm run start

See @webdevstudios/create-block for more information and options.

Manual Installation

Install dependencies:

npm install

Rename the files and functions to meet your needs.

Development

Watch for changes:

npm run start

Build a production version:

npm run build

Other handy commands

Lint JS:

npm run lint:js

Lint SCSS/CSS:

npm run lint:css

Lint PHP:

composer run lint

Webpack Config (optional)

The optional webpack.config.js file includes the @wordpress/scripts defaults, along with an entry path for /src/frontend.js. The frontend entry path is conditionally included and is not a requirement. It can be safely deleted.

Contributing and Support

Your contributions and support tickets are welcome. Please see our guidelines before submitting a pull request.

Changelog

1.1.1

• Fix stylesheet enqueue

1.1.0

• Add support for Prettier
• Add support for Stylelint
• Add block.json
• Improve alignment with Gutenberg's use of @wordpress/scripts
• Improve PHP linting via Composer
• Mention that webpack.config.js is optional

1.0.0

• Add support for @wordpress/scripts 12.1.1
• Update webpack config
• Add import statements for SCSS files

0.0.1

• Initial block starter setup.