@caweb/cli 1.3.11 → 1.3.13

package/commands/blocks/create-block.js

@@ -11,9 +11,6 @@ import inquirer from 'inquirer';
 import {runCmd, projectPath} from '../../lib/index.js';
 import updateBlock from './update-block.js';
 
-const localFile = path.join(projectPath, 'package.json');
-const pkg = JSON.parse( fs.readFileSync(localFile) );
-
 /**
  * Get NPM Package Latest Version
  * @param {string}  options.slug   Block slug.
@@ -26,9 +23,10 @@ async function getNPMPackageVersion(pkg, spinner){
 			'view',
 			`${pkg}`,
 			'version'
-		],
-		spinner
-	)
+		]
+	).then(({stdout, stderr}) => {
+		return ! stdout.toString() ? false : stdout.toString();
+	})
 	
 }
 
@@ -45,6 +43,8 @@ export default async function createBlock({
 	debug,
 	slug
 } ) {
+		spinner.stop();
+
 		// if block directory already exists.	
 		if( fs.existsSync(path.resolve(process.cwd(), slug)) ){
 			spinner.info(`${slug} already exists.`)
@@ -75,7 +75,6 @@ export default async function createBlock({
 					slug,
 					'--template=' + path.join(projectPath, 'template', 'index.cjs')
 				],
-				spinner,
 				{
 					stdio: 'inherit'
 				}
@@ -93,7 +92,6 @@ export default async function createBlock({
 						'install',
 						`@cagov/${slug}@${version}`,
 					],
-					spinner,
 					{
 						cwd: path.join(process.cwd(), slug ),
 						stdio: 'inherit'

package/commands/blocks/update-block.js

@@ -2,13 +2,27 @@
  * External dependencies
  */
 import path from 'path';
-import fs from 'fs';
+import fs from 'fs-extra';
 
 /**
  * Internal dependencies
  */
+import {runCmd} from '../../lib/index.js';
 import createBlock from './create-block.js';
 
