@caweb/cli 1.0.5 → 1.2.0

package/lib/template/block/index.js.mustache

@@ -0,0 +1,40 @@
+/**
+ * Registers a new block provided a unique name and an object defining its behavior.
+ *
+ * @see https://developer.wordpress.org/block-editor/developers/block-api/#registering-a-block
+ */
+import { registerBlockType } from '@wordpress/blocks';
+
+/**
+ * Lets webpack process CSS, SASS or SCSS files referenced in JavaScript files.
+ * All files containing `style` keyword are bundled together. The code used
+ * gets applied both to the front of your site and to the editor. All other files
+ * get applied to the editor only.
+ *
+ * @see https://www.npmjs.com/package/@wordpress/scripts#using-css
+ */
+import './style.scss';
+import './editor.scss';
+
+/**
+ * Internal dependencies
+ */
+import Edit from './edit';
+import save from './save';
+import metadata from './block.json';
+
+/**
+ * Every block starts by registering a new block type definition.
+ *
+ * @see https://developer.wordpress.org/block-editor/developers/block-api/#registering-a-block
+ */
+registerBlockType( metadata.name, {
+	/**
+	 * @see ./edit.js
+	 */
+	edit: Edit,
+	/**
+	 * @see ./save.js
+	 */
+	save,
+} );

package/lib/template/block/save.js.mustache

@@ -0,0 +1,21 @@
+/**
+ * React hook that is used to mark the block wrapper element.
+ * It provides all the necessary props like the class name.
+ *
+ * @see https://developer.wordpress.org/block-editor/packages/packages-block-editor/#useBlockProps
+ */
+ import { InnerBlocks } from '@wordpress/block-editor';
+
+ /**
+  * The save function defines the way in which the different attributes should
+  * be combined into the final markup, which is then serialized by the block
+  * editor into `post_content`.
+  *
+  * @see https://developer.wordpress.org/block-editor/developers/block-api/block-edit-save/#save
+  *
+  * @return {WPElement} Element to render.
+  */
+ export default function save(props) {
+	 return <InnerBlocks.Content />;
+ }
+ 

package/lib/template/block/style.scss.mustache

@@ -0,0 +1,6 @@
+/**
+ * The following styles get applied both on the front of your site
+ * and in the editor.
+ *
+ * Replace them with your own styles or remove the file completely.
+ */

package/lib/template/index.cjs

@@ -0,0 +1,48 @@
+/**
+ * External dependencies
+ */
+const { join } = require( 'path' );
+const { capitalCase } = require( 'change-case' );
+
+/**
+ * Internal dependencies
+ */
+const blockSlug = process.argv[ 2 ];
+const blockSlugTitle = capitalCase( blockSlug );
+
+const customScripts = {};
+
+const npmDependencies = [ 
+	'@wordpress/icons@9.22.0' 
+];
+
+const npmDevDependencies = [];
+
+// assetsPath: join( __dirname, 'assets' ),
+module.exports = {
+	pluginTemplatesPath: join( __dirname, 'plugin' ),
+	blockTemplatesPath: join( __dirname, 'block' ),
+	defaultValues: {
+		pluginURI: `https://github.com/CAWebPublishing/${ blockSlug }`,
+		plugin: true,
+		description: `${ blockSlugTitle } Gutenberg Block`,
+		version: '1.2.0',
+		author: 'CAWebPublishing',
+		license: 'GPL-2.0-or-later',
+		licenseURI: 'https://www.gnu.org/licenses/gpl-2.0.html',
+		namespace: 'caweb',
+		category: 'cagov-design-system',
+		textdomain: 'cagov-design-system',
+		dashicon: 'format-aside',
+		supports: {
+			html: true,
+		},
+		attributes: {},
+		example: {
+			attributes: {}
+		},
+		customScripts: customScripts,
+		npmDependencies: npmDependencies,
+		npmDevDependencies: npmDevDependencies,
+	},
+};

package/lib/template/plugin/$slug.php.mustache

