chisel-scripts 2.0.0-alpha.3.0 → 2.0.0-alpha.4

package/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 <!-- INSERT-NEW-ENTRIES-HERE -->
 
+## 2.0.0-alpha.4 (2024-11-12)
+
+- V2: Add Devcontainers (#538) ([b878421](https://github.com/xfiveco/generator-chisel/commit/b878421)), closes [#538](https://github.com/xfiveco/generator-chisel/issues/538)
+- composer, wp-config, plugins list updates ([642f983](https://github.com/xfiveco/generator-chisel/commit/642f983))
+
+## 2.0.0-alpha.3.1 (2024-10-31)
+
+- add assets index ([fed4fd3](https://github.com/xfiveco/generator-chisel/commit/fed4fd3))
+
 ## 2.0.0-alpha.3.0 (2024-10-07)
 
 - update chisel-scripts version ([2957e4c](https://github.com/xfiveco/generator-chisel/commit/2957e4c))

package/index.js

@@ -37,6 +37,29 @@ function adjustWebpackConfig(baseConfig, directory) {
     ...entriesFromFiles(stylesFiles),
   };
 
+  const getUrl = (() => {
+    let url;
+
+    return () =>
+      (url ||= (() => {
+        const { execFileSync } = require('node:child_process');
+        try {
+          const stdout = execFileSync(
+            'npm',
+            ['run', '--silent', 'wp', 'option', 'get', 'home'],
+            {
+              cwd: directory,
+              encoding: 'utf8',
+              shell: true,
+            },
+          );
+          return stdout.trim();
+        } catch (e) {
+          throw new Error('Failed to get current website url', { cause: e });
+        }
+      })());
+  })();
+
   const updatedConfig = {
     ...baseConfig,
     entry,
@@ -49,7 +72,33 @@ function adjustWebpackConfig(baseConfig, directory) {
     },
     devServer: baseConfig.devServer && {
       ...baseConfig.devServer,
-      allowedHosts: [new URL(packageJson.chisel.url).host],
+      allowedHosts: [new URL(getUrl()).host],
+      ...(process.env.CHISEL_PORT && {
+        host: '0.0.0.0',
+        port: Number(process.env.CHISEL_PORT) + 1,
+        ...(() => {
+          const webSocketURL = new URL(getUrl());
+          webSocketURL.protocol = webSocketURL.protocol.replace('http', 'ws');
+          webSocketURL.pathname = '/ws';
+          const webSocketURLString = webSocketURL.toString();
+
+          if (!webSocketURLString.includes(process.env.CHISEL_PORT)) {
+            return;
+          }
+
+          return {
+            client: {
+              ...baseConfig.devServer.client,
+              webSocketURL: webSocketURL
+                .toString()
+                .replace(
+                  process.env.CHISEL_PORT,
+                  Number(process.env.CHISEL_PORT) + 1,
+                ),
+            },
+          };
+        })(),
+      }),
     },
     optimization: {
       ...baseConfig.optimization,

package/lib/commands/wp-config.js

@@ -1,11 +1,21 @@
+const devContainerDefaultDatabaseCredentials = {
+  databaseHost: 'db',
+  databasePort: 3306,
+  databaseName: 'mariadb',
+  databaseUser: 'mariadb',
+  databasePassword: 'mariadb',
+};
+
 module.exports = (api, options) => {
   api.registerCommand(
     'wp-config',
     (command) =>
-      command.description(
-        'configure WP (writes wp/wp-config-local.php an dev-vhost.conf)',
-      ),
-    async () => {
+      command
+        .description(
+          'configure WP (writes wp/wp-config-local.php an dev-vhost.conf)',
+        )
+        .option('--devcontainer', 'use default database credentials', false),
+    async ({ devcontainer }) => {
       const { runLocal, copy } = require('chisel-shared-utils');
       const wp = (args, opts) =>
         runLocal(['chisel-scripts', 'wp', ...args], {
@@ -45,7 +55,9 @@ module.exports = (api, options) => {
       ];
 
       const promptAndCreateDB = async () => {
-        const answers = await inquirer.prompt(prompts);
+        const answers = devcontainer
+          ? devContainerDefaultDatabaseCredentials
+          : await inquirer.prompt(prompts);
 
         answers.databaseHostPort = `${answers.databaseHost}:${answers.databasePort}`;
 
@@ -54,15 +66,17 @@ module.exports = (api, options) => {
         console.log('Creating database...');
         console.log(api.resolve());
 
+        const templateData = {
+          ...answers,
+          documentRoot: api.resolveRoot(),
+          tablePrefix,
+          codespaces: process.env.CODESPACES === 'true',
+        };
+
         await copy({
           from: path.join(__dirname, '../template'),
           to: api.resolveRoot(),
-          templateData: {
-            ...answers,
-            documentRoot: api.resolveRoot(),
-            serverName: new URL(url).hostname,
-            tablePrefix,
-          },
+          templateData,
         });
 
         const res = await wp(['db', 'query', 'SELECT 1'], {
@@ -81,7 +95,7 @@ module.exports = (api, options) => {
             console.log(res.stderr);
             throw res;
           }
-        } else {
+        } else if (!devcontainer) {
           // exists
           const { useExisting } = await inquirer.prompt([
             {
@@ -99,16 +113,20 @@ module.exports = (api, options) => {
         }
       };
 
-      // eslint-disable-next-line no-constant-condition
-      while (true) {
-        try {
-          await promptAndCreateDB();
-          break;
-        } catch (e) {
-          console.log(e); // TODO: remove
-          console.log('');
-          console.log('Trying again...');
-          console.log('');
+      if (devcontainer) {
+        await promptAndCreateDB();
+      } else {
+        // eslint-disable-next-line no-constant-condition
+        while (true) {
+          try {
+            await promptAndCreateDB();
+            break;
+          } catch (e) {
+            console.log(e); // TODO: remove
+            console.log('');
+            console.log('Trying again...');
+            console.log('');
+          }
         }
       }
     },

package/lib/extensions/assets.mjs

@@ -0,0 +1,68 @@
+import { relative, join } from 'path';
+import { relative as relativePosix } from 'path/posix';
+import fastGlob from 'fast-glob';
+import fs from 'fs/promises';
+import { createHash } from 'crypto';
+import json2php from 'json2php';
+
+const { convertPathToPattern } = fastGlob;
+
+const hashesCache = {};
+
+export const build = async (api, { fromWatch = false } = {}) => {
+  const assetsDir = api.resolve('assets');
+  const assetsDirPattern = convertPathToPattern(assetsDir);
+  const pattern = assetsDirPattern + '/**';
+  const files = (
+    await fastGlob(pattern, {
+      onlyFiles: true,
+      stats: true,
+    })
+  ).sort((a, b) => a.path.localeCompare(b.path));
+  const hashesFile = join(assetsDir, 'hashes.php');
+  const hashesFilePattern = convertPathToPattern(hashesFile);
+
+  const hashes = {};
+
+  for (const file of files) {
+    if (file.path === hashesFilePattern) continue;
+
+    const id = `${file.path}-${file.stats.size}-${file.stats.mtimeMs}`;
+    const key = convertPathToPattern(relative(assetsDirPattern, file.path));
+
+    if (fromWatch) {
+      if (hashesCache[id]) {
+        hashes[key] = hashesCache[id];
+        continue;
+      }
+    }
+
+    const content = await fs.readFile(file.path);
+    const hash = createHash('md5').update(content).digest('hex');
+    hashes[key] = hash;
+    hashesCache[id] = hash;
+  }
+
+  const phpArray = json2php.make({ indent: '  ', linebreak: '\n' })(hashes);
+  const content = `<?php return ${phpArray};\n`;
+  await fs.writeFile(hashesFile, content);
+};
+
+export const start = async (api) => {
+  const { default: chokidar } = await import('chokidar');
+
+  const assetsDir = api.resolve('assets');
+  const hashesFile = join(assetsDir, 'hashes.php');
+  const pattern = convertPathToPattern(assetsDir);
+
+  const watcher = chokidar.watch(pattern, {
+    ignoreInitial: true,
+    awaitWriteFinish: true,
+  });
+  watcher.on('add', () => build(api, { fromWatch: true }));
+  watcher.on('unlink', () => build(api, { fromWatch: true }));
+  watcher.on('change', (file) => {
+    if (file === hashesFile) return;
+    build(api, { fromWatch: true });
+  });
+};

package/lib/template/dev-vhost.chisel-tpl.conf

@@ -1,6 +1,6 @@
 <VirtualHost *:80>
     DocumentRoot "<%= documentRoot %>"
-    ServerName <%= serverName %>
+    ServerName YOUR_LOCAL_WORDPRESS_DOMAIN
     <Directory "<%= documentRoot %>">
       AllowOverride All
       Require all granted

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

@@ -9,7 +9,11 @@
  * * External settings when needed
  *
  */
-
+<% if (codespaces) { %>
+// Adjustment for Codespaces
+$_SERVER['HTTPS'] = 'on';
+$_SERVER['HTTP_HOST'] = $_SERVER['HTTP_X_FORWARDED_HOST'];
+<% } %>
 // ** MySQL settings - You can get this info from your web host ** //
 /** The name of the database for WordPress */
 define( 'DB_NAME', '<%= databaseName %>' );
@@ -47,9 +51,9 @@ $table_prefix = '<%= tablePrefix %>';
 define( 'WP_DEBUG', true );
 define( 'WP_DEBUG_LOG', true );
 define( 'WP_DEBUG_DISPLAY', true );
-define( 'SCRIPT_DEBUG', true );
 
 // Required for the theme fast refresh mode.
+define( 'SCRIPT_DEBUG', true );
 define( 'WP_ENVIRONMENT_TYPE', 'development' );
 
 /** The Database Collate type. Don't change this if in doubt. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "chisel-scripts",
-  "version": "2.0.0-alpha.3.0",
+  "version": "2.0.0-alpha.4",
   "description": "TODO",
   "bin": {
     "chisel-scripts": "bin/chisel-scripts.js"
@@ -25,17 +25,18 @@
     "url": "https://github.com/xfiveco/generator-chisel/issues"
   },
   "dependencies": {
-    "chisel-shared-utils": "^2.0.0-alpha.0",
+    "chisel-shared-utils": "^2.0.0-alpha.1",
     "chokidar": "^3.6.0",
     "commander": "^5.1.0",
     "fast-glob": "^3.3.2",
     "fs-extra": "^9.0.1",
     "globby": "^11.0.1",
     "inquirer": "^7.1.0",
+    "json2php": "^0.0.9",
     "lodash": "^4.17.15"
   },
   "peerDependencies": {
     "@wordpress/scripts": "^27.9.0"
   },
-  "gitHead": "ad109c10db57cab568c05a4b9057004c3323c271"
+  "gitHead": "3209b735b8259ad3296f477cfe13ad3a14d130a9"
 }