@caweb/cli 1.15.16 → 1.15.18

package/commands/gen-scripts.js

@@ -38,12 +38,13 @@ export default async function genScripts({
 			"caweb": "caweb",
 			"create-site": "caweb create-site",
 			"serve": "caweb serve",
+			"serve:no-audit": "caweb serve --no-audit --no-jshint --no-a11y",
 			"build": "caweb build",
 			"convert-site": "caweb convert-site",
 			"launch": "caweb launch",
 			"launch:multi": "caweb launch --multisite",
 			"launch:multi:subdomain": "caweb launch --multisite --subdomain",
-			"launch:sync": "caweb launch --sync --update",
+			"launch:sync": "caweb launch --sync",
 			"launch:update": "caweb launch --update",
 			"stop": "caweb stop",
 			"shutdown": "caweb destroy",

package/commands/sites/convert-site.js

@@ -623,6 +623,13 @@ function generateShortcodes( mainContent,  opts = {
 			// all theses elements can go in other modules
 			// they also need to be added to the allowedModules list
 			case 'a':
+				// if the element first child is an image
+				if( content[0] && content[0].rawTagName === 'img' ) {
+					// add the anchors attributes to the image
+					content[0].rawAttrs = content[0].rawAttrs + ' ' + rawAttrs;
+					output += generateModuleShortcode('image', content[0] );
+					break;
+				}
 			case 'b':
 			case 'p':
 			case 'ol':
@@ -809,17 +816,20 @@ function generateModuleShortcode(module, element  ){
 	let attrs = {};
 	let moduleName = 'et_pb_' + module;
 
+	// commonly named attributes can be declared here to avoid repetition
+	let header, title, img;
+
 	switch( module ) {
-		case 'blurb': {
+		case 'blurb': 
 			/**
 			 * if blurb module is requested
 			 * we try and make the shortcode as if the element
 			 * was made with a Card Component
 			 */
 
-			let header = element.querySelector('.card-header');
-			let title = element.querySelector('.card-title');
-			let img = element.children.filter( c => c.tagName.toLowerCase() === 'img' );
+			header = element.querySelector('.card-header');
+			title = element.querySelector('.card-title');
+			img = element.children.filter( c => c.tagName.toLowerCase() === 'img' );
 			
 			content = element.querySelector('.card-body');
 
@@ -887,14 +897,14 @@ function generateModuleShortcode(module, element  ){
 				}
 			}
 			break;
-		}
-		case 'ca_card': {
+		
+		case 'ca_card': 
 			/**
 			 * if card module is requested
 			 */
-			let header = element.querySelector('.card-header');
-			let title = element.querySelector('.card-title');
-			let img = element.children.filter( c => c.tagName.toLowerCase() === 'img' );
+			header = element.querySelector('.card-header');
+			title = element.querySelector('.card-title');
+			img = element.children.filter( c => c.tagName.toLowerCase() === 'img' );
 			let layout = element.classList.toString().match(/card-(\w+)/g)[0].replace('card-', '');
 
 			content = element.querySelector('.card-body');
@@ -962,8 +972,8 @@ function generateModuleShortcode(module, element  ){
 				}
 			}
 			break;
-		}
-		case 'heading': {
+		
+		case 'heading': 
 
 			attrs = {
 				title: element.innerHTML.trim(),
@@ -986,7 +996,12 @@ function generateModuleShortcode(module, element  ){
 			content = element.innerHTML.trim()
 
 			break;
-		}
+		
+		case 'image':
+			let {src, href: url} = convertRawAttrs( element.rawAttrs )
+			attrs = { src, url };
+
+		break;
 	}
 
 	if( element.classList.length ){

package/configs/webpack.plugins.js

@@ -2,28 +2,192 @@
 /**
  * External dependencies
  */
+import path from 'path';
+import fs from 'fs';
+import SitemapWebpackPlugin    from 'sitemap-webpack-plugin';
+
 import CAWebHTMLPlugin from "@caweb/html-webpack-plugin";
 import CAWebA11yPlugin from '@caweb/a11y-webpack-plugin';
 import CAWebCSSAuditPlugin from '@caweb/css-audit-webpack-plugin';
 import CAWebJSHintPlugin from '@caweb/jshint-webpack-plugin';
+import { XMLParser } from 'fast-xml-parser';
+import Handlebars from '@caweb/webpack/lib/handlebars.js';
 
-import { flagExists } from '@caweb/webpack/lib/args.js';
+import { flagExists, getArgVal, flags } from '@caweb/webpack/lib/args.js';
 
-export default {
+// this is the path to the current project directory
+const appPath = process.cwd();
+
+let templatePath = path.join(appPath, 'node_modules', '@caweb', 'template');
+
+// we read the app caweb.json file if it exists
+let caweb = fs.existsSync( path.join(appPath, 'caweb.json') ) ? 
+JSON.parse(fs.readFileSync(path.join(appPath, 'caweb.json'))) 
+: {};
+
+// argument variables
+let template = getArgVal( 'template', path.join(templatePath, 'patterns', 'default.html') );
+
+let scheme = getArgVal( 'scheme', 'oceanside' );
+
+// Template patterns
+let patterns = fs.readdirSync(path.join(templatePath, 'patterns'), { withFileTypes: true } )
+    .filter( dirent => dirent.isFile() && (dirent.name.endsWith('.html') ) )
+    .map( ( dirent ) => {
+
+                let fileTemplate = path.join( dirent.parentPath, dirent.name );
+                let filename = fileTemplate.replace(path.join(templatePath, 'patterns'), '').replace(/\\/g, '');
+
+                // we ignore the default and blank patterns since those are used as templates and not actual pages
+                // if there is no Google Search Id we ignore the search pattern since that is only used for the Search Results page
+                if ( 
+                    ['default.html', 'blank.html'].includes( filename ) ||  
+                    (filename === 'serp.html' && ! caweb?.site?.google?.search)
+                ) {
+                    return false;
+                }
+
+                return {
+                    file: fileTemplate,
+                    filename,
+                };
+    })
+    .filter( Boolean );
+    
+// Additional pages directory
+let basePageDir = path.join(appPath, 'content', 'pages');
+
+let additionalPages = ! fs.existsSync( basePageDir ) ? [] :
+            fs.readdirSync( basePageDir, { withFileTypes: true, recursive: true } )
+            .filter( dirent => dirent.isFile() && (dirent.name.endsWith('.html') || dirent.name.endsWith('.handlebars')) )
+            .map( ( dirent ) => {
+
+                let fileTemplate = path.join( dirent.parentPath, dirent.name );
+                let filename = fileTemplate.replace(basePageDir, '').replace(/\\/, '');
+
+                // if additionl pages match a pattern page we remove ours
+                let override = patterns.find( (p) => p.filename === filename );
+                if( override ){
+                    patterns = patterns.filter( (p) => p.filename !== filename );
+                }
 
+                return {
+                    file: fileTemplate,
+                    filename,
+                    template,
+                }    
+        })
+
+let customPages = [...patterns, ...additionalPages ].filter( Boolean );
+
+export default {
+   
     plugins: [
         // add custom plugins here
         // Used for Site Generation
-        new CAWebHTMLPlugin(),
+        // when using the CAWebHTMLPlugin we dont have to pass the caweb.site data since that is automatically done by the plugin, we just need to pass the scheme so that it can be used in the templates
+        new CAWebHTMLPlugin({
+            template,
+            templateParameters: {
+                scheme,
+            },
+        }),
+
+        // Additional pages from content/pages directory
+        ...customPages.map( (page) => {
+            // replace .html, uppercase the first letter of each word
+            // this is to make sure the title is readable
+            // and not just a file name
+            let title = page.filename.replace('.html', '').replace(/\b\w/g, c => c.toUpperCase());
+            let content = fs.readFileSync( page.file, 'utf-8' );
+            
+            let data = {
+                    ...caweb.site,
+                    scheme
+                };
+            
+            let compiler = Handlebars.compile( content );
+            let compiledContent = compiler(data);
+
+            return new CAWebHTMLPlugin({
+                template: page.template ?? page.file,
+                filename: page.filename,
+                title,
+                templateParameters: {
+                    scheme,
+                    partial: compiledContent,
+                },
+            })
+        }) ,
+
+        // Sitemap Generation
+        ( ! flagExists('sitemap') || (flagExists('sitemap') && getArgVal('sitemap'))) && new SitemapWebpackPlugin.default({
+            base: caweb?.site?.url || 'http://localhost:9000',
+            paths: ['/build/', ...customPages.map( (page) => `/${page.filename}` )],
+            options: {
+                filename: 'sitemap.html',
+                skipgzip: true, // By default, both .xml and .xml.gz are generated
+                formatter: (config) => {
+                    // we remove the build/ from the url since that is the output path and proxied
+                    config = config.replace(/build\//g, '');
+        
+                    let parser = new XMLParser();
+                    let xmlDoc = parser.parse(config, true);
+
+                    // we map the urls to html links
+                    let partial = xmlDoc.urlset.url ? 
+                        xmlDoc.urlset.url.map( ({loc}) => `<a href="${loc}" class="d-block">${loc}</a>` ).join('') : '';
+
+                    let content = fs.readFileSync( template ).toString();
+
+                    let data = {
+                        ...caweb.site,
+                        scheme,
+                        logo: '/media/logo.png',
+                        partial: `<div class="container"><div class="row"><div class="col-12"><h2>Sitemap</h2>${partial}</div></div></div>`,
+                    };
+
+                    let compiler = Handlebars.compile( content );
+                    let compiledContent = compiler(data);
+
+                    return compiledContent;
+                }
+            }
+        }),
+
+        // Custom plugin to rename the sitemap file from sitemap.html.xml to sitemap.html since the sitemap-webpack-plugin does not allow us to set the extension to .html
+        ( ! flagExists('sitemap') || (flagExists('sitemap') && getArgVal('sitemap'))) && {
+            apply: (compiler) => {
+                compiler.hooks.thisCompilation.tap('RenameSitemapWebpackPlugin',(compilation) => {
+                    compilation.hooks.processAssets.tapAsync(
+                        {
+                            name: 'RenameSitemapWebpackPlugin',
+                            stage: compiler.webpack.Compilation.PROCESS_ASSETS_STAGE_SUMMARIZE ,
+                        },
+                        (assets, callback) => {
+                            Object.keys(compilation.assets).forEach((assetName) => {
+                                if (assetName.endsWith('.html.xml')) {
+                                    const newName = assetName.replace('.xml', '');
+                                    compilation.assets[newName] = compilation.assets[assetName];
+                                    delete compilation.assets[assetName];
+                                }
+                            });
+                            callback();
+                        }
+                    )
+                    
+                });
+            },
+        },
 
-        // // IBM Accessibility
-        ! flagExists('no-a11y') && new CAWebA11yPlugin(),
+        // IBM Accessibility
+        ( ! flagExists('a11y') || (flagExists('a11y') && getArgVal('a11y'))) && new CAWebA11yPlugin(),
 
-        // // WP CSS Auditor
-        ! flagExists( 'no-audit' ) && new CAWebCSSAuditPlugin(),
+        // WP CSS Auditor
+        ( ! flagExists('audit') || (flagExists('audit') && getArgVal('audit'))) && new CAWebCSSAuditPlugin(),
 
-        // // JSHint
-        ! flagExists( 'no-jshint' ) && new CAWebJSHintPlugin(),
+        // JSHint
+        ( ! flagExists('jshint') || (flagExists('jshint') && getArgVal('jshint'))) && new CAWebJSHintPlugin(),
         
     ].filter( Boolean ),
 }

package/lib/cli.js

@@ -96,6 +96,7 @@ function addWebpackCmds(){
 	.option( '--no-audit', 'Skips WordPress CSS-Audit.', false )
 	.option( '--no-a11y', 'Skips IBM Accessibility Checker.', false )
 	.option( '--no-jshint', 'Skips JSHint.', false )
+	.option( '--no-sitemap', 'Skips Sitemap generation.', false )
 	.allowUnknownOption(true)
 	.allowExcessArguments(true)
 	.action(env.webpack)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@caweb/cli",
-  "version": "1.15.16",
+  "version": "1.15.18",
   "description": "CAWebPublishing Command Line Interface.",
   "exports": "./lib/env.js",
   "type": "module",
@@ -66,9 +66,9 @@
   "dependencies": {
     "@caweb/a11y-webpack-plugin": "^2.1.0",
     "@caweb/css-audit-webpack-plugin": "^2.1.0",
-    "@caweb/html-webpack-plugin": "^2.1.3",
+    "@caweb/html-webpack-plugin": "^2.1.5",
     "@caweb/jshint-webpack-plugin": "^2.1.0",
-    "@caweb/webpack": "^1.6.4",
+    "@caweb/webpack": "^1.6.6",
     "@inquirer/prompts": "^8.2.0",
     "@wordpress/create-block": "^4.82.0",
     "@wordpress/env": "^10.39.0",
@@ -80,6 +80,7 @@
     "crypto": "^1.0.1",
     "deepmerge": "^4.3.1",
     "docker-compose": "^1.3.1",
+    "fast-xml-parser": "^5.3.5",
     "fs-extra": "^11.3.3",
     "html-to-json-parser": "^2.0.1",
     "inquirer-select-pro": "^1.0.0-alpha.9",
@@ -88,6 +89,7 @@
     "ora": "^9.3.0",
     "resolve-bin": "^1.0.1",
     "rimraf": "^6.1.2",
+    "sitemap-webpack-plugin": "^1.1.1",
     "terminal-link": "^5.0.0"
   }
 }