@caweb/cli 1.5.0 → 1.5.2

package/lib/cli.js

@@ -1,7 +1,7 @@
 /**
  * External dependencies
  */
-
+//const wpenv_cli = require('@wordpress/env/lib/cli');
 import path from 'path';
 import fs from 'fs';
 import { Command, Argument, Option  } from 'commander';
@@ -39,13 +39,17 @@ const envArg = new Argument('[environment]', 'Which environment to use.')
 	])
 	.default('development');
 
+	
+/**
+ * Adds commands for webpack
+ */
 function addWebpackCmds(){
   
 	// Build Command.
 	program.command('build')
-  .description('Builds the current project.')
-  .allowUnknownOption(true)
-  .action(env.webpack)
+	.description('Builds the current project.')
+	.allowUnknownOption(true)
+	.action(env.webpack)
       
     
   // Serve Command.
@@ -127,6 +131,7 @@ function addWPEnvCommands(){
 
 	// Start command.
 	program.command('start')
+		.alias('launch')
 		.description(
 			`Starts two CAWebPublishing WordPress instances\ndevelopment on port http://localhost:8888 (override with WP_ENV_PORT)\ntests on port http://localhost:8889 (override with WP_ENV_TESTS_PORT).`
 		)
@@ -174,6 +179,7 @@ function addWPEnvCommands(){
 
 	// Destroy Command.
 	program.command('destroy')
+		.alias('shutdown')
 		.description(
 			'Deletes docker containers, volumes, and networks associated with the CAWebPublishing instances and removes local files.'
 		)
@@ -255,7 +261,6 @@ function addWPEnvCommands(){
 
 export default function cli() {
 
-
 	program
 		.name('caweb')
 		.usage( '<command>' )
@@ -301,15 +306,35 @@ export default function cli() {
   // Update a Design System Block Command.
   program.command('sync')
     .description('Sync changes from one WordPress instance to another.')
-    .argument('<from>', 'Target Site URL.')
-    .argument('<to>', 'Destination Site URL.')
+    .argument('[target]', 'Target Site URL.')
+    .argument('[dest]', 'Destination Site URL.')
+	.addOption(new Option(
+		'--interactive',
+		'Runs the sync process with prompts'
+	))
+    .addOption(
+		new Option(
+      		'-t,--tax <tax...>',
+      		'Taxonomy that should be synced. Default is full site sync.'
+    	)
+		.choices(['media', 'menus', 'pages', 'posts', 'settings'])
+		.default(['media', 'menus', 'pages', 'posts', 'settings'])
+	)
     .addOption(new Option(
-      '-t,--tax [tax...]',
-      'Taxonomy that should be synced. Omitting this option will sync the full site.'
-    ).choices(['pages', 'posts', 'media', 'menus', 'settings']))
+      '--media-ids <ids...>',
+      'Sync specific Media IDs.'
+    ))
+    .addOption(new Option(
+      '--menu-ids <ids...>',
+      'Sync specific Menu IDs.'
+    ))
+    .addOption(new Option(
+      '--page-ids <ids...>',
+      'Sync specific Page IDs.'
+    ))
     .addOption(new Option(
-      '-i,--include [include...]',
-      'IDs to of taxonomies to include. Omitting this option will sync all items for given taxonomy.'
+      '--post-ids <ids...>',
+      'Sync specific Post IDs.'
     ))
     .allowUnknownOption(true)
     .action( withSpinner(env.sync) )

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@caweb/cli",
-  "version": "1.5.0",
+  "version": "1.5.2",
   "description": "CAWebPublishing Command Line Interface.",
   "exports": "./lib/env.js",
   "type": "module",
@@ -56,15 +56,17 @@
     }
   },
   "dependencies": {
-    "@caweb/webpack": "^1.0.0",
-    "@wordpress/create-block": "^4.45.0",
-    "@wordpress/env": "^10.2.0",
+    "@caweb/webpack": "^1.0.2",
+    "@inquirer/prompts": "^5.1.3",
+    "@wordpress/create-block": "^4.46.0",
+    "@wordpress/env": "^10.3.0",
     "axios": "^1.7.2",
     "axios-retry": "^4.4.1",
     "chalk": "^5.3.0",
     "commander": "^12.1.0",
     "cross-spawn": "^7.0.3",
     "docker-compose": "^0.24.8",
+    "inquirer-select-pro": "^1.0.0-alpha.6",
     "ora": "^8.0.1",
     "resolve-bin": "^1.0.1",
     "terminal-link": "^3.0.0"

package/commands/sync.js

@@ -1,402 +0,0 @@
-/**
- * External dependencies
- */
-import path from 'path';
-import fs from 'fs';
-import loadConfig from '@wordpress/env/lib/config/load-config.js';
-import axios from 'axios';
-
-/**
- * Internal dependencies
- */
-import {
-	appPath,
-    getTaxonomies,
-    createTaxonomies
-} from '../lib/index.js';
-
-const errors = [];
-
-/**
- * Return all parent items for a given set of ids.
- *
- * @async
- * @param {Array} ids
- * @param {*} request
- * @param {string} [tax='pages']
- * @returns {unknown}
- */
-async function getParentItems( objects, request, tax = 'pages' ){
-    let parentItemsObjects = [];
-    let objectParentIds = objects.map((obj) => { return obj.parent; }).filter(n => n);
-
-    while( objectParentIds.length > 0 ){
-
-        // if we have parent ids, we have to collect any parent items.
-        let parentItems = await getTaxonomies({
-            ...request, 
-            orderby: 'parent',
-            embed: true,
-            include: objectParentIds
-        }, tax);
-
-        // if we have parent items, we have to add to the items array.
-        if( parentItems ){
-            parentItemsObjects = parentItemsObjects.concat( parentItems );
-        }
-
-        // if the parent items have parent ids, we have to save those for the next run.
-        objectParentIds = parentItems.map((obj) => { return obj.parent; }).filter((id) => { return id !== 0; })   
-    }
-
-    return objects.concat( parentItemsObjects ).sort( (a,b) => a.parent - b.parent );
-}
-
-/**
- * Sync Environments.
- * 
- * @see https://developer.wordpress.org/rest-api/reference/
- * 
- * @param {Object}  options
- * @param {Object}  options.spinner A CLI spinner which indicates progress.
- * @param {boolean} options.from   Remote Site URL with current changes.
- * @param {boolean} options.to   Destination Site URL that should be synced.
- * @param {boolean} options.debug   True if debug mode is enabled.
- * @param {Array} options.tax   Taxonomy that should be synced.
- * @param {Array} options.include   Include specific IDs only.
- */
-export default async function sync({
-	spinner,
-	debug,
-	from,
-    to,
-    tax,
-    include
-} ) {
-
-    const localFile = path.join(appPath, 'caweb.json');
-    const {workDirectoryPath} = await loadConfig(path.resolve('.'));
-
-    process.env.WP_CLI_CONFIG_PATH  = path.join(workDirectoryPath, 'config.yml');
-    
-    // if caweb.json file doesn't exist we don't do anything
-    if( ! fs.existsSync(localFile) ){
-        spinner.fail('caweb.json file not found.')
-        process.exit(1)
-    }
-
-    // read configuration file
-    const serviceConfig = JSON.parse( fs.readFileSync(localFile) );
-
-    /**
-     * make sure instances are in the file.
-     * must have sync property
-     * each instance has to have a url, user, pwd property
-     */
-    if( 
-        ! serviceConfig.sync || 
-        ! serviceConfig.sync[from] ||
-        ! serviceConfig.sync[from].url ||
-        ! serviceConfig.sync[from].user ||
-        ! serviceConfig.sync[from].pwd ||
-        ! serviceConfig.sync[to] || 
-        ! serviceConfig.sync[to].url ||
-        ! serviceConfig.sync[to].user ||
-        ! serviceConfig.sync[to].pwd
-    ){
-        spinner.fail(`caweb.json is not configured properly for ${from} and ${to}.`);
-        process.exit(1)
-    }
-    
-    // get instance data
-    from = serviceConfig.sync[from];
-    let fromOptions = {
-        url: from.url,
-        headers: {
-            Authorization: 'Basic ' + Buffer.from(`${from.user}:${from.pwd}`).toString('base64')
-        }
-    }
-    
-
-    to = serviceConfig.sync[to];
-
-    let toOptions = {
-        url: to.url,
-        headers: {
-            Authorization: 'Basic ' + Buffer.from(`${to.user}:${to.pwd}`).toString('base64'),
-            'content-type': 'multipart/form-data',
-            'accept': '*/*'
-        }
-    }
-
-    /**
-     * Sync Process 
-     * If taxonomy is undefined then we don't sync that section.
-     * 
-     * 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 = [];
-    let menus = [];
-    let menuNavItems = [];
-
-    // Media Library.
-    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') ){
-        spinner.text = `Collecting Site Settings from ${from.url}`;
-        settings = await getTaxonomies({
-            ...fromOptions,
-            fields: [
-                'title',
-                'description',
-                'show_on_front',
-                'page_on_front',
-                'posts_per_page'
-            ],
-        }, 'settings')
-        
-    }
-
-    // Pages.
-    if( undefined === tax || tax.includes('pages') ){
-        // get all pages/posts
-        spinner.text = `Collecting pages from ${from.url}`;
-        pages = await getTaxonomies({
-                ...fromOptions, 
-                orderby: 'parent',
-                embed: true,
-                include: tax && include ? include.join(',') : null
-            }, 
-            'pages'
-        );
-
-        // we only do this if specific ids were requested.
-        if( include ){
-            // if we have parent ids, we have to collect any parent items.
-            pages = await getParentItems( 
-                pages, 
-                fromOptions, 
-                'pages'
-            ) 
-        }
-    }
-
-    // Posts.
-    if( undefined === tax || tax.includes('posts') ){
-        // get all pages/posts
-        spinner.text = `Collecting all posts from ${from.url}`;
-        posts = await getTaxonomies({
-                ...fromOptions, 
-                orderby: 'parent',
-                include: tax && include ? include.join(',') : null
-            }, 
-            'posts'
-        );
-
-        // we only do this if specific ids were requested.
-        if( include ){
-            // if we have parent ids, we have to collect any parent items.
-            posts = await getParentItems( 
-                posts, 
-                fromOptions, 
-                'posts'
-            ) 
-        }
-    }
-
-    /**
-     * Media Library Handling
-     * 
-     * We iterate thru the media library to identify which media should be synced.
-     * 1) attached media items by default are only possible on pages.
-     * 2) featured media by default are only possible on posts.
-     * 3) save any linked media in the content of pages and posts.
-     */
-    for( let m of mediaLibrary ){
-        // remove any new line characters.
-        m.source_url = m.source_url.replace('\n','');
-
-        // check if the media is attached to a page.
-        // if tax is undefined, we collect all media attached to posts and pages.
-        // if tax is defined, if include is undefined or media is matches post/page, we collect the media.
-        if( ( ! tax && m.post ) ||
-            ( tax && 
-                ( undefined === include || include.includes( m.id.toString() ) )
-            ) ){
-            media.push( m );
-
-            // we don't have to check any further.
-            continue;
-        }
-
-        for( let p of [].concat( pages, posts ) ){
-            // if the media is featured on a post or linked in the content.
-            if( p.featured_media === m.id ||
-                p.content.rendered.match( new RegExp(`src=”(${m.source_url}.*)”`, 'g') )){
-                    media.push( m );
-                }
-        }
-    }
-
-    // filter any duplicate media.
-    media = media.filter((m, index, self) => { return index === self.findIndex((t) => { return t.id === m.id; })} );
-    let i = 0;
-    
-    // before we can upload media files we have to generate the media blob data.
-    for( let m of media ){
-        if( debug ){
-            i++;
-            spinner.info(`Media ID ${m.id} Collected: ${i}/${media.length}`)
-        }
-        
-        const mediaBlob = await axios.request( 
-            {
-                ...fromOptions,
-                url: m.source_url,
-                responseType: 'arraybuffer'
-            } 
-        )
-        .then( (img) => {  return new Blob([img.data]) })
-        .catch( (error) => {
-            errors.push(`${m.source_url} could not be downloaded.`)
-            return false;
-        });
-        
-        if( mediaBlob ){
-            m.data = mediaBlob;
-        }
-    }
-    
-    // this has to be done after we have the media data.
-    // Lets replace the url references in the content of the pages and posts.
-    for( let p of [].concat( pages, posts ) ){
-        p.content.rendered = p.content.rendered.replace( new RegExp(from.url, 'g'), to.url );
-    }
-
-    
-    // Menu and Nav Items.
-    if( undefined === tax || tax.includes('menus')){
-        spinner.text = `Collecting assigned navigation menus from ${from.url}`;
-        // get all menus and navigation links
-        menus = await getTaxonomies({
-            ...fromOptions,
-            fields: [
-                'id',
-                'description',
-                'name',
-                'slug',
-                'meta',
-                'locations'
-            ],
-            include: tax && include ? include.join(',') : null
-            }, 'menus');
-    
-        menuNavItems = await getTaxonomies( 
-            {
-                ...fromOptions,
-                fields: [
-                    'id',
-                    'title',
-                    'url',
-                    'status',
-                    'attr_title',
-                    'description',
-                    'type',
-                    'type_label',
-                    'object',
-                    'object_id',
-                    'parent',
-                    'menu_order',
-                    'target',
-                    'classes',
-                    'xfn',
-                    'meta',
-                    'menus'
-                ],
-                menus: menus.map((menu) => { return menu.id; })
-            }, 
-            'menu-items'
-            )
-
-    }
-
-    /**
-     * Now we have all the data we can begin to create the taxonomies on the target.
-     * 
-     * Import Order is important otherwise missing dependencies will cause errors to trigger
-     * 1) Media
-     * 2) Pages
-     * 3) Posts
-     * 4) Menus & Navigation Links
-     * 5) Settings
-     */
-
-    // Media.
-    if( media ){
-        spinner.text = `Uploading media files to ${to.url}`;
-        await createTaxonomies(
-            media.filter((img) => { return img.data }), 
-            toOptions, 
-            'media', 
-            spinner
-            )
-    }
-
-     // Pages.
-    if( pages ){
-        spinner.text = `Creating all pages to ${to.url}`;
-        await createTaxonomies( pages, toOptions, 'pages', spinner );
-    }
-
-     // Posts.
-    if( posts ){
-        spinner.text = `Creating all posts to ${to.url}`;
-        await createTaxonomies( posts, toOptions, 'posts', spinner );
-    }
-
-    // Menus and Navigation Links.
-    if( menus ){
-        spinner.text = `Reconstructing navigation menus to ${to.url}`;
-        await createTaxonomies(menus, toOptions, 'menus', spinner);
-        await createTaxonomies(menuNavItems, toOptions, 'menu-items', spinner);
-    }
-    
-
-    // Settings.
-    if( settings ){
-        spinner.text = `Updating site settings to ${to.url}`;
-        await createTaxonomies(settings, toOptions, 'settings', spinner);
-    }
-
-    spinner.text = `Sync from ${from.url} to ${to.url} completed successfully.`
-
-};