chisel-scripts 2.1.4 → 2.2.0

package/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 <!-- INSERT-NEW-ENTRIES-HERE -->
 
+## 2.2.0 (2026-02-09)
+
+- chisel update scripts and husky precommit hooks ([31c1019](https://github.com/xfiveco/generator-chisel/commit/31c1019))
+- Webpack config chnages: client ovarlay, nvmrc update, composer packages version update ([a07c16c](https://github.com/xfiveco/generator-chisel/commit/a07c16c))
+
+## <small>2.1.5 (2026-01-02)</small>
+
+- wp-config-updates, wp/scripts lt, icons module define in functions.php ([3c97c63](https://github.com/xfiveco/generator-chisel/commit/3c97c63))
+
 ## <small>2.1.4 (2025-12-17)</small>
 
 - fix no experimental dev mode runtime chunk ([84817eb](https://github.com/xfiveco/generator-chisel/commit/84817eb))

package/index.js

@@ -60,6 +60,15 @@ function adjustWebpackConfig(baseConfig, directory) {
   })();
 
   const preparedConfig = (config, index = null) => {
+    const devSeverClient = config.devServer ? {
+      ...config.devServer.client,
+      overlay: {
+        errors: true,
+        warnings: false,
+        runtimeErrors: false,
+      },
+    } : {}
+
     return {
       ...config,
       output: {
@@ -80,17 +89,15 @@ function adjustWebpackConfig(baseConfig, directory) {
       },
       devServer: config.devServer && {
         ...config.devServer,
+        client: {
+          ...devSeverClient,
+        },
         allowedHosts: [new URL(getUrl()).host],
         ...(process.env.CHISEL_PORT && {
           host: '0.0.0.0',
           port: Number(process.env.CHISEL_PORT) + 1,
           client: {
-            ...config.devServer.client,
-            overlay: {
-              errors: true,
-              warnings: false,
-              runtimeErrors: false,
-            },
+            ...devSeverClient,
             webSocketURL: new URL(getUrl())
               .toString()
               .replace(process.env.CHISEL_PORT, Number(process.env.CHISEL_PORT) + 1),

package/lib/Service.js

@@ -27,6 +27,8 @@ module.exports = class Service {
 
     const builtInPlugins = [
       'wp-scripts.mjs', // start, build
+      'chisel-update.mjs', // check-chisel-update, chisel-update
+      'husky-init.mjs', // husky-init
       'composer',
       'wp',
       'wp-config',

package/lib/commands/chisel-update.mjs

@@ -0,0 +1,282 @@
+import https from 'https';
+import fs from 'fs';
+import path from 'path';
+
+// GitHub repository configuration
+const REPO = 'xfiveco/generator-chisel';
+const REF = 'v2';
+const THEME_PATH =
+  'packages/generator-chisel/lib/commands/create/creators/app/chisel-starter-theme';
+
+// URLs
+const STYLE_REMOTE_PATH = `${THEME_PATH}/style.chisel-tpl.css`;
+const STYLE_URL = `https://raw.githubusercontent.com/${REPO}/${REF}/${STYLE_REMOTE_PATH}`;
+
+/**
+ * List of paths to update from the Chisel repository.
+ * Can be folders or files.
+ */
+const PATHS_TO_UPDATE = [
+  'core',
+  // Add more folders/files here in the future
+];
+
+// Map of remote names to local names if they differ
+const NAME_MAPPING = {
+  'style.chisel-tpl.css': 'style.css',
+};
+
+const DEFAULT_OPTIONS = {
+  headers: {
+    'User-Agent': 'Chisel-Update-Script',
+  },
+};
+
+const VERSION_REGEX = /(Version:\s*)([0-9]+\.[0-9]+\.[0-9]+)/i;
+
+// ============================================================================
+// HTTP Utilities
+// ============================================================================
+
+function request(url, options = {}) {
+  return new Promise((resolve, reject) => {
+    const req = https.get(url, { ...DEFAULT_OPTIONS, ...options }, (res) => {
+      if (res.statusCode === 301 || res.statusCode === 302) {
+        return resolve(request(res.headers.location, options));
+      }
+      if (res.statusCode < 200 || res.statusCode >= 300) {
+        return reject(new Error(`Status Code: ${res.statusCode} for ${url}`));
+      }
+      const data = [];
+      res.on('data', (chunk) => data.push(chunk));
+      res.on('end', () => resolve(Buffer.concat(data)));
+    });
+    req.on('error', reject);
+  });
+}
+
+async function fetchText(url) {
+  const buffer = await request(url);
+  return buffer.toString();
+}
+
+async function fetchJson(url) {
+  const buffer = await request(url);
+  return JSON.parse(buffer.toString());
+}
+
+// ============================================================================
+// Version Utilities
+// ============================================================================
+
+function extractVersion(css) {
+  const match = css.match(VERSION_REGEX);
+  return match ? match[2] : null;
+}
+
+function readLocalVersion(filePath) {
+  if (!fs.existsSync(filePath)) return null;
+  return extractVersion(fs.readFileSync(filePath, 'utf8'));
+}
+
+function updateLocalVersion(filePath, newVersion) {
+  if (!fs.existsSync(filePath)) {
+    console.error(`File not found: ${filePath}`);
+    return false;
+  }
+
+  const content = fs.readFileSync(filePath, 'utf8');
+  if (!VERSION_REGEX.test(content)) {
+    console.error(`Version pattern not found in: ${filePath}`);
+    return false;
+  }
+
+  const updatedContent = content.replace(VERSION_REGEX, `$1${newVersion}`);
+  fs.writeFileSync(filePath, updatedContent);
+  return true;
+}
+
+function compareVersions(a, b) {
+  const pa = a.split('.').map(Number);
+  const pb = b.split('.').map(Number);
+
+  for (let i = 0; i < 3; i++) {
+    if ((pa[i] || 0) > (pb[i] || 0)) return 1;
+    if ((pa[i] || 0) < (pb[i] || 0)) return -1;
+  }
+
+  return 0;
+}
+
+// ============================================================================
+// Update Functions
+// ============================================================================
+
+async function downloadFile(url, destPath) {
+  const buffer = await request(url);
+  fs.mkdirSync(path.dirname(destPath), { recursive: true });
+  fs.writeFileSync(destPath, buffer);
+}
+
+async function updateFolder(remoteFolderPath, localFolderPath) {
+  console.log(`📂 Updating folder: ${path.basename(remoteFolderPath)}`);
+
+  const apiUrl = `https://api.github.com/repos/${REPO}/contents/${remoteFolderPath}?ref=${REF}`;
+  let items;
+
+  try {
+    items = await fetchJson(apiUrl);
+  } catch (err) {
+    if (err.message.includes('404')) {
+      console.warn(`⚠️  Remote folder not found: ${remoteFolderPath}`);
+      return;
+    }
+    throw err;
+  }
+
+  if (!Array.isArray(items)) {
+    if (items.type === 'file') {
+      await downloadFile(items.download_url, localFolderPath);
+      return;
+    }
+    throw new Error(
+      `Expected array of items from GitHub API, got: ${typeof items}`,
+    );
+  }
+
+  for (const item of items) {
+    const localItemPath = path.join(localFolderPath, item.name);
+
+    if (item.type === 'file') {
+      console.log(`  📄 ${item.name}`);
+      await downloadFile(item.download_url, localItemPath);
+    } else if (item.type === 'dir') {
+      await updateFolder(item.path, localItemPath);
+    }
+  }
+}
+
+async function updateFile(remotePath, localPath) {
+  console.log(`  📄 Updating file: ${path.basename(remotePath)}`);
+  const downloadUrl = `https://raw.githubusercontent.com/${REPO}/${REF}/${remotePath}`;
+  await downloadFile(downloadUrl, localPath);
+}
+
+async function syncStyleVersion(localStylePath) {
+  console.log('\n📋 Syncing style.css version...');
+
+  const localVersion = readLocalVersion(localStylePath);
+  const remoteCss = await fetchText(STYLE_URL);
+  const remoteVersion = extractVersion(remoteCss);
+
+  if (!remoteVersion) {
+    console.warn('⚠️  Could not fetch remote version.');
+    return;
+  }
+
+  if (!localVersion) {
+    console.warn('⚠️  Local version not found in style.css.');
+    return;
+  }
+
+  if (compareVersions(remoteVersion, localVersion) > 0) {
+    if (updateLocalVersion(localStylePath, remoteVersion)) {
+      console.log(`  ✔ Version updated: ${localVersion} → ${remoteVersion}`);
+    }
+  } else {
+    console.log(`  ✔ Version is already up to date (${localVersion})`);
+  }
+}
+
+// ============================================================================
+// Command Registration
+// ============================================================================
+
+export default function chiselUpdate(api) {
+  api.registerCommand(
+    'check-chisel-update',
+    (command) =>
+      command.description('check if a new Chisel version is available'),
+    async () => {
+      const localStylePath = api.resolve('style.css');
+
+      try {
+        const localVersion = readLocalVersion(localStylePath);
+
+        if (!localVersion) {
+          console.log(
+            '⚠️  Local version not found. Consider running `chisel-scripts update`.',
+          );
+          return;
+        }
+
+        console.log(`Local version: ${localVersion}`);
+
+        const remoteCss = await fetchText(STYLE_URL);
+        const remoteVersion = extractVersion(remoteCss);
+
+        if (!remoteVersion) {
+          console.log('⚠️  Could not fetch remote version.');
+          return;
+        }
+
+        if (compareVersions(remoteVersion, localVersion) > 0) {
+          console.log(
+            `\n⬆️  Update available: ${localVersion} → ${remoteVersion}`,
+          );
+          console.log(`Run 'chisel-scripts update' to update.`);
+        } else {
+          console.log(`✔ Chisel is up to date (${localVersion})`);
+        }
+      } catch (err) {
+        console.error('❌ Version check failed:', err.message);
+        process.exit(1);
+      }
+    },
+  );
+
+  api.registerCommand(
+    'chisel-update',
+    (command) =>
+      command
+        .description('update Chisel core files from the repository')
+        .option('--skip-version-sync', 'skip syncing version in style.css'),
+    async (options) => {
+      const localBasePath = api.resolve();
+      const localStylePath = api.resolve('style.css');
+
+      console.log('🚀 Starting Chisel update...\n');
+
+      try {
+        // Update configured paths
+        for (const item of PATHS_TO_UPDATE) {
+          const remotePath = `${THEME_PATH}/${item}`;
+          const localName = NAME_MAPPING[item] || item;
+          const localPath = path.join(localBasePath, localName);
+
+          if (item.includes('.')) {
+            await updateFile(remotePath, localPath);
+          } else {
+            await updateFolder(remotePath, localPath);
+          }
+        }
+
+        // Sync version in style.css
+        if (!options.skipVersionSync) {
+          await syncStyleVersion(localStylePath);
+        }
+
+        console.log('\n✅ Update completed successfully!');
+        console.log(
+          'Note: Local files that do not exist in the repository (e.g., custom files) were preserved.',
+        );
+      } catch (err) {
+        console.error('\n❌ Update failed:', err.message);
+        if (err.message.includes('403')) {
+          console.error('Note: This might be due to GitHub API rate limits.');
+        }
+        process.exit(1);
+      }
+    },
+  );
+}

package/lib/commands/create-block/index.js

@@ -15,7 +15,7 @@ module.exports = (api) => {
 
       const targetDir = api.resolve(
         'src',
-        template === 'acf' ? 'acf-blocks' : 'blocks',
+        template === 'acf' ? 'blocks-acf' : 'blocks',
       );
 
       const maybeTemplatePath =

package/lib/commands/husky-init.mjs

@@ -0,0 +1,123 @@
+import { execSync } from 'child_process';
+import path from 'path';
+import fs from 'fs';
+
+/**
+ * Get the git root directory
+ * @param {string} cwd - Current working directory
+ * @returns {string|null} - Git root path or null if not in a git repo
+ */
+function getGitRoot(cwd) {
+  try {
+    const result = execSync('git rev-parse --show-toplevel', {
+      cwd,
+      encoding: 'utf8',
+      stdio: ['pipe', 'pipe', 'pipe'],
+    });
+    return result.trim().replace(/\\/g, '/');
+  } catch {
+    return null;
+  }
+}
+
+/**
+ * Get relative path from git root to a target directory
+ * @param {string} gitRoot - Git root directory
+ * @param {string} targetDir - Target directory
+ * @returns {string} - Relative path
+ */
+function getRelativePath(gitRoot, targetDir) {
+  // Normalize paths
+  const normalizedGitRoot = path.resolve(gitRoot).replace(/\\/g, '/');
+  const normalizedTarget = path.resolve(targetDir).replace(/\\/g, '/');
+
+  // Get relative path
+  return path.relative(normalizedGitRoot, normalizedTarget).replace(/\\/g, '/');
+}
+
+export default function huskyInit(api) {
+  api.registerCommand(
+    'husky-init',
+    (command) =>
+      command
+        .description('initialize Husky git hooks for this theme')
+        .option('--force', 'force initialization even if already configured'),
+    async (options) => {
+      const themeDir = api.resolve();
+      const huskyDir = api.resolve('.husky');
+
+      // Check if .husky directory exists
+      if (!fs.existsSync(huskyDir)) {
+        console.error('❌ .husky directory not found in theme folder.');
+        console.error('   Make sure the theme was properly generated.');
+        process.exit(1);
+      }
+
+      // Find git root
+      const gitRoot = getGitRoot(themeDir);
+
+      if (!gitRoot) {
+        console.error('❌ Not inside a git repository.');
+        console.error('   Please run "git init" first at your project root.');
+        process.exit(1);
+      }
+
+      console.log(`📂 Git root: ${gitRoot}`);
+      console.log(`📁 Theme dir: ${themeDir}`);
+
+      // Calculate relative path from git root to .husky
+      const relativePath = getRelativePath(gitRoot, huskyDir);
+      console.log(`🔗 Husky path (relative to git root): ${relativePath}`);
+
+      // Check if husky is already configured
+      try {
+        const currentHooksPath = execSync('git config core.hooksPath', {
+          cwd: themeDir,
+          encoding: 'utf8',
+          stdio: ['pipe', 'pipe', 'pipe'],
+        }).trim();
+
+        if (currentHooksPath && !options.force) {
+          console.log(`\n✔ Husky is already configured.`);
+          console.log(`  Current hooks path: ${currentHooksPath}`);
+          console.log(`  Use --force to reconfigure.`);
+          return;
+        }
+      } catch {
+        // Not configured yet, continue
+      }
+
+      // Run husky from git root with the relative path
+      console.log('\n🚀 Initializing Husky...');
+
+      // Run husky with the relative path
+      try {
+        execSync(`npx husky ${relativePath}`, {
+          cwd: gitRoot,
+          stdio: 'inherit',
+        });
+      } catch (error) {
+        console.error('\n❌ Husky initialization failed.');
+        process.exit(1);
+      }
+
+
+      // Verify configuration
+      try {
+        const hooksPath = execSync('git config core.hooksPath', {
+          cwd: themeDir,
+          encoding: 'utf8',
+          stdio: ['pipe', 'pipe', 'pipe'],
+        }).trim();
+
+        console.log(`\n✅ Husky initialized successfully!`);
+        console.log(`   Git hooks path: ${hooksPath}`);
+        console.log(
+          `\n   Pre-commit hook will now protect core/ folder modifications.`,
+        );
+      } catch {
+        console.log(`\n✅ Husky initialized.`);
+      }
+    },
+  );
+}

package/lib/template/.nvmrc

@@ -1 +1 @@
-20.12.2
+24.11.1

package/lib/template/wp-config-custom.chisel-tpl.php

@@ -0,0 +1,117 @@
+<?php
+/**
+ * The base configuration for WordPress
+ *
+ * The wp-config.php creation script uses this file during the
+ * installation. You don't have to use the web site, you can
+ * copy this file to "wp-config.php" and fill in the values.
+ *
+ * This file contains the following configurations:
+ *
+ * * MySQL settings
+ * * Secret keys
+ * * Database table prefix
+ * * ABSPATH
+ *
+ * @link https://codex.wordpress.org/Editing_wp-config.php
+ *
+ * @package WordPress
+ */
+
+if ( file_exists( dirname( __FILE__ ) . '/wp-config-local.php' ) ) {
+
+	/**
+	 * Settings for local environment loaded if available from wp-config-local.php
+	 */
+
+	include dirname( __FILE__ ) . '/wp-config-local.php';
+
+} else {
+
+	/**
+	 * Settings for non-local environments, used when wp-config-local.php not available
+	 */
+
+	/** MySQL settings - You can get this info from your web host */
+
+	/** The name of the database for WordPress */
+	define( 'DB_NAME', $_SERVER['DB_NAME'] );
+
+	/** MySQL database username */
+	define( 'DB_USER', $_SERVER['DB_USER'] );
+
+	/** MySQL database password */
+	define( 'DB_PASSWORD', $_SERVER['DB_PASSWORD'] );
+
+	/** MySQL hostname */
+	define( 'DB_HOST', $_SERVER['DB_HOST'] );
+
+	/**
+	 * WordPress Database Table prefix.
+	 *
+	 * You can have multiple installations in one database if you give each
+	 * a unique prefix. Only numbers, letters, and underscores please!
+	 */
+	$table_prefix = '<%= tablePrefix %>';
+
+	/**
+	 * For developers: WordPress debugging mode.
+	 *
+	 * Change this to true to enable the display of notices during development.
+	 * It is strongly recommended that plugin and theme developers use WP_DEBUG
+	 * in their development environments.
+	 *
+	 * For information on other constants that can be used for debugging,
+	 * visit the Codex.
+	 *
+	 * @link https://codex.wordpress.org/Debugging_in_WordPress
+	 */
+	define( 'WP_DEBUG', false );
+
+	/** The Database Collate type. Don't change this if in doubt. */
+	define( 'DB_COLLATE', '' );
+
+	/** Disable the Plugin and Theme Editor */
+	define( 'DISALLOW_FILE_EDIT', true );
+}
+
+/**
+ * Configuration for all available environments
+ */
+
+/** Database Charset to use in creating database tables. */
+define( 'DB_CHARSET', 'utf8' );
+
+/**#@+
+ * Authentication Unique Keys and Salts.
+ *
+ * Change these to different unique phrases!
+ * You can generate these using the {@link https://api.wordpress.org/secret-key/1.1/salt/ WordPress.org secret-key service}
+ * You can change these at any point in time to invalidate all existing cookies. This will force all users to have to log in again.
+ *
+ * @since 2.6.0
+ */
+define('AUTH_KEY',         'put your unique phrase here');
+define('SECURE_AUTH_KEY',  'put your unique phrase here');
+define('LOGGED_IN_KEY',    'put your unique phrase here');
+define('NONCE_KEY',        'put your unique phrase here');
+define('AUTH_SALT',        'put your unique phrase here');
+define('SECURE_AUTH_SALT', 'put your unique phrase here');
+define('LOGGED_IN_SALT',   'put your unique phrase here');
+define('NONCE_SALT',       'put your unique phrase here');
+
+/**#@-*/
+
+/* That's all, stop editing! Happy blogging. */
+
+/** Hide PHP errors */
+if ( !WP_DEBUG ) {
+	ini_set( 'display_errors', 0 );
+}
+
+/** Absolute path to the WordPress directory. */
+if ( !defined('ABSPATH') )
+	define( 'ABSPATH', dirname(__FILE__) . '/' );
+
+/** Sets up WordPress vars and included files. */
+require_once( ABSPATH . 'wp-settings.php' );

package/lib/template/wp-config-local.chisel-tpl.php

@@ -57,8 +57,5 @@ define( 'WP_DEBUG_DISPLAY', false );
 define( 'SCRIPT_DEBUG', true );
 define( 'WP_ENVIRONMENT_TYPE', 'development' );
 
-// Icons module. Also requires packacke.json and scss configuration.
-define( 'CHISEL_USE_ICONS_MODULE', false );
-
 /** The Database Collate type. Don't change this if in doubt. */
 define( 'DB_COLLATE', '' );

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "chisel-scripts",
-  "version": "2.1.4",
+  "version": "2.2.0",
   "description": "Chisel scripts",
   "bin": {
     "chisel-scripts": "bin/chisel-scripts.js"
@@ -37,7 +37,7 @@
     "svgo": "^3.3.2"
   },
   "peerDependencies": {
-    "@wordpress/scripts": "^27.9.0 || ^31.0.0 || ^31.1.0"
+    "@wordpress/scripts": "^27.9.0 || ^31.0.0 || ^31.1.0 || ^31.2.0"
   },
-  "gitHead": "0e9815944ac4188917808f5f4ea981b853294708"
+  "gitHead": "259173a22a8cb7a7380936bfc01baf4b87f6afa3"
 }