@@ -0,0 +1,135 @@
+<?php
+/**
+ * Plugin Name:       {{title}}
+{{#pluginURI}}
+ * Plugin URI:        {{{pluginURI}}}
+{{/pluginURI}}
+{{#description}}
+ * Description:       {{description}}
+{{/description}}
+ * Version:           {{version}}
+ * Requires at least: 6.2
+ * Requires PHP:      8.1
+{{#author}}
+ * Author:            {{author}}
+{{/author}}
+{{#license}}
+ * License:           {{license}}
+{{/license}}
+{{#licenseURI}}
+ * License URI:       {{{licenseURI}}}
+{{/licenseURI}}
+ * Text Domain:       {{textdomain}}
+{{#domainPath}}
+ * Domain Path:       {{{domainPath}}}
+{{/domainPath}}
+{{#updateURI}}
+ * Update URI:        {{{updateURI}}}
+{{/updateURI}}
+ *
+ * @package           cagov-design-system
+ */
+
+if ( ! defined('{{slugPascalCase}}_URI') ){
+	$cagov_design_system_{{slugSnakeCase}}_doc_root = isset( $_SERVER['DOCUMENT_ROOT'] ) ? sanitize_text_field( wp_unslash( $_SERVER['DOCUMENT_ROOT'] ) ) : '';
+	define( '{{slugPascalCase}}_URI', esc_url( str_replace( $cagov_design_system_{{slugSnakeCase}}_doc_root, '', __DIR__ ) ) );
+}
+
+if ( ! defined( 'CAGOV_DESIGN_SYSTEM_DEBUG' ) ) {
+	define( 'CAGOV_DESIGN_SYSTEM_DEBUG', false );
+}
+
+// Include {{title}} Core Functionality.
+foreach ( glob( __DIR__ . '/core/*.php' ) as $file ) {
+	require_once $file;
+}
+
+// Include {{title}} Functionality.
+foreach ( glob( __DIR__ . '/inc/*.php' ) as $file ) {
+	require_once $file;
+}
+
+/**
+ * Plugin API/Action Reference
+ * Actions Run During a Typical Request
+ *
+ * @link https://codex.wordpress.org/Plugin_API/Action_Reference#Actions_Run_During_a_Typical_Request
+ */
+add_action( 'init', 'cagov_design_system_{{slugSnakeCase}}_init' );
+add_action( 'wp_enqueue_scripts', 'cagov_design_system_{{slugSnakeCase}}_wp_enqueue_scripts' );
+
+if ( ! function_exists( 'cagov_design_system_{{slugSnakeCase}}_init' ) ) {
+	/**
+	 * {{title}} Initialization
+	 *
+	 * Fires after WordPress has finished loading but before any headers are sent.
+	 * Include Gutenberg Block assets by getting the index file of each block build file.
+	 *
+	 * @link https://developer.wordpress.org/reference/hooks/init/
+	 * @return void
+	 */
+	function cagov_design_system_{{slugSnakeCase}}_init() {
+		global $pagenow;
+
+		if ( ! function_exists( 'get_plugin_data' ) ) {
+			require_once ABSPATH . 'wp-admin/includes/plugin.php';
+		}
+
+		$version = get_plugin_data( __FILE__ )['Version'];
+
+		/**
+		* Enqueues the default ThickBox js and css. (if not on the login page or customizer page)
+		*
+		* @link https://developer.wordpress.org/reference/functions/add_thickbox/
+		*/
+		if ( ! in_array( $pagenow, array( 'wp-login.php', 'customize.php' ), true ) ) {
+			add_thickbox();
+		}
+
+		// if editing a page/post register compiled Gutenberg Block bundles.
+		if ( in_array( $pagenow, array( 'post.php', 'post-new.php' ), true ) ) {
+
+			wp_enqueue_style( 'cagov-design-system-{{slug}}', cagov_design_system_{{slugSnakeCase}}_get_min_file( '/css/{{slug}}.css' ), array(), $version );
+		}
+
+		$block_args = array(
+			'render_callback' => 'cagov_design_system_{{slugSnakeCase}}_block_renderer',
+		);
+
+		/**
+		 * Registers the block using the metadata loaded from the `block.json` file.
+		 * Behind the scenes, it registers also all assets so they can be enqueued
+		 * through the block editor in the corresponding context.
+		 *
+		 * @see https://developer.wordpress.org/reference/functions/register_block_type/
+		*/
+		register_block_type( __DIR__ . '/build', $block_args );
+	}
+}
+
+if ( ! function_exists( 'cagov_design_system_{{slugSnakeCase}}_wp_enqueue_scripts' ) ) {
+	/**
+	 * Register {{title}} scripts/styles
+	 *
+	 * Fires when scripts and styles are enqueued.
+	 *
+	 * @category add_action( 'wp_enqueue_scripts', 'cagov_design_system_{{slugSnakeCase}}_wp_enqueue_scripts' );
+	 * @link https://developer.wordpress.org/reference/hooks/wp_enqueue_scripts/
+	 *
+	 * @return void
+	 */
+	function cagov_design_system_{{slugSnakeCase}}_wp_enqueue_scripts() {
+
+		if ( ! function_exists( 'get_plugin_data' ) ) {
+			require_once ABSPATH . 'wp-admin/includes/plugin.php';
+		}
+
+		$version = get_plugin_data( __FILE__ )['Version'];
+
+		// Register compiled Gutenberg Block bundles.
+		wp_enqueue_script( 'cagov-design-system-{{slug}}', cagov_design_system_{{slugSnakeCase}}_get_min_file( '/js/{{slug}}.js', 'js' ), array(), $version, true );
+
+		wp_enqueue_style( 'cagov-design-system-{{slug}}', cagov_design_system_{{slugSnakeCase}}_get_min_file( '/css/{{slug}}.css' ), array(), $version );
+
+	}
+}

