generator-chisel 2.3.3 → 2.4.0

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

@@ -4,9 +4,7 @@ namespace Chisel\WP;
 
 use Timber\Timber;
 
-use Chisel\Interfaces\InstanceInterface;
-use Chisel\Interfaces\HooksInterface;
-use Chisel\Traits\Singleton;
+use Chisel\Traits\HooksSingleton;
 use Chisel\Helpers\CommentsHelpers;
 use Chisel\Helpers\DataHelpers;
 use Chisel\Helpers\ImageHelpers;
@@ -20,24 +18,9 @@ use Chisel\WP\Components;
  *
  * @package Chisel
  */
-final class Twig implements InstanceInterface, HooksInterface {
+final class Twig {
 
-	use Singleton;
-
-	/**
-	 * Class constructor.
-	 */
-	private function __construct() {
-		add_action( 'after_setup_theme', array( $this, 'set_properties' ), 7 );
-
-		$this->action_hooks();
-		$this->filter_hooks();
-	}
-
-	/**
-	 * Set properties.
-	 */
-	public function set_properties(): void {}
+	use HooksSingleton;
 
 	/**
 	 * Register action hooks.
@@ -83,6 +66,8 @@ final class Twig implements InstanceInterface, HooksInterface {
 		$this->register_function( $twig, 'get_icon', array( $this, 'get_icon' ) );
 		$this->register_function( $twig, 'should_use_icons_module', array( $this, 'should_use_icons_module' ) );
 
+		do_action( 'chisel_twig_register_functions', $twig, $this );
+
 		return $twig;
 	}
 
@@ -93,6 +78,7 @@ final class Twig implements InstanceInterface, HooksInterface {
 	 * @return \Twig\Environment
 	 */
 	public function register_filters( \Twig\Environment $twig ): \Twig\Environment {
+		do_action( 'chisel_twig_register_filters', $twig, $this );
 
 		return $twig;
 	}
@@ -104,6 +90,7 @@ final class Twig implements InstanceInterface, HooksInterface {
 	 * @return \Twig\Environment
 	 */
 	public function register_tests( \Twig\Environment $twig ): \Twig\Environment {
+		do_action( 'chisel_twig_register_tests', $twig, $this );
 
 		return $twig;
 	}
@@ -117,7 +104,7 @@ final class Twig implements InstanceInterface, HooksInterface {
 	 *
 	 * @return \Twig\Environment
 	 */
-	private function register_function( $twig, $name, $callback ): \Twig\Environment {
+	public function register_function( \Twig\Environment $twig, string $name, callable $callback ): \Twig\Environment {
 		$twig->addFunction( new \Twig\TwigFunction( $name, $callback ) );
 
 		return $twig;
@@ -132,7 +119,7 @@ final class Twig implements InstanceInterface, HooksInterface {
 	 *
 	 * @return \Twig\Environment
 	 */
-	private function register_filter( \Twig\Environment $twig, string $name, callable $callback ): \Twig\Environment {
+	public function register_filter( \Twig\Environment $twig, string $name, callable $callback ): \Twig\Environment {
 		$twig->addFilter( new \Twig\TwigFilter( $name, $callback ) );
 
 		return $twig;
@@ -147,7 +134,7 @@ final class Twig implements InstanceInterface, HooksInterface {
 	 *
 	 * @return \Twig\Environment
 	 */
-	private function register_test( \Twig\Environment $twig, string $name, callable $callback ): \Twig\Environment {
+	public function register_test( \Twig\Environment $twig, string $name, callable $callback ): \Twig\Environment {
 		$twig->addTest( new \Twig\TwigTest( $name, $callback ) );
 
 		return $twig;
@@ -182,20 +169,14 @@ final class Twig implements InstanceInterface, HooksInterface {
 	 *
 	 * @return string
 	 */
-	public function post_classes( ?string $classes, string $prefix = 'c-post--' ): string {
+	public function post_classes( ?string $classes, string $prefix = 'c-post' ): string {
 		if ( empty( $classes ) ) {
 			return '';
 		}
 
 		$classnames = explode( ' ', $classes );
-		$classnames = array_map(
-			function ( $classname ) use ( $prefix ) {
-				return $prefix . $classname;
-			},
-			$classnames
-		);
 
-		return implode( ' ', $classnames );
+		return ThemeHelpers::bem( $prefix, ...$classnames );
 	}
 
 	/**

package/lib/commands/create/creators/app/chisel-starter-theme/custom/app/Timber/ChiselPost.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace Chisel\Timber\Custom;
+
+use Chisel\Timber\ChiselPost as CoreChiselPost;
+use Timber\Timber;
+
+/**
+ * Extend Timber Post class with custom functionality.
+ *
+ * @package Chisel
+ */
+class ChiselPost extends CoreChiselPost {
+}

package/lib/commands/create/creators/app/chisel-starter-theme/custom/app/WP/Acf.php

@@ -0,0 +1,66 @@
+<?php
+
+namespace Chisel\WP\Custom;
+
+use Chisel\Traits\HooksSingleton;
+
+/**
+ * ACF related functionality.
+ *
+ * @package Chisel
+ */
+class Acf {
+
+	use HooksSingleton;
+
+	/**
+	 * Register action hooks.
+	 */
+	public function action_hooks(): void {}
+
+	/**
+	 * Register filter hooks.
+	 */
+	public function filter_hooks(): void {
+		add_filter( 'chisel_acf_options_pages', array( $this, 'register_acf_options_pages' ) );
+		add_filter( 'chisel_acf_options_sub_pages', array( $this, 'register_acf_options_sub_pages' ) );
+	}
+
+	/**
+	 * Register custom ACF options pages.
+	 *
+	 * @param array $options_pages The options pages.
+	 *
+	 * @return array
+	 */
+	public function register_acf_options_pages( $options_pages ) {
+		// phpcs:disable -- Example of custom ACF options page
+		// $options_pages[] = array(
+		// 	'menu_slug'  => 'theme-settings',
+		// 	'page_title' => __( 'Theme Settings', 'chisel' ),
+		// );
+		// phpcs:enable
+
+		return $options_pages;
+	}
+
+	/**
+	 * Register custom ACF options sub pages.
+	 *
+	 * @param array $options_sub_pages The options sub pages.
+	 *
+	 * @return array
+	 */
+	public function register_acf_options_sub_pages( $options_sub_pages ) {
+		// phpcs:disable -- Example of custom ACF options sub page
+		// $options_sub_pages[] = array(
+		// 	'menu_slug'   => 'theme-sub-settings',
+		// 	'page_title'  => __( 'Theme Sub settings', 'chisel' ),
+		// 	'menu_title'  => __( 'Theme Sub settings', 'chisel' ),
+		// 	'parent_slug' => 'theme-settings',
+		// );
+		// phpcs:enable
+
+		return $options_sub_pages;
+	}
+}

package/lib/commands/create/creators/app/chisel-starter-theme/custom/app/WP/Ajax.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace Chisel\WP\Custom;
+
+use Chisel\Traits\HooksSingleton;
+
+/**
+ * Ajax related functionality.
+ *
+ * @package Chisel
+ */
+class Ajax {
+
+	use HooksSingleton;
+
+	/**
+	 * Register action hooks.
+	 */
+	public function action_hooks(): void {}
+
+	/**
+	 * Register filter hooks.
+	 */
+	public function filter_hooks(): void {
+		add_filter( 'chisel_ajax_routes', array( $this, 'register_ajax_routes' ) );
+	}
+
+	/**
+	 * Register custom ajax routes.
+	 *
+	 * @param array $routes The ajax routes.
+	 *
+	 * @return array
+	 */
+	public function register_ajax_routes( array $routes ): array {
+		// phpcs:disable -- Example of custom ajax route
+		// $routes['custom_route'] = array(
+		// 	'methods'  => 'POST', // default is POST
+		// 	'handler'  => 'Chisel\WP\Custom\Ajax\CustomRouteHandler', // custom handler class, leave empty for default handler: CustomRouteEndpoint
+		// );
+		// phpcs:enable
+
+		return $routes;
+	}
+}

package/lib/commands/create/creators/app/chisel-starter-theme/custom/app/WP/Assets.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace Chisel\WP\Custom;
+
+use Chisel\Traits\HooksSingleton;
+
+/**
+ * Class for enqueuing scripts and styles.
+ *
+ * @package Chisel
+ */
+class Assets {
+	use HooksSingleton;
+
+	/**
+	 * Add action hooks.
+	 */
+	public function action_hooks(): void {}
+
+	/**
+	 * Add filter hooks.
+	 */
+	public function filter_hooks(): void {
+		add_filter( 'chisel_frontend_styles', array( $this, 'frontend_styles' ) );
+	}
+
+	/**
+	 * Modify frontend styles.
+	 *
+	 * @param array $styles Frontend styles.
+	 *
+	 * @return array Frontend styles.
+	 */
+	public function frontend_styles( array $styles ): array {
+		return $styles;
+	}
+}

package/lib/commands/create/creators/app/chisel-starter-theme/custom/app/WP/CustomPostTypes.php

@@ -0,0 +1,76 @@
+<?php
+
+namespace Chisel\WP\Custom;
+
+use Chisel\Traits\HooksSingleton;
+
+/**
+ * Custom Post Types related functionality.
+ *
+ * @package Chisel
+ */
+class CustomPostTypes {
+	use HooksSingleton;
+
+	/**
+	 * Register action hooks.
+	 */
+	public function action_hooks(): void {}
+
+	/**
+	 * Register filter hooks.
+	 */
+	public function filter_hooks(): void {
+		add_filter( 'chisel_custom_post_types', array( $this, 'register_custom_post_types' ) );
+		add_filter( 'chisel_custom_taxonomies', array( $this, 'register_custom_taxonomies' ) );
+	}
+
+	/**
+	 * Register custom post types.
+	 *
+	 * @param array $post_types The post types.
+	 *
+	 * @return array
+	 */
+	public function register_custom_post_types( $post_types ) {
+		// phpcs:disable -- Example of custom post type. Remove this line and the phpcs:enable when adding your own custom post types
+		// $post_types['chisel-cpt'] = array(
+		// 	'singular'      => __( 'Chisel CPT', 'chisel' ),
+		// 	'plural'        => __( 'Chisel CPTs', 'chisel' ),
+		// 	'supports'      => array( 'editor', 'thumbnail', 'excerpt' ),
+		// 	'menu_icon'     => 'dashicons-location-alt',
+		// 	'hierarchical'  => true,
+		// 	'public'        => true,
+		// 	'menu_position' => 20,
+		// 	'rewrite'       => array(
+		// 		'slug' => 'chisel-post',
+		// 	),
+		// );
+		// phpcs:enable
+
+		return $post_types;
+	}
+
+	/**
+	 * Register custom taxonomies.
+	 *
+	 * @param array $taxonomies The taxonomies.
+	 *
+	 * @return array
+	 */
+	public function register_custom_taxonomies( $taxonomies ) {
+		// phpcs:disable -- Example of custom taxonomy. Remove this line and the phpcs:enable when adding your own custom taxonomies
+		// $taxonomies['chisel-term'] = array(
+		// 	'singular'   => __( 'Chisel Term', 'chisel' ),
+		// 	'plural'     => __( 'Chisel Terms', 'chisel' ),
+		// 	'post_types' => array( 'chisel-cpt' ),
+		// 	'public'     => true,
+		// 	'rewrite'    => array(
+		// 		'slug' => 'chisel-term',
+		// 	),
+		// );
+		// phpcs:enable
+
+		return $taxonomies;
+	}
+}

package/lib/commands/create/creators/app/chisel-starter-theme/custom/app/WP/Site.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace Chisel\WP\Custom;
+
+use Chisel\Traits\HooksSingleton;
+
+/**
+ * Site related functionality related to timber.
+ *
+ * @package Chisel
+ */
+class Site {
+
+	use HooksSingleton;
+
+	/**
+	 * Register action hooks.
+	 */
+	public function action_hooks(): void {}
+
+	/**
+	 * Register filter hooks.
+	 */
+	public function filter_hooks(): void {
+		add_filter( 'timber/post/classmap', array( $this, 'post_classmap' ), 11 );
+	}
+
+	/**
+	 * Add custom post class map.
+	 *
+	 * @param array $classmap The class map.
+	 *
+	 * @return array
+	 */
+	public function post_classmap( array $classmap ): array {
+		$custom_classmap = array(
+			'post' => \Chisel\Timber\Custom\ChiselPost::class,
+		);
+
+		return array_merge( $classmap, $custom_classmap );
+	}
+}

package/lib/commands/create/creators/app/chisel-starter-theme/custom/app/WP/Twig.php

@@ -0,0 +1,52 @@
+<?php
+
+namespace Chisel\WP\Custom;
+
+use Chisel\Traits\HooksSingleton;
+
+/**
+ * Custom Twig functionality.
+ *
+ * @package Chisel
+ */
+class Twig {
+
+	use HooksSingleton;
+
+	/**
+	 * Register action hooks.
+	 */
+	public function action_hooks(): void {
+		add_action( 'chisel_twig_register_functions', array( $this, 'register_functions' ), 10, 2 );
+		add_action( 'chisel_twig_register_filters', array( $this, 'register_filters' ), 10, 2 );
+	}
+
+	/**
+	 * Register filter hooks.
+	 */
+	public function filter_hooks(): void {}
+
+	/**
+	 * Register custom twig functions.
+	 *
+	 * @param \Twig\Environment $twig The Twig environment.
+	 * @param \Chisel\WP\Twig   $chisel_twig The Chisel Twig instance.
+	 */
+	public function register_functions( \Twig\Environment $twig, \Chisel\WP\Twig $chisel_twig ): void {
+		// phpcs:disable -- Example of custom function. Remove this line and the phpcs:enable when adding your own custom functions
+		// $twig->addFunction( new \Twig\Function( 'custom_fn', array( $this, 'custom_fn_callback' ) ) );
+		// phpcs:enable
+	}
+
+	/**
+	 * Register custom twig filters.
+	 *
+	 * @param \Twig\Environment $twig The Twig environment.
+	 * @param \Chisel\WP\Twig   $chisel_twig The Chisel Twig instance.
+	 */
+	public function register_filters( \Twig\Environment $twig, \Chisel\WP\Twig $chisel_twig ): void {
+		// phpcs:disable -- Example of custom filter. Remove this line and the phpcs:enable when adding your own custom filters
+		// $twig->addFilter( new \Twig\Filter( 'custom_filter', array( $this, 'custom_filter_callback' ) ) );
+		// phpcs:enable
+	}
+}

package/lib/commands/create/creators/app/chisel-starter-theme/custom/functions.php

@@ -0,0 +1,8 @@
+<?php
+
+\Chisel\WP\Custom\Acf::get_instance();
+\Chisel\WP\Custom\Ajax::get_instance();
+\Chisel\WP\Custom\Assets::get_instance();
+\Chisel\WP\Custom\CustomPostTypes::get_instance();
+\Chisel\WP\Custom\Site::get_instance();
+\Chisel\WP\Custom\Twig::get_instance();

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

@@ -0,0 +1,7 @@
+# Custom views
+
+Recommended approach is to use the main views folder, but if want more control and clear separation between the main theme and customizations, use the custom views folder.
+
+## Usage
+
+To overwrite views existing in the main folder create a file with the same name and the same folder structure.

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

@@ -6,27 +6,38 @@ require_once get_template_directory() . '/vendor/autoload.php';
 
 spl_autoload_register(
 	function ( $class_name ) {
-		$base_directory = get_template_directory() . '/inc/';
+		$base_directories = array(
+			get_template_directory() . '/core/',
+			get_template_directory() . '/custom/app/',
+		);
 
 		$namespace_prefix_length = strlen( CHISEL_NAMESPACE );
 
 		if ( strncmp( CHISEL_NAMESPACE, $class_name, $namespace_prefix_length ) !== 0 ) {
-			return;
+				return;
 		}
 
 		$relative_class_name = substr( $class_name, $namespace_prefix_length );
+		$relative_path       = str_replace( '\\', '/', $relative_class_name ) . '.php';
 
-		$class_filename = $base_directory . str_replace( '\\', '/', $relative_class_name ) . '.php';
+		foreach ( $base_directories as $base_directory ) {
+			if ( strpos( $base_directory, 'custom/app' ) !== false ) {
+				$relative_path = preg_replace( '/\/Custom\//', '/', $relative_path, 1 );
+			}
 
-		if ( file_exists( $class_filename ) ) {
-			require $class_filename;
+			$class_filename = $base_directory . $relative_path;
+
+			if ( file_exists( $class_filename ) ) {
+				require $class_filename;
+				return;
+			}
 		}
 	}
 );
 
 // Icons module. Also requires packacke.json and scss configuration.
 if ( ! defined( 'CHISEL_USE_ICONS_MODULE' ) ) {
-	define( 'CHISEL_USE_ICONS_MODULE', true );
+	define( 'CHISEL_USE_ICONS_MODULE', false );
 }
 
 Timber\Timber::init();
@@ -36,7 +47,6 @@ Timber\Timber::init();
 \Chisel\WP\Acf::get_instance();
 \Chisel\WP\AcfBlocks::get_instance();
 \Chisel\WP\Assets::get_instance();
-\Chisel\WP\Cache::get_instance();
 \Chisel\WP\Comments::get_instance();
 \Chisel\WP\Site::get_instance();
 \Chisel\WP\Sidebars::get_instance();
@@ -44,6 +54,13 @@ Timber\Timber::init();
 \Chisel\WP\CustomPostTypes::get_instance();
 \Chisel\WP\CustomTaxonomies::get_instance();
 \Chisel\WP\Twig::get_instance();
-\Chisel\Plugins\GravityForms::get_instance();
-\Chisel\Plugins\Woocommerce::get_instance();
-\Chisel\Plugins\Yoast::get_instance();
+\Chisel\Plugins\GravityForms\GravityForms::get_instance();
+\Chisel\Plugins\Woocommerce\Woocommerce::get_instance();
+\Chisel\Plugins\Yoast\Yoast::get_instance();
+\Chisel\Timber\Cache::get_instance();
+
+$custom_functions_php = get_template_directory() . '/custom/functions.php';
+
+if ( is_file( $custom_functions_php ) ) {
+	require_once $custom_functions_php;
+}

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

@@ -14,15 +14,19 @@
     "start": "chisel-scripts start --experimental-modules",
     "dev": "npm run --silent start",
     "build-scripts": "chisel-scripts build --experimental-modules",
-    "build": "npm run build-scripts && npm run lint && npm run phpcs && npm run twigcs",
+    "build": "npm run build-scripts && npm run lint && npm run phpcs && npm run twigcs && npm run check-update",
     "add-page": "chisel-scripts add-page",
     "create-block": "chisel-scripts create-block --category=chisel-blocks --namespace=chisel",
     "create-dynamic-block": "npm run create-block --variant=dynamic",
     "wp": "chisel-scripts wp",
     "composer": "chisel-scripts composer",
     "wp-config": "chisel-scripts wp-config",
-    "phpcs": "cross-env vendor/bin/phpcs --extensions=php",
-    "twigcs": "cross-env vendor/bin/twigcs --config=twig_cs.php"
+    "phpcs": "cross-env vendor/bin/phpcs --extensions=php --exclude=Generic.PHP.Syntax",
+    "twigcs": "cross-env vendor/bin/twigcs --config=twig_cs.php",
+    "check-update": "chisel-scripts check-chisel-update",
+    "update-chisel": "chisel-scripts chisel-update",
+    "update": "npm run check-update && npm run update-chisel",
+    "prepare": "chisel-scripts husky-init || node -e \"\""
   },
   "dependencies": {
     "swiper": "^11.1.10",
@@ -31,7 +35,8 @@
   "devDependencies": {
     "@wordpress/scripts": "^31.2.0",
     "chisel-scripts": "*",
-    "cross-env": "^7.0.3"
+    "cross-env": "^7.0.3",
+    "husky": "^9.1.7"
   },
   "overrides": {
     "@wordpress/scripts": {

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

@@ -63,4 +63,14 @@
     <severity>0</severity>
   </rule>
 
+  <!-- Disable unused function parameter warning - WordPress hooks often require specific signatures -->
+  <rule ref="Generic.CodeAnalysis.UnusedFunctionParameter">
+    <severity>0</severity>
+  </rule>
+
+  <!-- Disable Generic.PHP.Syntax - causes internal errors with PHP 8.2+ due to null to trim() deprecation -->
+  <rule ref="Generic.PHP.Syntax">
+    <severity>0</severity>
+  </rule>
+
 </ruleset>

package/lib/commands/create/creators/app/chisel-starter-theme/src/blocks/accordion/block.json

@@ -2,7 +2,7 @@
   "$schema": "https://schemas.wp.org/trunk/block.json",
   "apiVersion": 3,
   "name": "chisel/accordion",
-  "version": "0.1.0",
+  "version": "1.0.0",
   "title": "Accordion",
   "category": "chisel-blocks",
   "icon": "editor-justify",

package/lib/commands/create/creators/app/chisel-starter-theme/src/design/settings/_index.scss

@@ -33,7 +33,7 @@ $gaps: (
 /*
  * Icons
  */
-$static-icons: ('minus', 'plus', 'arrow-right', 'arrow-left');
+$static-icons: ('minus', 'plus', 'arrow-right', 'arrow-left', 'search');
 $animated-icons: ('loader');
 $multicolor-icons: ();
 

package/lib/commands/create/creators/app/chisel-starter-theme/src/design/tools/_breakpoints.scss

@@ -1,5 +1,6 @@
 @use 'sass:meta';
 @use 'sass:map';
+@use 'sass:list'; 
 @use '../settings';
 
 $_breakpoints: settings.$breakpoints;

package/lib/commands/create/creators/app/chisel-starter-theme/src/scripts/editor/mods/core.js

@@ -5,7 +5,11 @@ import { InspectorControls } from '@wordpress/blockEditor';
 import { PanelBody, ToggleControl } from '@wordpress/components';
 import { Fragment } from '@wordpress/element';
 
-addFilter('blocks.registerBlockType', 'chisel/add-no-margin-attribute', (settings) => {
+addFilter('blocks.registerBlockType', 'chisel/add-no-margin-attribute', (settings, name) => {
+  if (!name.includes('core/') && !name.includes('chisel/')) {
+    return settings;
+  }
+
   if (typeof settings.attributes !== 'undefined') {
     settings.attributes = {
       ...settings.attributes,
@@ -20,7 +24,12 @@ addFilter('blocks.registerBlockType', 'chisel/add-no-margin-attribute', (setting
 
 const addNoMarginToggle = createHigherOrderComponent((BlockEdit) => {
   return (props) => {
-    const { attributes, setAttributes, isSelected } = props;
+    const { attributes, setAttributes, isSelected, name } = props;
+
+    if (!name.includes('core/') && !name.includes('chisel/')) {
+      return <BlockEdit {...props} />;
+    }
+
     const { disableBottomMargin = false, className = '' } = attributes;
 
     const onToggle = (checked) => {

package/lib/commands/create/creators/app/chisel-starter-theme/src/scripts/modules/main-nav.js

@@ -1,4 +1,16 @@
 class MainNav {
+  /**
+   * Delay before adding the 'open' class after 'active'.
+   * This small delay ensures CSS transitions trigger properly.
+   */
+  static ANIMATION_START_DELAY = 10;
+
+  /**
+   * Duration to wait before cleanup after closing.
+   * Should match the CSS transition duration for the nav items.
+   */
+  static TRANSITION_DURATION = 300;
+
   constructor() {
     this.initSelectors();
     this.initElements();
@@ -71,7 +83,7 @@ class MainNav {
 
       setTimeout(() => {
         this.elements.navItems.classList.add(this.classnames.open);
-      }, 10);
+      }, MainNav.ANIMATION_START_DELAY);
 
       const coords = this.elements.navToggle.getBoundingClientRect();
 
@@ -91,7 +103,7 @@ class MainNav {
           right: 'auto',
           position: 'relative',
         });
-      }, 300);
+      }, MainNav.TRANSITION_DURATION);
     }
   }
 }