generator-chisel 2.3.3 → 2.4.0

package/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 <!-- INSERT-NEW-ENTRIES-HERE -->
 
+## 2.4.0 (2026-02-09)
+
+- chisel update scripts and husky precommit hooks ([31c1019](https://github.com/xfiveco/generator-chisel/commit/31c1019))
+- php refactor and optimize, chise install set default wp options, minor fixes ([f742903](https://github.com/xfiveco/generator-chisel/commit/f742903))
+- separate core php from custom, add base for custom, improve code structure ([d3ea3f4](https://github.com/xfiveco/generator-chisel/commit/d3ea3f4))
+- theme improvements, fixes, adjustments ([d2f7420](https://github.com/xfiveco/generator-chisel/commit/d2f7420))
+- update chisel version ([55bfaaf](https://github.com/xfiveco/generator-chisel/commit/55bfaaf))
+- Webpack config chnages: client ovarlay, nvmrc update, composer packages version update ([a07c16c](https://github.com/xfiveco/generator-chisel/commit/a07c16c))
+
 ## <small>2.3.3 (2026-01-02)</small>
 
 - Publish ([0e98159](https://github.com/xfiveco/generator-chisel/commit/0e98159))

package/lib/commands/create/creators/app/chisel-starter-theme/.editorconfig

@@ -0,0 +1,16 @@
+root = true
+
+[*]
+end_of_line = lf
+indent_style = space
+indent_size = 2
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+max_line_length = 100
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.php]
+indent_style = tab

package/lib/commands/create/creators/app/chisel-starter-theme/.husky/pre-commit

@@ -0,0 +1,92 @@
+#!/bin/sh
+# Chisel Core Files Protection Hook
+# This hook warns when committing MODIFICATIONS to core/ folder files
+# which will be overwritten by chisel-update
+
+# ============================================================================
+# CORE FILES CHECK
+# ============================================================================
+
+check_core_files() {
+  # Allow skipping with CHISEL_SKIP_CORE_CHECK=1 or --no-verify
+  if [ "$CHISEL_SKIP_CORE_CHECK" = "1" ]; then
+    return 0
+  fi
+
+  # Check if this is the initial commit (no HEAD exists)
+  if ! git rev-parse --verify HEAD >/dev/null 2>&1; then
+    # Initial commit - allow all files including core/
+    return 0
+  fi
+
+  # Only check for MODIFIED files in core/ (not newly Added files)
+  # M = Modified, R = Renamed (which counts as a modification)
+  CORE_FILES=$(git diff --cached --name-only --diff-filter=MR | grep "/core/" || true)
+  CORE_FILES_ALT=$(git diff --cached --name-only --diff-filter=MR | grep "^core/" || true)
+
+  # Combine results
+  if [ -n "$CORE_FILES_ALT" ]; then
+    if [ -n "$CORE_FILES" ]; then
+      CORE_FILES="$CORE_FILES
+$CORE_FILES_ALT"
+    else
+      CORE_FILES="$CORE_FILES_ALT"
+    fi
+  fi
+
+  # Exit if no core files are staged
+  if [ -z "$CORE_FILES" ]; then
+    return 0
+  fi
+
+  # Warn about core file modifications
+  echo ""
+  echo "                     ⚠️  CHISEL CORE FILES MODIFIED  ⚠️                        "
+  echo "╠══════════════════════════════════════════════════════════════════════════════╣"
+  echo "║                                                                              ║"
+  echo "║  You are about to commit changes to files in the 'core/' folder.             ║"
+  echo "║  These files are managed by Chisel and will be OVERWRITTEN when you run:     ║"
+  echo "║                                                                              ║"
+  echo "║      npm run update-chisel                                                   ║"
+  echo "║                                                                              ║"
+  echo "╠══════════════════════════════════════════════════════════════════════════════╣"
+  echo "║  RECOMMENDATION:                                                             ║"
+  echo "║                                                                              ║"
+  echo "║  Instead of modifying core files, create or modify files in the 'custom/'    ║"
+  echo "║  folder. Custom files extend and override core functionality safely.         ║"
+  echo "║                                                                              ║"
+  echo "║  Examples:                                                                   ║"
+  echo "║    - core/WP/Site.php → custom/app/WP/Site.php                               ║"
+  echo "║    - core/Helpers/ImageHelpers.php → custom/app/Helpers/ImageHelpers.php     ║"
+  echo "║                                                                              ║"
+  echo "╠══════════════════════════════════════════════════════════════════════════════╣"
+  echo "║  Modified core files:                                                        ║"
+  echo "╟──────────────────────────────────────────────────────────────────────────────╢"
+
+  echo "$CORE_FILES" | while read -r file; do
+    printf "║    • %-70s ║\n" "$file"
+  done
+
+  echo "╠══════════════════════════════════════════════════════════════════════════════╣"
+  echo "║  OPTIONS:                                                                    ║"
+  echo "║                                                                              ║"
+  echo "║  1. Move your changes to the 'custom/' folder (recommended)                  ║"
+  echo "║  2. Skip this check if you know what you're doing:                           ║"
+  echo "║                                                                              ║"
+  echo "║     git commit --no-verify                                                   ║"
+  echo "║     # or                                                                     ║"
+  echo "║     CHISEL_SKIP_CORE_CHECK=1 git commit                                      ║"
+  echo "║                                                                              ║"
+  echo "╚══════════════════════════════════════════════════════════════════════════════╝"
+  echo ""
+
+  return 1
+}
+
+# Run core files check
+check_core_files || exit 1
+
+# ============================================================================
+# ADDITIONAL HOOKS
+# ============================================================================
+

package/lib/commands/create/creators/app/chisel-starter-theme/.nvmrc

@@ -1 +1 @@
->=20.12.2
+24.11.1

package/lib/commands/create/creators/app/chisel-starter-theme/README.md

@@ -1,21 +1,22 @@
-# Chisel Wordpress Theme
+# Chisel WordPress Theme
 
-## Wordpress Starter Theme based on Timber library
+## WordPress Starter Theme based on Timber library
 
-Chisel is a Wordpress Starter Theme powered by Timber library that helps to seprate the logic from view by using Twig engine to render html content. It also simplifies the code, makes it more readable and speeds up development.
+Chisel is a custom WordPress development framework we built to make developers’ lives easier. It streamlines theme development with a modern stack — Webpack, Timber, and ITCSS — ensuring faster coding, cleaner structure, and more maintainable projects.
 
 ## Installation
 
-Use node version `20.12.2`
+Use Node.js version `24.11.1` (Minimum `20.12.2`)
 
-Chisel is installed as a npm package using npx command: `npx generator-chisel`, which installs the whole projet for you including composer and node dependencies, however when you join the project and clone the repository, follow these steps to start the local developent:
+Chisel is installed as a npm package using npx command: `npx generator-chisel`, which scaffolds the entire project for you including composer and node dependencies, however when you join the project and clone the repository, follow these steps to start the local development:
 
 1. Go to the theme folder
 2. Run `composer install`
 3. Run `npm install`
-4. Run `npm run wp-config`
+4. Copy `wp-config-custom.php` and rename it to `wp-config.php` in the project root directory (if you haven't done so already).
+5. Run `npm run wp-config`
 
-    After creating the wp-config-local.php file make sure you have these lines in the file:
+    After creating the `wp-config-local.php` file make sure you have these lines in the file:
 
     ```php
     define( 'WP_DEBUG', true );
@@ -27,11 +28,67 @@ Chisel is installed as a npm package using npx command: `npx generator-chisel`,
     define( 'WP_ENVIRONMENT_TYPE', 'development' );
     ```
 
-5. Run `npm run build`
+6. Run `npm run build`
 
-    The local url for the new project should be `project-name.test`
+    The local URL for the new project should be `project-name.test`
 
-6. Run `npm run dev` to start local development. The url for local development is the same with "fast refresh" mode enabled for CSS and JavaScript.
+7. Run `npm run dev` to start local development. The URL for local development is the same with "Fast Refresh" mode enabled for CSS and JavaScript.
+
+## Updating Chisel
+
+To check if a new version of Chisel is available:
+
+```bash
+npm run check-update
+```
+
+To update the core files to the latest version:
+
+```bash
+npm run update-chisel
+```
+
+Or run both at once:
+
+```bash
+npm run update
+```
+
+**Note:** The update command will overwrite all files in the `core/` folder.
+
+## Core Folder Protection
+
+The `core/` folder contains base Chisel files that are updated automatically when you run `npm run update-chisel`. A pre-commit hook will warn you if you try to commit changes to these files.
+
+### Setting Up Git Hooks
+
+Git hooks are set up automatically by the Chisel generator if git is already initialized. If you cloned the project or ran `git init` after installation, run:
+
+```bash
+npm run prepare
+```
+
+### Recommended Approach
+
+Instead of modifying core files directly, create corresponding files in the `custom/` folder:
+
+| Instead of modifying...          | Create/modify...                       |
+|----------------------------------|----------------------------------------|
+| `core/WP/Site.php`               | `custom/app/WP/Site.php`               |
+| `core/Helpers/ImageHelpers.php`  | `custom/app/Helpers/ImageHelpers.php`  |
+| `core/Timber/ChiselPost.php`     | `custom/app/Timber/ChiselPost.php`     |
+
+### Bypassing the Hook
+
+If you understand the implications and need to commit core changes anyway:
+
+```bash
+# Option 1: Skip verification
+git commit --no-verify
+
+# Option 2: Use environment variable
+CHISEL_SKIP_CORE_CHECK=1 git commit
+```
 
 ## Known issues
 

package/lib/commands/create/creators/app/chisel-starter-theme/assets/icons-source/search.svg

@@ -0,0 +1,3 @@
+<svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg">
+<path d="M21 21L16.65 16.65M11 19C15.4183 19 19 15.4183 19 11C19 6.58172 15.4183 3 11 3C6.58172 3 3 6.58172 3 11C3 15.4183 6.58172 19 11 19Z" stroke="#293229" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"/>
+</svg>

package/lib/commands/create/creators/app/chisel-starter-theme/composer.json

@@ -11,9 +11,9 @@
   },
   "require-dev": {
     "squizlabs/php_codesniffer": "^3.13",
-    "wp-coding-standards/wpcs": "^3.2",
-    "friendsoftwig/twigcs": "^6.5",
-    "vincentlanglet/twig-cs-fixer": "^3.10"
+    "wp-coding-standards/wpcs": "^3.3",
+    "friendsoftwig/twigcs": "^6.6",
+    "vincentlanglet/twig-cs-fixer": "^3.11"
   },
   "require": {
     "php": "^8.2",

package/lib/commands/create/creators/app/chisel-starter-theme/{inc/WP/AjaxEndpoints.php → core/Ajax/LoadMoreEndpoint.php}

@@ -1,25 +1,28 @@
 <?php
 
-namespace Chisel\WP;
+namespace Chisel\Ajax;
 
+use Chisel\Interfaces\AjaxEndpointInterface;
+use Chisel\Traits\Rest;
 use Timber\Timber;
 use Chisel\Helpers\CacheHelpers;
 
 /**
- * Custom Ajax enpoints callbacks
+ * Load more endpoint.
  *
  * @package Chisel
  */
-final class AjaxEndpoints {
+final class LoadMoreEndpoint implements AjaxEndpointInterface {
+	use Rest;
 
 	/**
-	 * Ajax call for load more feature.
+	 * Ajax call for load more posts feature.
 	 *
 	 * @param \WP_REST_Request $request WP_REST_Request.
 	 *
 	 * @return \WP_REST_Response
 	 */
-	public function load_more( \WP_REST_Request $request ): \WP_REST_Response {
+	public function handle( \WP_REST_Request $request ): \WP_REST_Response {
 		if ( ! $request ) {
 			return $this->error( 'No request data' );
 		}
@@ -60,50 +63,4 @@ final class AjaxEndpoints {
 
 		return $this->success( $response );
 	}
-
-	/**
-	 * Get data from request.
-	 *
-	 * @param \WP_REST_Request $request WP_REST_Request.
-	 *
-	 * @return array
-	 */
-	private function get_data( \WP_REST_Request $request ): array {
-		return $request->get_body_params();
-	}
-
-	/**
-	 * This function will return a success response.
-	 *
-	 * @param mixed $data
-	 *
-	 * @return \WP_REST_Response
-	 */
-	private function success( mixed $data = array() ): \WP_REST_Response {
-		return new \WP_REST_Response(
-			array(
-				'error'   => 0,
-				'message' => 'ok',
-				'data'    => $data,
-			),
-			200
-		);
-	}
-
-	/**
-	 * This function will return an error response.
-	 *
-	 * @param string $message
-	 *
-	 * @return \WP_REST_Response
-	 */
-	private function error( string $message ): \WP_REST_Response {
-		return new \WP_REST_Response(
-			array(
-				'error'   => 1,
-				'message' => $message,
-			),
-			200
-		);
-	}
 }

package/lib/commands/create/creators/app/chisel-starter-theme/core/Controllers/AjaxController.php

@@ -0,0 +1,225 @@
+<?php
+
+namespace Chisel\Controllers;
+
+use Chisel\Traits\HooksSingleton;
+use Chisel\Traits\Rest;
+
+/**
+ * Custom Ajax class based on REST API.
+ *
+ * @package Chisel
+ */
+final class AjaxController extends \WP_REST_Controller {
+
+	use HooksSingleton;
+	use Rest;
+
+	/**
+	 * Ajax custom route namespace.
+	 *
+	 * @var string
+	 */
+	public const ROUTE_NAMESPACE = 'chisel/v2';
+
+	/**
+	 * Ajax custom route base.
+	 *
+	 * @var string
+	 */
+	public const ROUTE_BASE = 'ajax';
+
+	/**
+	 * Ajax custom routes.
+	 *
+	 * @var array
+	 */
+	private array $routes = array();
+
+	/**
+	 * Set properties.
+	 */
+	public function set_properties(): void {
+		$this->routes = array(
+			'load-more' => array(),
+		);
+	}
+
+	/**
+	 * Register action hooks.
+	 */
+	public function action_hooks(): void {
+		add_action( 'rest_api_init', array( $this, 'register_endpoints' ) );
+	}
+
+	/**
+	 * Register filter hooks.
+	 */
+	public function filter_hooks(): void {}
+
+	/**
+	 * Register endpoints
+	 *
+	 * @return void
+	 */
+	public function register_endpoints(): void {
+		$this->routes = apply_filters( 'chisel_ajax_routes', $this->routes );
+
+		if ( $this->routes ) {
+			foreach ( $this->routes as $route_name => $route_params ) {
+				$route   = sprintf( '%s/%s/', self::ROUTE_BASE, $route_name );
+				$methods = isset( $route_params['methods'] ) ? $route_params['methods'] : array( 'POST' );
+				$handler = isset( $route_params['handler'] ) ? $route_params['handler'] : null;
+
+				register_rest_route(
+					self::ROUTE_NAMESPACE,
+					$route,
+					array(
+						'methods'             => $methods,
+						'callback'            => array( $this, 'callback' ),
+						'permission_callback' => array( $this, 'permissions_check' ),
+						'args'                => $this->get_endpoint_args_for_item_schema( true ),
+						'handler'             => $handler,
+					)
+				);
+			}
+		}
+	}
+
+	/**
+	 * Create dynamic route callback
+	 *
+	 * @param \WP_REST_Request $request WP_REST_Request.
+	 *
+	 * @return \WP_REST_Response|\WP_Error|array
+	 */
+	public function callback( \WP_REST_Request $request ): \WP_REST_Response|\WP_Error|array {
+		$endpoint_class = $this->get_endpoint_class( $request );
+
+		if ( is_wp_error( $endpoint_class ) ) {
+			return $this->error( $endpoint_class->get_error_message() );
+		}
+
+		$callback = 'handle';
+
+		if ( method_exists( $endpoint_class, $callback ) ) {
+			if ( ! defined( 'DOING_AJAX' ) ) {
+				define( 'DOING_AJAX', true );
+			}
+
+			if ( ! defined( 'DOING_CHISEL_AJAX' ) ) {
+				define( 'DOING_CHISEL_AJAX', true );
+			}
+
+			$endpoint = new $endpoint_class();
+			return $endpoint->handle( $request );
+		}
+
+		return $this->error( sprintf( 'Callback `%s()` not found in %s class', $callback, $endpoint_class ) );
+	}
+
+	/**
+	 * Check ajax request permissions.
+	 *
+	 * @param \WP_REST_Request $request WP_REST_Request.
+	 *
+	 * @return boolean|\WP_REST_Response|\WP_Error
+	 */
+	public function permissions_check( \WP_REST_Request $request ): bool|\WP_REST_Response|\WP_Error {
+		$verify_nonce = wp_verify_nonce( $request->get_header( 'x_wp_nonce' ), 'wp_rest' );
+		$allowed      = (bool) $verify_nonce;
+
+		$endpoint_class = $this->get_endpoint_class( $request );
+
+		if ( is_wp_error( $endpoint_class ) ) {
+			return $this->error( $endpoint_class->get_error_message() );
+		}
+
+		$endpoint_class = sanitize_key( str_replace( '\\', '-', $endpoint_class ) );
+
+		$permission = apply_filters( 'chisel_ajax_permissions_check', $allowed, $endpoint_class, $request );
+
+		return $permission;
+	}
+
+	/**
+	 * Get callback class from ajax request.
+	 *
+	 * @param \WP_REST_Request $request
+	 *
+	 * @return string|\WP_Error
+	 */
+	private function get_endpoint_class( \WP_REST_Request $request ): string|\WP_Error {
+		$custom_class_name = $this->get_endpoint_custom_class( $request );
+
+		if ( is_wp_error( $custom_class_name ) ) {
+			return $custom_class_name;
+		}
+
+		if ( $custom_class_name ) {
+			return $custom_class_name;
+		}
+
+		$route          = $request->get_route();
+		$route_parts    = explode( '/', $route );
+		$endpoint       = end( $route_parts );
+		$endpoint_parts = explode( '-', $endpoint );
+		$endpoint_parts = array_map( 'ucfirst', $endpoint_parts );
+		$endpoint_class = implode( '', $endpoint_parts ) . 'Endpoint';
+
+		$custom_class_name  = CHISEL_NAMESPACE . 'Ajax\\Custom\\' . $endpoint_class;
+		$default_class_name = CHISEL_NAMESPACE . 'Ajax\\' . $endpoint_class;
+
+		if ( class_exists( $custom_class_name ) ) {
+			$class_name = $custom_class_name;
+		} elseif ( class_exists( $default_class_name ) ) {
+			$class_name = $default_class_name;
+		} else {
+			$class_name = null;
+		}
+
+		if ( ! $class_name ) {
+			return new \WP_Error( 'chisel_ajax_endpoint_class_missing', sprintf( 'Ajax Endpoint class: %s not found in inc or custom/inc directory', $endpoint_class ), array( 'status' => 404 ) );
+		}
+
+		return $class_name;
+	}
+
+	/**
+	 * Get custom class from ajax request.
+	 *
+	 * @param \WP_REST_Request $request
+	 *
+	 * @return string|bool|\WP_Error
+	 */
+	private function get_endpoint_custom_class( \WP_REST_Request $request ): string|bool|\WP_Error {
+		$attributes = $request->get_attributes();
+
+		$custom_class = $attributes['handler'] ?? null;
+
+		if ( ! $custom_class ) {
+			return false;
+		}
+
+		if ( ! class_exists( $custom_class ) ) {
+			return new \WP_Error( 'chisel_ajax_handler_class_missing', sprintf( 'Ajax custom Endpoint class: %s not found in custom/inc directory', $custom_class ), array( 'status' => 404 ) );
+		}
+
+		return $custom_class;
+	}
+
+	/**
+	 * Get endpoint name from ajax request.
+	 *
+	 * @param \WP_REST_Request $request
+	 *
+	 * @return string
+	 */
+	private function get_endpoint_name( \WP_REST_Request $request ): string {
+		$route       = $request->get_route();
+		$route_parts = explode( '/', $route );
+		$endpoint    = str_replace( '-', '_', end( $route_parts ) );
+
+		return $endpoint;
+	}
+}

package/lib/commands/create/creators/app/chisel-starter-theme/{inc → core}/Helpers/AcfHelpers.php

@@ -8,6 +8,10 @@ namespace Chisel\Helpers;
  * @package Chisel
  */
 final class AcfHelpers {
+	/**
+	 * Prevent instantiation.
+	 */
+	private function __construct() {}
 
 	/**
 	 * Get the acf field value. Acf get_field() wrapper. If ACF plugin is not active, returns false.

package/lib/commands/create/creators/app/chisel-starter-theme/{inc → core}/Helpers/AjaxHelpers.php

@@ -10,6 +10,10 @@ use Chisel\Controllers\AjaxController;
  * @package Chisel
  */
 final class AjaxHelpers {
+	/**
+	 * Prevent instantiation.
+	 */
+	private function __construct() {}
 
 	/**
 	 * Get custom ajax endpint

package/lib/commands/create/creators/app/chisel-starter-theme/{inc → core}/Helpers/AssetsHelpers.php

@@ -8,6 +8,10 @@ namespace Chisel\Helpers;
  * @package Chisel
  */
 final class AssetsHelpers {
+	/**
+	 * Prevent instantiation.
+	 */
+	private function __construct() {}
 
 	/**
 	 * Get the final handle for the asset.

package/lib/commands/create/creators/app/chisel-starter-theme/{inc → core}/Helpers/BlocksHelpers.php

@@ -4,6 +4,7 @@ namespace Chisel\Helpers;
 
 use Timber\Timber;
 use Chisel\WP\AcfBlocks;
+use Chisel\WP\Blocks;
 use Chisel\Helpers\CacheHelpers;
 
 /**
@@ -12,6 +13,10 @@ use Chisel\Helpers\CacheHelpers;
  * @package Chisel
  */
 final class BlocksHelpers {
+	/**
+	 * Prevent instantiation.
+	 */
+	private function __construct() {}
 
 	/**
 	 * Get block object classnames

package/lib/commands/create/creators/app/chisel-starter-theme/{inc → core}/Helpers/CacheHelpers.php

@@ -5,7 +5,7 @@ namespace Chisel\Helpers;
 use Timber\Timber;
 use Timber\Loader;
 
-use Chisel\WP\Cache;
+use Chisel\Timber\Cache;
 
 /**
  * Image Helper functions.
@@ -13,6 +13,10 @@ use Chisel\WP\Cache;
  * @package Chisel
  */
 final class CacheHelpers {
+	/**
+	 * Prevent instantiation.
+	 */
+	private function __construct() {}
 
 	/**
 	 * Get the cache expiry time.

package/lib/commands/create/creators/app/chisel-starter-theme/{inc → core}/Helpers/CommentsHelpers.php

@@ -8,6 +8,10 @@ namespace Chisel\Helpers;
  * @package Chisel
  */
 final class CommentsHelpers {
+	/**
+	 * Prevent instantiation.
+	 */
+	private function __construct() {}
 
 	/**
 	 * Display comments template - the comments and the form.

package/lib/commands/create/creators/app/chisel-starter-theme/{inc → core}/Helpers/DataHelpers.php

@@ -10,6 +10,10 @@ use Timber\Timber;
  * @package Chisel
  */
 final class DataHelpers {
+	/**
+	 * Prevent instantiation.
+	 */
+	private function __construct() {}
 
 	/**
 	 * Json decode data for storing in html attribute

package/lib/commands/create/creators/app/chisel-starter-theme/{inc → core}/Helpers/GravityFormsHelpers.php

@@ -8,6 +8,10 @@ namespace Chisel\Helpers;
  * @package Chisel
  */
 final class GravityFormsHelpers {
+	/**
+	 * Prevent instantiation.
+	 */
+	private function __construct() {}
 
 	/**
 	 * Check if Gravity Forms plugin is active.