generator-chisel 1.0.0 → 2.0.0-alpha.1

package/CHANGELOG.md

@@ -2,6 +2,39 @@
 
 <!-- INSERT-NEW-ENTRIES-HERE -->
 
+## 2.0.0-alpha.1 (2024-09-10)
+
+- adjust commands ([b289bd8](https://github.com/xfiveco/generator-chisel/commit/b289bd8))
+- Cleanup coding standards, minor adjustments, install ACF automatically ([816eada](https://github.com/xfiveco/generator-chisel/commit/816eada))
+- fix whitespace ([9d58dba](https://github.com/xfiveco/generator-chisel/commit/9d58dba))
+- theme acf adjustments ([27016f7](https://github.com/xfiveco/generator-chisel/commit/27016f7))
+- theme adjustments and bug fixes ([1253e18](https://github.com/xfiveco/generator-chisel/commit/1253e18))
+
+## 2.0.0-alpha.0 (2024-09-08)
+
+- acf block json custom arg to load css only ([0659521](https://github.com/xfiveco/generator-chisel/commit/0659521))
+- add block creator ([ea0e956](https://github.com/xfiveco/generator-chisel/commit/ea0e956))
+- Add Coding Standards, Minor Improvements ([cfcb017](https://github.com/xfiveco/generator-chisel/commit/cfcb017))
+- add prettier override ([c86cf4d](https://github.com/xfiveco/generator-chisel/commit/c86cf4d))
+- add styles indexing ([192b71d](https://github.com/xfiveco/generator-chisel/commit/192b71d))
+- cleanup ([e78d5d4](https://github.com/xfiveco/generator-chisel/commit/e78d5d4))
+- cleanup layout ([b0d5b5e](https://github.com/xfiveco/generator-chisel/commit/b0d5b5e))
+- cleanup, working start and build ([0f82f3b](https://github.com/xfiveco/generator-chisel/commit/0f82f3b))
+- composer json update ([81ac720](https://github.com/xfiveco/generator-chisel/commit/81ac720))
+- create design styles ([a395fb5](https://github.com/xfiveco/generator-chisel/commit/a395fb5))
+- fix dependencies ([9997915](https://github.com/xfiveco/generator-chisel/commit/9997915))
+- fix package template ([eb476f4](https://github.com/xfiveco/generator-chisel/commit/eb476f4))
+- Merge branch 'v2' of github.com:xfiveco/generator-chisel into v2 ([02bda4e](https://github.com/xfiveco/generator-chisel/commit/02bda4e))
+- more cleanup, use default command ([e1fcf10](https://github.com/xfiveco/generator-chisel/commit/e1fcf10))
+- move coding standards ([faecb0d](https://github.com/xfiveco/generator-chisel/commit/faecb0d))
+- New chisel theme ([a05665b](https://github.com/xfiveco/generator-chisel/commit/a05665b))
+- remove engines, cleanup ([d562e69](https://github.com/xfiveco/generator-chisel/commit/d562e69))
+- remove wordpress plugin and move code to chisel scripts ([bb90260](https://github.com/xfiveco/generator-chisel/commit/bb90260))
+- separate docs dependencies, cleanup ([d5cf033](https://github.com/xfiveco/generator-chisel/commit/d5cf033))
+- update timber ([1f4d08c](https://github.com/xfiveco/generator-chisel/commit/1f4d08c))
+- WiP ([802891c](https://github.com/xfiveco/generator-chisel/commit/802891c))
+- working setup with composer ([abd16db](https://github.com/xfiveco/generator-chisel/commit/abd16db))
+
 ## 1.0.0 (2021-12-17)
 
 - Rewrite with Webpack (#509) ([14fa2d0](https://github.com/xfiveco/generator-chisel/commit/14fa2d0)), closes [#509](https://github.com/xfiveco/generator-chisel/issues/509)

package/README.md

@@ -1,10 +1,8 @@
- [![Build Status](https://travis-ci.org/xfiveco/generator-chisel.svg?branch=master)](https://travis-ci.org/xfiveco/generator-chisel) [![NPM version](https://badge.fury.io/js/generator-chisel.svg)](https://badge.fury.io/js/generator-chisel) [![NPM dependiencies](https://david-dm.org/xfiveco/generator-chisel.svg)](https://david-dm.org/xfiveco/generator-chisel)
-
 # Chisel
 
-Chisel is a development framework for creating easy to maintain and fast WordPress websites and front-end templates.
+[![npm](https://img.shields.io/npm/v/generator-chisel)](https://www.npmjs.com/package/generator-chisel)
 
-**New version: We are currently working on a complete rewrite of Chisel with Webpack. Check out [how to install and test the new version](https://github.com/xfiveco/generator-chisel/issues/465).**
+Chisel is a development framework for creating easy to maintain and fast WordPress websites and front-end templates.
 
 ## Learn more
 - [Introduction](https://www.getchisel.co/)

package/bin/chisel.js

@@ -2,21 +2,11 @@
 
 const { Command } = require('commander');
 
-const handlePromise = (promise) =>
-  promise.catch((err) => {
-    if (typeof jest === 'undefined') {
-      console.error(err);
-      process.exit(1);
-    }
-
-    return Promise.reject(err);
-  });
-
 const createProgram = () => {
   const program = new Command();
 
   program
-    .command('create')
+    .command('create', { isDefault: true })
     .description('create a new project powered by Chisel')
     .option('--skip-dependencies-install')
     .option('--skip-wp-download')
@@ -24,7 +14,6 @@ const createProgram = () => {
     .option('--skip-wp-install')
     .option('--skip-wp-commands')
     .option('--skip-wp-plugins')
-    .option('--skip-fe-add-index')
     .option('--skip-format-and-build')
     .option(
       '--link',
@@ -33,23 +22,14 @@ const createProgram = () => {
     .action((...args) => {
       const cmd = args.slice(-1)[0];
       args = args.slice(0, -1);
-      return handlePromise(require('../lib/commands/create')({ args, cmd }));
+      return require('../lib/commands/create')({ args, cmd });
     });
 
   return program;
 };
 
 (async () => {
-  if (typeof jest !== 'undefined') {
-    module.exports = (argv) => createProgram().parseAsync(argv);
-    return;
-  }
-
   const program = createProgram();
 
   program.parse(process.argv);
-
-  if (process.argv.length <= 2) {
-    program.outputHelp();
-  }
 })();

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

@@ -0,0 +1 @@
+20

package/lib/commands/create/creators/app/chisel-starter-theme/.twig-cs-fixer.php

@@ -0,0 +1,13 @@
+<?php
+
+$finder = new TwigCsFixer\File\Finder();
+$finder->exclude('acf-json');
+$finder->exclude('classes');
+$finder->exclude('dist');
+$finder->exclude('vendor');
+
+$config = new TwigCsFixer\Config\Config();
+$config->setCacheFile(null);
+$config->setFinder($finder);
+
+return $config;

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

@@ -0,0 +1,16 @@
+<?php
+/**
+ * The Template for displaying 404 page.
+ *
+ * @package Chisel
+ */
+
+use Chisel\ChiselCache;
+use Timber\Timber;
+
+$context = Timber::context();
+
+$context['post']['ID']    = 'error-404';
+$context['post']['class'] = 'is-404';
+
+Timber::render( '404.twig', $context, ChiselCache::expiry() );

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

@@ -0,0 +1,3 @@
+# Chisel WP Theme
+
+## Wordpress Starter Theme based on Timber library

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

@@ -0,0 +1,59 @@
+{
+  "key": "group_666eb7f38d2ed",
+  "title": "Page Title",
+  "fields": [
+    {
+      "key": "field_666eb7f40c492",
+      "label": "Page Title",
+      "name": "page_title_display",
+      "aria-label": "",
+      "type": "select",
+      "instructions": "",
+      "required": 0,
+      "conditional_logic": 0,
+      "wrapper": {
+        "width": "",
+        "class": "",
+        "id": ""
+      },
+      "choices": {
+        "show": "Show",
+        "hide-visually": "Hide visually",
+        "hide": "Hide"
+      },
+      "default_value": "show",
+      "return_format": "value",
+      "multiple": 0,
+      "allow_null": 0,
+      "ui": 0,
+      "ajax": 0,
+      "placeholder": ""
+    }
+  ],
+  "location": [
+    [
+      {
+        "param": "post_type",
+        "operator": "==",
+        "value": "post"
+      }
+    ],
+    [
+      {
+        "param": "post_type",
+        "operator": "==",
+        "value": "page"
+      }
+    ]
+  ],
+  "menu_order": -10,
+  "position": "side",
+  "style": "default",
+  "label_placement": "top",
+  "instruction_placement": "label",
+  "hide_on_screen": "",
+  "active": true,
+  "description": "",
+  "show_in_rest": 0,
+  "modified": 1723819074
+}

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

@@ -0,0 +1,148 @@
+{
+  "key": "group_66d5a4ebb41cd",
+  "title": "Slider Settings",
+  "fields": [
+      {
+          "key": "field_66d5a4f9ee449",
+          "label": "Settings",
+          "name": "slider_settings",
+          "aria-label": "",
+          "type": "checkbox",
+          "instructions": "",
+          "required": 0,
+          "conditional_logic": 0,
+          "wrapper": {
+              "width": "",
+              "class": "",
+              "id": ""
+          },
+          "choices": {
+              "arrows": "Arrows",
+              "dots": "Dots",
+              "loop": "Loop",
+              "autoplay": "Autoplay",
+              "thumbnails": "Thumbnails"
+          },
+          "default_value": [
+              "arrows",
+              "dots"
+          ],
+          "return_format": "value",
+          "allow_custom": 0,
+          "layout": "vertical",
+          "toggle": 0,
+          "save_custom": 0,
+          "custom_choice_button_text": "Add new choice"
+      },
+      {
+          "key": "field_66d5a74076f5f",
+          "label": "Dynamic dots",
+          "name": "slider_settings_dynamic_dots",
+          "aria-label": "",
+          "type": "button_group",
+          "instructions": "",
+          "required": 0,
+          "conditional_logic": [
+              [
+                  {
+                      "field": "field_66d5a4f9ee449",
+                      "operator": "==",
+                      "value": "dots"
+                  }
+              ]
+          ],
+          "wrapper": {
+              "width": "",
+              "class": "",
+              "id": ""
+          },
+          "choices": {
+              "yes": "Yes",
+              "no": "No"
+          },
+          "default_value": "no",
+          "return_format": "value",
+          "allow_null": 0,
+          "layout": "horizontal"
+      },
+      {
+          "key": "field_66d5a77e76f60",
+          "label": "No of thumbnails",
+          "name": "slider_settings_thumbnails_no",
+          "aria-label": "",
+          "type": "number",
+          "instructions": "",
+          "required": 0,
+          "conditional_logic": [
+              [
+                  {
+                      "field": "field_66d5a4f9ee449",
+                      "operator": "==",
+                      "value": "thumbnails"
+                  }
+              ]
+          ],
+          "wrapper": {
+              "width": "",
+              "class": "",
+              "id": ""
+          },
+          "default_value": 8,
+          "min": 1,
+          "max": "",
+          "placeholder": "",
+          "step": 1,
+          "prepend": "",
+          "append": ""
+      },
+      {
+          "key": "field_66d5a9feca5b9",
+          "label": "Autoplay timeout",
+          "name": "slider_settings_autoplay_timeout",
+          "aria-label": "",
+          "type": "number",
+          "instructions": "",
+          "required": 0,
+          "conditional_logic": [
+              [
+                  {
+                      "field": "field_66d5a4f9ee449",
+                      "operator": "==",
+                      "value": "autoplay"
+                  }
+              ]
+          ],
+          "wrapper": {
+              "width": "",
+              "class": "",
+              "id": ""
+          },
+          "default_value": 5000,
+          "min": 1000,
+          "max": "",
+          "placeholder": "",
+          "step": 100,
+          "prepend": "",
+          "append": ""
+      }
+  ],
+  "location": [
+      [
+          {
+              "param": "post_type",
+              "operator": "==",
+              "value": "page"
+          }
+      ]
+  ],
+  "menu_order": 0,
+  "position": "normal",
+  "style": "default",
+  "label_placement": "top",
+  "instruction_placement": "label",
+  "hide_on_screen": "",
+  "active": false,
+  "description": "For cloning only",
+  "show_in_rest": 0,
+  "modified": 1725978785
+}

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

@@ -0,0 +1,38 @@
+<?php
+/**
+ * The Template for displaying Archive pages.
+ *
+ * @package Chisel
+ */
+
+use Chisel\ChiselCache;
+use Timber\Timber;
+
+$templates = array( 'archive.twig', 'index.twig' );
+
+$context = Timber::context();
+
+$context['title'] = 'Archive';
+if ( is_day() ) {
+	$context['title'] = 'Archive: ' . get_the_date( 'D M Y' );
+} elseif ( is_month() ) {
+	$context['title'] = 'Archive: ' . get_the_date( 'M Y' );
+} elseif ( is_year() ) {
+	$context['title'] = 'Archive: ' . get_the_date( 'Y' );
+} elseif ( is_tag() ) {
+	$context['title'] = __( 'Tag: ', 'chisel' ) . ' ' . single_tag_title( '', false );
+	array_unshift( $templates, 'archive-' . get_queried_object()->slug . '.twig' );
+} elseif ( is_category() ) {
+	$context['title'] = __( 'Category: ', 'chisel' ) . ' ' . single_cat_title( '', false );
+	array_unshift( $templates, 'archive-' . get_queried_object()->slug . '.twig' );
+} elseif ( is_post_type_archive() ) {
+	$context['title'] = post_type_archive_title( '', false );
+	array_unshift( $templates, 'archive-' . get_post_type() . '.twig' );
+} elseif ( is_tax() ) {
+	$context['title'] = single_term_title( '', false );
+	array_unshift( $templates, 'archive-' . get_queried_object()->taxonomy . '.twig' );
+}
+
+$context['posts'] = Timber::get_posts();
+
+Timber::render( $templates, $context, ChiselCache::expiry() );

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

@@ -0,0 +1,17 @@
+<!-- By Sam Herbert (@sherb), for everyone. More @ http://goo.gl/7AJzbL -->
+<svg viewBox="0 0 38 38" xmlns="http://www.w3.org/2000/svg" stroke="#000000">
+    <g fill="none" fill-rule="evenodd">
+        <g transform="translate(1 1)" stroke-width="2">
+            <circle stroke-opacity=".5" cx="18" cy="18" r="18"/>
+            <path d="M36 18c0-9.94-8.06-18-18-18">
+                <animateTransform
+                    attributeName="transform"
+                    type="rotate"
+                    from="0 18 18"
+                    to="360 18 18"
+                    dur="1s"
+                    repeatCount="indefinite"/>
+            </path>
+        </g>
+    </g>
+</svg>

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

@@ -0,0 +1,4 @@
+<!-- Generated by IcoMoon.io -->
+<svg version="1.1" xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 20 20">
+<path d="M16 10c0 0.553-0.048 1-0.601 1h-10.798c-0.552 0-0.601-0.447-0.601-1s0.049-1 0.601-1h10.799c0.552 0 0.6 0.447 0.6 1z"></path>
+</svg>

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

@@ -0,0 +1,4 @@
+<!-- Generated by IcoMoon.io -->
+<svg version="1.1" xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 20 20">
+<path d="M16 10c0 0.553-0.048 1-0.601 1h-4.399v4.399c0 0.552-0.447 0.601-1 0.601s-1-0.049-1-0.601v-4.399h-4.399c-0.552 0-0.601-0.447-0.601-1s0.049-1 0.601-1h4.399v-4.399c0-0.553 0.447-0.601 1-0.601s1 0.048 1 0.601v4.399h4.399c0.553 0 0.601 0.447 0.601 1z"></path>
+</svg>

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

@@ -0,0 +1,18 @@
+<?php
+/**
+ * The Template for displaying Author Archive pages.
+ *
+ * @package Chisel
+ */
+
+use Chisel\ChiselCache;
+use Timber\Timber;
+
+$author = Timber::get_user( get_queried_object_id() );
+
+$context           = Timber::context();
+$context['posts']  = Timber::get_posts();
+$context['author'] = $author;
+$context['title']  = __( 'Author: ', 'chisel' ) . $author->name;
+
+Timber::render( array( 'author.twig', 'archive.twig' ), $context, ChiselCache::expiry() );

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

@@ -0,0 +1,191 @@
+<?php
+
+namespace Chisel;
+
+/**
+ * ACF related functionalities.
+ *
+ * @package Chisel
+ */
+class Acf implements Instance {
+
+	/**
+	 * ACF options pages.
+	 *
+	 * @var array
+	 */
+	protected $acf_options_pages = array();
+
+	/**
+	 * ACF options sub pages.
+	 *
+	 * @var array
+	 */
+	protected $acf_options_sub_pages = array();
+
+	/**
+	 * Class constructor.
+	 */
+	private function __construct() {
+		$this->set_properties();
+		$this->action_hooks();
+		$this->filter_hooks();
+
+		if ( class_exists( '\ACF_Admin_Internal_Post_Type_List' ) ) {
+			\Chisel\AcfSync::get_instance();
+		}
+	}
+
+	/**
+	 * Set properties.
+	 */
+	public function set_properties() {
+		$this->set_options_pages();
+		$this->set_options_sub_pages();
+	}
+
+	/**
+	 * Register action hooks.
+	 */
+	public function action_hooks() {
+		add_action( 'acf/init', array( $this, 'options_pages' ) );
+	}
+
+	/**
+	 * Register filter hooks.
+	 */
+	public function filter_hooks() {
+	}
+
+	/**
+	 * Set ACF options pages.
+	 */
+	public function set_options_pages() {
+		$this->acf_options_pages = apply_filters(
+			'chisel_acf_options_pages',
+			array(
+				// phpcs:disable
+				// array(
+				// 	'menu_slug'  => 'theme-settings',
+				// 	'page_title' => __( 'Theme Settings', 'chisel' ),
+				// ),
+				// phpcs:enable
+			)
+		);
+	}
+
+	/**
+	 * Set ACF options sub pages.
+	 */
+	public function set_options_sub_pages() {
+		$this->acf_options_sub_pages = apply_filters(
+			'chisel_acf_options_sub_pages',
+			array(
+				// phpcs:disable
+				// array(
+				// 	'menu_slug'   => 'theme-sub-settings',
+				// 	'page_title'  => __( 'Theme Sub settings', 'chisel' ),
+				// 	'menu_title'  => __( 'Theme Sub settings', 'chisel' ),
+				// 	'parent_slug' => 'theme-settings',
+				// ),
+				// phpcs:enable
+			)
+		);
+	}
+
+	/**
+	 * Register ACF options pages.
+	 */
+	public function options_pages() {
+		if ( $this->acf_options_pages && function_exists( 'acf_add_options_page' ) ) {
+			foreach ( $this->acf_options_pages as $data ) {
+				$this->register_options_page( $data, 'page' );
+			}
+		}
+
+		if ( $this->acf_options_sub_pages && function_exists( 'acf_add_options_sub_page' ) ) {
+			foreach ( $this->acf_options_sub_pages as $data ) {
+				$this->register_options_page( $data, 'subpage' );
+			}
+		}
+	}
+
+	/**
+	 * Register ACF options sub pages.
+	 *
+	 * @param array  $data
+	 * @param string $type  page or subpage.
+	 *
+	 * @return void
+	 */
+	protected function register_options_page( $data, $type = 'page' ) {
+		$options_page_args = array(
+			'page_title'      => $data['page_title'],
+			'menu_title'      => isset( $data['menu_title'] ) ? $data['menu_title'] : $data['page_title'],
+			'menu_slug'       => $data['menu_slug'],
+			'capability'      => isset( $data['capability'] ) ? $data['capability'] : 'edit_posts',
+			'position'        => isset( $data['position'] ) ? $data['position'] : 45,
+			'redirect'        => isset( $data['redirect'] ) ? $data['redirect'] : true,
+			'icon_url'        => isset( $data['icon_url'] ) ? $data['icon_url'] : 'dashicons-screenoptions',
+			'post_id'         => isset( $data['post_id'] ) ? $data['post_id'] : 'options',
+			'autoload'        => isset( $data['autoload'] ) ? $data['autoload'] : false,
+			'update_button'   => isset( $data['update_button'] ) ? $data['update_button'] : __( 'Update', 'chisel' ),
+			'updated_message' => isset( $data['updated_message'] ) ? $data['updated_message'] : __( 'Options Updated', 'chisel' ),
+			'parent_slug'     => isset( $data['parent_slug'] ) ? $data['parent_slug'] : '',
+		);
+
+		if ( $type === 'subpage' ) {
+			acf_add_options_sub_page( $options_page_args );
+		} else {
+			acf_add_options_page( $options_page_args );
+		}
+	}
+
+	/**
+	 * Get the acf field value. Acf get_field() wrapper. If ACF plugin is not active, returns false.
+	 *
+	 * @param string   $selector
+	 * @param int|bool $post_id
+	 * @param bool     $format_value
+	 * @param bool     $escape_html
+	 *
+	 * @return mixed
+	 */
+	public static function get_field( $selector, $post_id = false, $format_value = true, $escape_html = false ) {
+		if ( function_exists( 'get_field' ) ) {
+			return get_field( $selector, $post_id, $format_value, $escape_html );
+		}
+
+		return false;
+	}
+
+	/**
+	 * Update the acf field value. Acf update_field() wrapper. If ACF plugin is not active, returns false.
+	 *
+	 * @param string   $selector
+	 * @param mixed    $value
+	 * @param int|bool $post_id
+	 *
+	 * @return int|bool
+	 */
+	public static function update_field( $selector, $value, $post_id = false ) {
+		if ( function_exists( 'update_field' ) ) {
+			return update_field( $selector, $value, $post_id );
+		}
+
+		return false;
+	}
+
+	/**
+	 * Get the instance of the class.
+	 */
+	public static function get_instance() {
+		static $instance = null;
+
+		if ( null === $instance ) {
+			$instance = new self();
+		}
+
+		return $instance;
+	}
+}