package/lib/template/plugin/core/cdec-api.php.mustache

@@ -0,0 +1,44 @@
+<?php
+/**
+ * {{title}} CDEC REST API
+ *
+ * @see https://cdec.water.ca.gov/resapp/
+ *
+ * @package cagov-design-system
+ */
+
+if ( ! function_exists( 'cagov_design_system_cdec_reservoir_conditions_api' ) ) {
+	/**
+	 * Retrieve data from the CDEC Reservoir API
+	 *
+	 * @see https://cdec.water.ca.gov/resapp/service/res/conditions
+	 * @param  string $station_id Major reservoirs station that were recommended by CDEC.
+	 * @return string
+	 */
+	function cagov_design_system_cdec_reservoir_conditions_api( $station_id = '' ) {
+		$result = 'No Results';
+
+		if ( empty( $station_id ) ) {
+			return $result;
+		}
+
+		$date = gmdate( 'Y-m-d' );
+
+		$url = "https://cdec.water.ca.gov/resapp/service/res/conditions?date=$date&stationIds=$station_id";
+
+		$args = array(
+			'headers' => array(
+				'Content-Type' => 'application/json',
+			),
+		);
+
+		$response = wp_remote_get( $url, $args );
+
+		if ( 200 === wp_remote_retrieve_response_code( $response ) ) {
+			$result = wp_remote_retrieve_body( $response );
+
+			return json_decode( $result, true )[0];
+		}
+
+	}
+}

package/lib/template/plugin/core/filters.php.mustache

