Merge pull request #25 from WebDevStudios/feature/WDSBT-20-custom-blocks

Feature/WDSBT-20 Custom block build process

Author: khleomix

.eslintignore

@@ -1,3 +1,4 @@
+blocks
 build
 node_modules
 vendor

.gitignore

@@ -23,6 +23,7 @@ vendor/
 
 # theme
 build/
+blocks/
 
 #tests
 pa11y-ci-report/

.markdownlintignore

@@ -1,3 +1,4 @@
+blocks
 build
 node_modules
 vendor

.prettierignore

@@ -1,5 +1,7 @@
+blocks/
 build/
 node_modules/
 vendor/
 style.css
 README.md
+acf-json/

.stylelintignore

@@ -1,3 +1,4 @@
+blocks/
 build/
 vendor/
 node_modules/

README.md

@@ -17,6 +17,7 @@
 - [Getting Started](#getting-started)
 - [Development](#development)
     - [NPM Scripts](#npm-scripts)
+- [Creating Custom Blocks](#creating-blocks)
 - [Customizations](#customizations)
         - [Implementation](#implementation)
     - [Mixins](#mixins)
@@ -205,6 +206,7 @@ npm run setup
 |-------|---------|-------------|
 | 🌐 | `npm run a11y` | Run accessibility tests using Pa11y-CI. |
 | 🛠️ | `npm run build` | Build the theme using `wp-scripts`. |
+| 🔨 | `npm run create-block` | Create a custom block with Webpack and @wordpress/create-block. |
 | 📝 | `npm run format` | Format files using `wp-scripts` and `composer`. |
 | 🔍 | `npm run lint` | Run all linting scripts. |
 | 🎨 | `npm run lint:css` | Lint CSS files using `wp-scripts`. |
@@ -218,6 +220,30 @@ npm run setup
 | ▶️ | `npm run start` | Start the development server using `wp-scripts`. |
 
 
+[🔝 Back to Top](#wds-bt)
+***
+
+## Creating Blocks
+
+1. Run the Block Creation Script
+   Navigate to your project root in the terminal and run the following command to create a new block:
+
+```bash
+npm run create-block
+```
+
+Follow the prompts to configure your new block. The script will scaffold a new block structure inside assets/blocks/.
+
+2. Build your block
+   After editing and configuring your block, build your project to compile assets using webpack:
+
+```bash
+npm run build
+```
+This will process JavaScript, SCSS, optimize images, and generate necessary files in the build/ directory and custom blocks will have files generated in the blocks/ directory.
+
+
+
 [🔝 Back to Top](#wds-bt)
 ***
 
@@ -245,13 +271,13 @@ npm run setup
 </details>
 
 <details closed>
-<summary><b>Overriding/Customizing Core Block Styles</b></summary>
+<summary><b>Overriding/Customizing Block Styles</b></summary>
 
-1. Navigate to the `assets/scss/blocks/core` directory within your theme.
+1. Navigate to the `assets/scss/blocks/` directory within your theme. If overriding a core block style, use the `core` folder, if overriding a block from a plugin use the `custom` folder.
 
-2. Create an SCSS file with the exact filename as the block name you want to customize. This file will house your custom styles for that specific core block.
+2. Create an SCSS file with the exact filename as the block name you want to customize. This file will house your custom styles for that specific block.
 
-3. Files within the `assets/scss/blocks/core` directory are automatically enqueued, simplifying the integration of your custom styles into the WordPress block editor. Do not import these files into the main `index.scss`
+3. Files within the `assets/scss/blocks/core/` directory are automatically enqueued, simplifying the integration of your custom styles into the WordPress block editor. Do not import these files into the main `index.scss`
 
 4. After adding your custom SCSS file, run the following command to compile and apply your changes:
 

assets/blocks/.gitkeep

@@ -0,0 +1 @@
+/* -- Editor Stykes -- */

assets/scss/editor.scss

@@ -0,0 +1,3 @@
+{
+  "presets": ["@babel/preset-env", "@babel/preset-react"]
+}

babel.config.json

@@ -25,14 +25,15 @@
 		"composer/installers": "^2.2.0"
 	},
 	"require-dev": {
+		"php": ">=8.0",
 		"dealerdirect/phpcodesniffer-composer-installer": "^1.0.0",
 		"phpcompatibility/phpcompatibility-wp": "^2.1.4",
 		"squizlabs/php_codesniffer": "^3.10.1",
 		"wp-cli/wp-cli-bundle": "^2.10.0",
 		"wp-coding-standards/wpcs": "^3.1.0"
 	},
 	"scripts": {
-		"fix": "./vendor/bin/phpcbf --report=summary,source",
-		"lint": "./vendor/bin/phpcs --report=summary,source"
+		"phpcs": "./vendor/bin/phpcs --report=full,source",
+		"phpcs-fix": "./vendor/bin/phpcbf --report=summary,source"
 	}
 }