📖 DOC: Refactor JSDoc

Author: ahmadawais

packages/cgb-scripts/template/src/block/block.js

@@ -6,8 +6,8 @@
  */
 
 //  Import CSS.
-import './style.scss';
 import './editor.scss';
+import './style.scss';
 
 const { __ } = wp.i18n; // Import __() from wp.i18n
 const { registerBlockType } = wp.blocks; // Import registerBlockType() from wp.blocks
@@ -43,8 +43,11 @@ registerBlockType( 'cgb/block-<% blockName %>', {
 	 * The "edit" property must be a valid function.
 	 *
 	 * @link https://wordpress.org/gutenberg/handbook/block-api/block-edit-save/
+	 *
+	 * @param {Object} props Props.
+	 * @returns {Mixed} JSX Component.
 	 */
-	edit: function( props ) {
+	edit: ( props ) => {
 		// Creates a <p class='wp-block-cgb-block-<% blockName %>'></p>.
 		return (
 			<div className={ props.className }>
@@ -71,10 +74,13 @@ registerBlockType( 'cgb/block-<% blockName %>', {
 	 * The "save" property must be specified and must be a valid function.
 	 *
 	 * @link https://wordpress.org/gutenberg/handbook/block-api/block-edit-save/
+	 *
+	 * @param {Object} props Props.
+	 * @returns {Mixed} JSX Frontend HTML.
 	 */
-	save: function( props ) {
+	save: ( props ) => {
 		return (
-			<div>
+			<div className={ props.className }>
 				<p>— Hello from the frontend.</p>
 				<p>
 					CGB BLOCK: <code><% blockName %></code> is a new Gutenberg block.

packages/cgb-scripts/template/src/init.php

@@ -53,14 +53,14 @@ function <% blockNamePHPLower %>_cgb_block_assets() { // phpcs:ignore
 		null // filemtime( plugin_dir_path( __DIR__ ) . 'dist/blocks.editor.build.css' ) // Version: File modification time.
 	);
 
-	// Localised globals. Use dynamic PHP stuff in JavaScript via `cgbGlobal object.
+	// Localized globals. Use dynamic PHP stuff in JavaScript via `cgbGlobal` object.
 	wp_localize_script(
 		'<% blockNamePHPLower %>-cgb-block-js',
 		'cgbGlobal', // Array containing dynamic data for a JS Global.
 		[
 			'pluginDirPath' => plugin_dir_path( __DIR__ ),
 			'pluginDirUrl'  => plugin_dir_url( __DIR__ ),
-			// Add more data here that you want to access from cgbGlobal object.
+			// Add more data here that you want to access from `cgbGlobal` object.
 		]
 	);