@@ -0,0 +1,111 @@
+<?php
+/**
+ * {{title}} Filters
+ *
+ * @package cagov-design-system
+ */
+
+global $wp_version;
+
+$cagov_design_system_is_under_5_8 = version_compare( $wp_version, '5.8', '<' ) ? '' : '_all';
+
+add_filter( "block_categories$cagov_design_system_is_under_5_8", 'cagov_design_system_block_categories', 10, 2 );
+add_filter( 'script_loader_tag', 'cagov_design_system_{{slugSnakeCase}}_script_loader_tag', 10, 3 );
+add_filter( "allowed_block_types$cagov_design_system_is_under_5_8", 'cagov_design_system_allowed_block_types' );
+
+if ( ! function_exists( 'cagov_design_system_block_categories' ) ) {
+	/**
+	 * Register {{title}} Gutenberg Block categories to the Block editor
+	 *
+	 * @link https://developer.wordpress.org/reference/hooks/block_categories_all/
+	 *
+	 * @param  array                   $categories Array of categories for block types.
+	 * @param  WP_Block_Editor_Context $post The current block editor context.
+	 * @return array
+	 */
+	function cagov_design_system_block_categories( $categories, $post ) {
+		return array_merge(
+			array(
+				array(
+					'slug'  => 'cagov-design-system',
+					'title' => 'CA Design System',
+				),
+			),
+			array(
+				array(
+					'slug'  => 'cagov-data-viz',
+					'title' => 'CA Data Visualization',
+				),
+			),
+			$categories
+		);
+	}
+}
+
+if ( ! function_exists( 'cagov_design_system_allowed_block_types' ) ) {
+	/**
+	 * {{title}} Allowed Block Types
+	 *
+	 * Removes all blocks or patterns from Gutenberg and returns {{title}} Blocks.
+	 *
+	 * @link https://developer.wordpress.org/reference/hooks/allowed_block_types_all/
+	 *
+	 * @param  bool|array $allowed_blocks Array of block type slugs, or boolean to enable/disable all. Default true (all registered block types supported).
+	 * @return array
+	 */
+	function cagov_design_system_allowed_block_types( $allowed_blocks ) {
+
+		// if not debugging, return all blocks.
+		if ( ! CAGOV_DESIGN_SYSTEM_DEBUG ) {
+			return $allowed_blocks;
+		}
+
+		remove_theme_support( 'core-block-patterns' );
+
+		// Core Components.
+		$core = array(
+			'core/image',
+			'core/paragraph',
+			'core/button',
+			'core/table',
+			'core/heading',
+			'core/list',
+			'core/custom-html',
+			'core/classic',
+		);
+
+		// Dynamically get a list of the cagov-design-system blocks.
+		$cagov_blocks = array();
+		/*
+		array_map(
+			function( $b ) {
+				return 'cagov-design-system/' . basename( $b );
+			},
+			glob( '/blocks/*' )
+		);
+		*/
+
+		// Return the desired components.
+		return array_merge( $core, $cagov_blocks );
+	}
+}
+
+if ( ! function_exists( 'cagov_design_system_{{slugSnakeCase}}_script_loader_tag' ) ) {
+	/**
+	 * Filters the HTML script tag of an enqueued script.
+	 *
+	 * @param  mixed $tag The <script> tag for the enqueued script.
+	 * @param  mixed $handle The script's registered handle.
+	 * @param  mixed $src The script's source URL.
+	 * @return string
+	 */
+	function cagov_design_system_{{slugSnakeCase}}_script_loader_tag( $tag, $handle, $src ) {
+		// Register script as module.
+		if ( 'cagov-design-system-{{slug}}' === $handle ) {
+			$tag = sprintf( '<script type="module" id="cagov-design-system-{{slug}}-js" src="%1$s"></script>', $src );
+		}
+
+		return $tag;
+	}
+}
+

package/lib/template/plugin/core/functions.php.mustache

@@ -0,0 +1,25 @@
+<?php
+/**
+ * {{title}} Helper Functions
+ *
+ * @package cagov-design-system
+ */
+
+if ( ! function_exists( 'cagov_design_system_{{slugSnakeCase}}_get_min_file' ) ) {
+	/**
+	 * Load Minified Version of a file
+	 *
+	 * @param  string $f File to load.
+	 * @param  string $ext Extension of file, default css.
+	 *
+	 * @return string
+	 */
+	function cagov_design_system_{{slugSnakeCase}}_get_min_file( $f, $ext = 'css' ) {
+		// if not debugging and a minified version exists load it.
+		if ( ! CAGOV_DESIGN_SYSTEM_DEBUG && file_exists( __DIR__ . str_replace( ".$ext", ".min.$ext", $f ) ) ) {
+			return {{slugPascalCase}}_URI . str_replace( ".$ext", ".min.$ext", $f );
+		} else {
+			return {{slugPascalCase}}_URI . $f;
+		}
+	}
+}

package/lib/template/plugin/inc/renderer.php.mustache

@@ -0,0 +1,25 @@
+<?php
+/**
+ * {{title}} Dynamic Renderer Functions
+ *
+ * @package {{namespace}}
+ */
+
+if ( ! function_exists( 'cagov_design_system_{{slugSnakeCase}}_block_renderer' ) ) {
+	/**
+	 * Dynamic Renderer for {{title}} Block
+	 *
+	 * @see https://developer.wordpress.org/block-editor/how-to-guides/block-tutorial/creating-dynamic-blocks/
+	 *
+	 * @param array         $attributes Block attributes.
+	 * @param string        $content    Block content.
+	 * @param  WP_Block_Type $block Current Block Type.
+	 * @return string Rendered block type output.
+	 */
+	function cagov_design_system_{{slugSnakeCase}}_block_renderer( $attributes, $content, $block ) {
+
+		$output = sprintf( '<p>Render Block Output</p>' );
+
+		return $output;
+	}
+}