+/**
+ * Returns the WordPress Plugin Header.
+ * 
+ * @param {String} content Content to search for plugin header.
+ * @returns String
+ */
+function getPluginHeader( content ){
+	return content.substring(
+		content.indexOf('<?php') + '<?php'.length,
+		content.indexOf('*/') + '*/'.length
+	)
+}
+
 /**
  * Update Block
  * 
@@ -22,10 +36,10 @@ export default async function updateBlock({
 	debug,
 	slug
 } ) {
-	
 		// if block directory exists.	
 		if( fs.existsSync(path.resolve(process.cwd(), slug)) ){
-			spinner.text = `Updating ${slug} block plugin.`;
+			console.log( `Updating ${slug} block plugin.` );
+			//spinner.text = `Updating ${slug} block plugin.`;
 
 			// make tmp directory
 			fs.ensureDir( `${slug}.tmp`);
@@ -36,6 +50,12 @@ export default async function updateBlock({
 			// move src directory to tmp directory
 			fs.copySync(`${slug}/src/`, `${slug}.tmp/src/`);
 
+			// move package.json to tmp directory
+			fs.copySync(`${slug}/package.json`, `${slug}.tmp/package.json`);
+
+			// move plugin main entry file to tmp directory
+			fs.copySync(`${slug}/${slug}.php`, `${slug}.tmp/${slug}.php`);
+
 			// delete old block.
 			fs.removeSync( `${slug}` );
 
@@ -48,10 +68,94 @@ export default async function updateBlock({
 			// move src directory back to block directory
 			fs.copySync(`${slug}.tmp/src/`, `${slug}/src/`);
 
+			// we get new and old package.json files
+			let oldPkg = JSON.parse( fs.readFileSync(path.join(`${slug}.tmp`, 'package.json')) )			
+			let newPkg = JSON.parse( fs.readFileSync(path.join(slug, 'package.json')) )			
+			
+			/**
+			 * 
+			 * @since 1.3.0 Gulp is no longer used.
+			 */
+			if( oldPkg.version < '1.3.0' ){
+
+				// remove the old postbuild script. 
+				if( oldPkg.scripts.postbuild && 'gulp build' ===  oldPkg.scripts.postbuild ){
+					delete oldPkg.scripts.postbuild;
+				}
+	
+				// remove old gulp related packages
+				for(const i in oldPkg.devDependencies ){
+					if( [
+							'del', 'fancy-log', 'gulp', 'gulp-cli', 'gulp-concat', 'gulp-file', 'gulp-line-ending-corrector',
+							'gulp-sass', 'gulp-tap', 'gulp-uglify-es', 'sass'
+						].includes( i ) ){
+						delete oldPkg.devDependencies[i]
+					}
+				}
+			}	
+			
+			// we only need the dependencies and devDependencies updated.
+			fs.writeFileSync(
+				path.join(slug, 'package.json'),
+				JSON.stringify( {
+					...oldPkg,
+					dependencies: {
+						...oldPkg.dependencies,
+						...newPkg.dependencies,
+					},
+					devDependencies: {
+						...oldPkg.devDependencies,
+						...newPkg.devDependencies,
+					}
+				}, null, 4 )
+			);
+
+			let oldEntry = fs.readFileSync(path.join(`${slug}.tmp`, `${slug}.php`)).toString()
+			let oldHeader = getPluginHeader(oldEntry);
+			let newEntry = fs.readFileSync(path.join(slug, `${slug}.php`)).toString();
+			let newHeader = getPluginHeader(newEntry);
+
+			// we dont want to update the header case changes we made.
+			// we only update the plugin headers require fields.
+			let correctedHeader = oldHeader
+				.replace(/Requires at .*/, newHeader.match(/Requires at .*/) )
+				.replace(/Requires PHP.*/, newHeader.match(/Requires PHP.*/) )
+
+			// replace the header in the new entry with the corrected header and write the file back
+			fs.writeFileSync(
+				path.join(slug, `${slug}.php`),
+				newEntry.replace(newHeader, correctedHeader)
+			);
+
 			// delete tmp directory.
 			fs.removeSync( `${slug}.tmp` );
 
-			spinner.succeed(`${slug} has been updated!`); 
+			// install block npm packages
+			await runCmd(
+				'npm',
+				[
+					'install',
+				],
+				{
+					cwd: path.join(process.cwd(), slug ),
+					stdio: 'inherit'
+				}
+			)
+
+			// build block 
+			await runCmd(
+				'npm',
+				[
+					'run',
+					'build',
+				],
+				{
+					cwd: path.join(process.cwd(), slug ),
+					stdio: 'inherit'
+				}
+			)
+
+			spinner.text = `${slug} has been updated!`; 
 
 		}else{
 			spinner.fail(`${slug} plugin directory not found.`)

package/commands/build.js

@@ -68,6 +68,13 @@ export default async function build({
     await runCmd(
 		'webpack', 
 		webPackArgs, 
-	)
+	).then(({stdout, stderr}) => {
+        // if an error was thrown, and no output
+        if( stderr && ! stdout.toString() ){
+            console.log( stderr.toString() )
+        }else{
+            spinner.text = 'Done'
+        }
+    });
 
 };

package/commands/sync.js

@@ -133,14 +133,15 @@ export default async function sync({
      * Sync Process 
      * If taxonomy is undefined then we don't sync that section.
      * 
-     * 1) Site Settings are always synced.
-     * 2) We always collect all the media.
+     * 1) We collect media if the taxonomy is undefined or includes media, pages, posts.
+     * 2) We only collect settings if the taxonomy is undefined or it's set to settings.
      * 3) We only collect pages if the taxonomy is undefined or it's set to pages.
      * 4) We only collect posts if the taxonomy is undefined or it's set to posts.
      * 5) We only collect menus if the taxonomy is undefined or it's set to menus.
      *    - We also collect menu items if menus are collected.
      */
     let settings = [];