package/lib/utils.js

@@ -0,0 +1,150 @@
+/**
+ * External dependencies
+ */
+import { spawn } from 'node:child_process';
+import dockerCompose from 'docker-compose';
+import path from 'node:path';
+import loadConfig from '@wordpress/env/lib/config/load-config.js';
+import getHostUser from '@wordpress/env/lib/get-host-user.js';
+import { env } from 'node:process';
+
+
+/**
+ * Internal dependencies
+ */
+
+/**
+ * Runs commands on the given WordPress environment.
+ * 
+ * @param {string}		environment	Which environment to run docker command on.
+ * @param {string[]} 	cmds   		Array of commands to run.
+ * @param {WPConfig} 	config      The wp-env config object.
+ * @param {Object}   	spinner A CLI spinner which indicates progress.
+ * 
+ * @returns {Promise}
+ */
+async function runCLICmds(
+	environment,
+	cmds,
+	config,
+	spinner
+) {
+
+	// We return the promise whether there is an output or an error.
+	return await dockerCompose.run(
+			environment === 'development' ? 'cli' : 'tests-cli',
+			[ 'bash', '-c', cmds.join( ' && ' ) ],
+			{
+				cwd: config.workDirectoryPath,
+				commandOptions: [],
+				log: config.debug,
+				callback: (buffer, result) => {
+					if( config.debug ){
+						spinner.text = buffer.toString();
+					}
+				}
+			}
+		).then(
+			(output) => {
+				// Remove the Container information and new lines.
+				output.err = output.err.replace(/\s*Container .*Running\n|\n/g, '')
+				output.out = output.out.replace(/\s*Container .*Running\n|\n/g, '')
+
+				return '' !== output.out ? output.out : output.err;
+			},
+			(error) => {
+				// Remove the Container information and new lines.
+				error.err = error.err.replace(/\s*Container .*Running\n|\n/g, '')
+
+				return error;
+			}
+		);
+
+}
+
+/**
+ * Runs command directly.
+ * 
+ * @param {string} 		cmd		Command to run.
+ * @param {string[]} 	args	List of command arguments.
+ * @param {string[]}  opts   List of spawn options.
+ * @param {Object}   	spinner A CLI spinner which indicates progress.
+ * @param {boolean}  debug   True if debug mode is enabled.
+ * 
+ * @returns {Promise}
+ */
+async function runCmd(cmd, args,spinner, opts = { stdio: 'pipe' },  debug = false){
+	// fix various commands.
+	switch (cmd) {
+		case 'npm':
+		case 'npx':
+		/**
+		 * On Windows we run npm.cmd, on Linux we run npm
+		 */
+		cmd += /^win/.test(process.platform) ? '.cmd' : '';
+		break;
+	}
+
+	// save output for handling
+	let output = opts.stdio;
+
+	return  await new Promise( (resolve, reject) => {
+		let result = [];
+		const childProc = spawn(
+			cmd,
+			args,
+			{
+				...opts,
+				stdio: 'pipe' // output is always piped and handled when stdout receives data.
+			},
+			spinner
+	   	);
+
+		childProc.stdout.on( 'data', (data) => {
+			// remove new lines from data
+			data = data.toString().replace('\n', '');
+
+			// push all data to results array if piping data
+			if( '\n' !== data && '' !== data && data.length ){
+				// output accordingly.
+				switch( output ){
+					case 'initial': // write output to spinner text
+						spinner.text = data;
+					case 'inherit': // write output to persistent spinner text
+						spinner.stopAndPersist({
+							text: data
+						});
+						break;
+					case 'pipe': // save output to result array and output on exit
+					default:
+						result.push( data );
+						break;
+				}
+			}
+		});
+		
+		childProc.on( 'error', reject );
+		childProc.on( 'exit', ( code ) => {
+			// resolved with no issues return result array
+			if ( code === 0 ) {
+				resolve(result.join('\n'));
+				// if there was an error 
+			} else {
+				if( debug ){
+					// if debugging return exit code
+					reject( `Command failed with exit code ${ code }` );
+				}else{
+					// resolve as false.
+					resolve(false);
+				}
+			}
+		} );
+	   
+   });
+
+}
+
+export {
+	runCLICmds,
+	runCmd
+};