+    let mediaLibrary = [];
     let media = [];
     let pages = [];
     let posts = [];
@@ -148,24 +149,26 @@ export default async function sync({
     let menuNavItems = [];
 
     // Media Library.
-    spinner.text = `Collecting Media Library ${from.url}`;
-    let mediaLibrary = await getTaxonomies({ 
-            ...fromOptions, 
-            fields: [
-                'id', 
-                'source_url', 
-                'title', 
-                'caption', 
-                'alt_text', 
-                'date',
-                'mime_type',
-                'post',
-                'media_details'
-            ],
-            include: tax && tax.includes('media') && include ? include.join(',') : null
-        }, 
-        'media'
-    );
+    if( undefined === tax || tax.includes('media', 'pages', 'posts') ){
+        spinner.text = `Collecting Media Library ${from.url}`;
+        mediaLibrary = await getTaxonomies({ 
+                ...fromOptions, 
+                fields: [
+                    'id', 
+                    'source_url', 
+                    'title', 
+                    'caption', 
+                    'alt_text', 
+                    'date',
+                    'mime_type',
+                    'post',
+                    'media_details'
+                ],
+                include: tax && tax.includes('media') && include ? include.join(',') : null
+            }, 
+            'media'
+        );
+    }
 
     // Site Settings.
     if( undefined === tax || tax.includes('settings') ){
@@ -339,7 +342,6 @@ export default async function sync({
                     'meta',
                     'menus'
                 ],
-                include: tax && include ? include.join(',') : null,
                 menus: menus.map((menu) => { return menu.id; })
             }, 
             'menu-items'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@caweb/cli",
-  "version": "1.3.11",
+  "version": "1.3.13",
   "description": "CAWebPublishing Command Line Interface.",
   "exports": "./lib/env.js",
   "type": "module",
@@ -40,7 +40,6 @@
   "config": {
     "WP_VER": "6.4.3",
     "PHP_VER": "8.1",
-    "CREATE_BLOCK_VER": "4.32.0",
     "DEFAULTS": {
       "FS_METHOD": "direct",
       "WP_DEBUG": true,
@@ -57,6 +56,7 @@
     }
   },
   "dependencies": {
+    "@wordpress/create-block": "^4.32.0",
     "@wordpress/env": "^9.6.0",
     "@wordpress/scripts": "^27.5.0",
     "accessibility-checker": "^3.1.68",
@@ -68,6 +68,7 @@
     "cross-spawn": "^7.0.3",
     "css-loader": "^6.10.0",
     "docker-compose": "^0.24.7",
+    "fs-extra": "^11.2.0",
     "handlebars-loader": "^1.7.3",
     "html-to-json-parser": "^2.0.1",
     "html-webpack-plugin": "^5.6.0",

package/template/index.cjs

@@ -13,10 +13,12 @@ const blockSlugTitle = capitalCase( blockSlug );
 const customScripts = {};
 
 const npmDependencies = [ 
-	'@wordpress/icons@9.22.0' 
+	'@wordpress/icons@9.44.0' 
 ];
 
-const npmDevDependencies = [];
+const npmDevDependencies = [
+	'@wordpress/scripts@27.6.0'
+];
 
 // assetsPath: join( __dirname, 'assets' ),
 module.exports = {
@@ -26,7 +28,7 @@ module.exports = {
 		pluginURI: `https://github.com/CAWebPublishing/${ blockSlug }`,
 		plugin: true,
 		description: `${ blockSlugTitle } Gutenberg Block`,
-		version: '1.2.0',
+		version: '1.3.0',
 		author: 'CAWebPublishing',
 		license: 'GPL-2.0-or-later',
 		licenseURI: 'https://www.gnu.org/licenses/gpl-2.0.html',