@caweb/cli 1.3.17 → 1.4.1

package/commands/a11y.js

@@ -3,9 +3,10 @@
 /**
  * External dependencies
  */
+import achecker from 'accessibility-checker';
 import path from 'path';
+import { isUrl } from 'check-valid-url';
 import fs from 'fs';
-import resolveBin from 'resolve-bin';
 
 /**
  * Internal dependencies
@@ -16,7 +17,7 @@ import defaultConfig from '../configs/aceconfig.js';
 import { 
     runCmd, 
 } from '../lib/index.js';
-
+import { stderr, stdout } from 'process';
 
 
 /**
@@ -25,14 +26,17 @@ import {
  * @param {Object}  options
  * @param {Object}  options.spinner A CLI spinner which indicates progress.
  * @param {boolean} options.debug   True if debug mode is enabled.
+ * @param {boolean} options.url   True if debug mode is enabled.
  */
 export default async function a11y({
 	spinner,
 	debug, 
+    url
 } ) {
 
     // Spinner not needed at the moment
-	spinner.stop()
+	spinner.stop();
+
     const {
         ruleArchive,
         policies,
@@ -62,13 +66,30 @@ export default async function a11y({
         outputFormat,
         '---outputFilenameTimestamp',
         outputFilenameTimestamp,
-        process.argv.pop()
+        url
     ];
 
-    // run webpack with our arguments.
-    await runCmd(
-		'achecker', 
-		acheckerArgs, 
-	)
+    // run accessibility checker with our arguments.
+    if( isUrl( url ) || fs.existsSync( url ) ){
+        let outputDir = path.resolve('.',  outputFolder);
+        let outputFileName = isUrl( url ) ?
+            url.replace(/http[s]+:\/\//, '')
+            :
+            path.resolve(url).replace(':', '_');
+
+        
+        let reportFile = path.resolve(outputDir, outputFileName ) + '.html'
+
+        await runCmd(
+            'achecker', 
+            acheckerArgs,
+        ).then(({stderr, stdout}) => {
+            console.log( reportFile );
+        })
+
+    }else{
+        console.log( `${url} is not a valid url.` )
+    }
+    
 
 };

package/commands/serve.js

@@ -15,6 +15,8 @@ import {
     runCmd
  } from '../lib/index.js';
 
+import a11y from './a11y.js';
+
 /**
  * Serves the current project
  * 
@@ -39,6 +41,8 @@ export default async function serve({
     // Otherwise we load a blank html page
     process.env.CDT_TEMPLATE = template;
     
+    // Let our webpack config know it's serving not building
+    process.env.CAWEB_SERVE = true;
 
    // Our default Webpack Configuration 
    const defaultConfig = path.join( projectPath, 'configs', 'webpack.config.js' );
@@ -46,7 +50,7 @@ export default async function serve({
    let webPackArgs = [
       'serve',
       '--open',
-      '--mode=development',
+      '--mode=none',
       '--config',
       defaultConfig
     ];
@@ -72,7 +76,19 @@ export default async function serve({
     await runCmd(
 		  'webpack', 
       webPackArgs
-    )
+    ).then(({stdout, stderr}) => {
+        // if an error was thrown, and no output
+        if( stderr && ! stdout.toString() ){
+            console.log( stderr.toString() )
+        }else{
+                    
+            // run a11y checker as well
+            //await a11y({spinner, debug, url: './public/index.html' })
+
+            //return;
+            spinner.text = 'Done'
+        }
+    });
     
 
 };

package/configs/webpack.config.js

@@ -10,10 +10,7 @@
  * External dependencies
  */
 import baseConfig from '@wordpress/scripts/config/webpack.config.js';
-import path from 'path';
-import fs from 'fs';
 import MiniCssExtractPlugin from "mini-css-extract-plugin";
-import CopyWebpackPlugin from 'copy-webpack-plugin';
 
 /**
  * Internal dependencies
@@ -85,11 +82,11 @@ baseConfig.module.rules.forEach((rule, i) => {
 // Our Webpack Configuration.
 let webpackConfig = {
   ...baseConfig,
-  //target: 'browserslist',
+  target: 'web',
   devtool: false,
   output: {
     ...baseConfig.output,
-    publicPath: `./`,
+    publicPath: `/`,
     clean: true
   },
   plugins: [
@@ -104,10 +101,10 @@ let webpackConfig = {
   module: {
     rules: [
       ...baseConfig.module.rules,
-      {
+      /*{
         test: /\.html$/,
-        loader: 'handlebars-loader'
-      }
+        loader:'handlebars-loader'
+      }*/
     ]
   },
   performance: {
@@ -116,7 +113,9 @@ let webpackConfig = {
   }
 };
 
-if( ! isProduction ){
+if( process.env.CAWEB_SERVE ){
+  delete webpackConfig.devServer;
+
   SiteGenerator( webpackConfig );
 }
 

package/docs/tool/index.js

@@ -7,7 +7,7 @@
 import path from 'node:path';
 import fs from 'fs-extra';
 
-import { CAWEB_OPTIONS, DIVI_OPTIONS } from '../../lib/options.js';
+import { CAWEB_OPTIONS, DIVI_OPTIONS } from '../../lib/index.js';
 
 generateOverridesMD()
 

package/gen/site-generator.js

@@ -14,14 +14,18 @@ import {
   generatePages
 } from './parser.js';
 
-import {
+/*import {
   projectPath,
   appPath
-} from '../lib/helpers.js';
-
+} from '../lib/index.js';
+*/
+const currentPath = path.dirname(fileURLToPath(import.meta.url));
+const projectPath = path.resolve( currentPath, '..' );
+const appPath = path.resolve( process.cwd() );
+const samplePath = path.join( appPath, 'sample');
 const srcPath = path.join( appPath, 'src');
 const dataPath = path.join( srcPath, 'data');
-const assetsPath = path.join( srcPath, 'assets');
+//const assetsPath = path.join( srcPath, 'assets');
 
 // default meta used for site generation when no meta is passed
 const meta = {
@@ -56,7 +60,7 @@ function getSiteData(){
 
 export default (webpackConfig) => {
   // we only proceed if and index.html exists
-  if( ! fs.existsSync( path.join( srcPath, 'index.html' )) ){
+  if( ! fs.existsSync( path.join( samplePath, 'index.html' )) ){
     return;
   }
 
@@ -66,10 +70,21 @@ export default (webpackConfig) => {
   // get site data
   let siteData = getSiteData();
 
-  // if favicon doesn't exist use fallback asset.
-  let favicon = fs.existsSync(path.join(assetsPath, 'images', 'favicon.ico')) ?
-    path.join(assetsPath, 'images', 'favicon.ico') :
-    path.join(projectPath, 'assets', 'favicon.ico') ;
+  /**
+   * Favicon
+   * 
+   * Locations:
+   * - ./favicon.ico - root of the project
+   * - ./src/favicon.ico - src directory
+   * - favicon.ico - default icon
+   */
+  let favicon = fs.existsSync(path.join(appPath, 'favicon.ico')) ?
+    path.join(appPath, 'favicon.ico') :
+    ( 
+      fs.existsSync(path.join(srcPath, 'favicon.ico')) ? 
+        path.join(srcPath, 'favicon.ico') : 
+        path.join(projectPath, 'assets', 'logo.ico')  
+    );
 
   let defaultPage = {
     minify: false,
@@ -81,8 +96,8 @@ export default (webpackConfig) => {
   webpackConfig.plugins = [
     ...webpackConfig.plugins,
     new HtmlWebpackPlugin({
-      filename: path.join( process.cwd(), 'public', 'index.html'),
-      template: path.join(srcPath, 'index.html'),
+      filename: path.join( appPath, 'public', 'index.html'),
+      template: path.join(samplePath, 'index.html'),
       //templateContent: generatePages(siteData),
       title: 'Test Site',
       ...defaultPage
@@ -99,13 +114,31 @@ export default (webpackConfig) => {
     host: 'localhost',
     port: 9000,
     compress: true,
-    proxy: {
-      '/public': {
-        pathRewrite: {
-          '^/build': '',
-        },
+    static: [
+      {
+        directory: path.join( appPath, 'build'),
       },
-    },
+      {
+        directory: path.join(appPath, 'node_modules'),
+      },
+      {
+        directory: path.join(appPath, 'public'),
+      },
+      {
+        directory: path.join(appPath, 'src'),
+      }
+    ],
+    proxy: [
+      {
+        context: ['/node_modules'],
+        target: 'http://localhost:9000',
+        pathRewrite: { '^/node_modules': '' },
+      },
+      {
+        context: ['/src'],
+        target: 'http://localhost:9000',
+        pathRewrite: { '^/src': '' },
+      }
+    ],
   }  
-
 };

package/lib/cli.js

@@ -227,6 +227,7 @@ export default function cli() {
 
 	// a11y Command.
 	program.command('a11y')
+		.addArgument(new Argument('<url>', 'URL to scan for accessibility checks.'))
 		.description('Runs accessibility checks.')
 		.allowUnknownOption(true)
 		.action(withSpinner(env.a11y))

package/lib/helpers.js

@@ -40,9 +40,12 @@ async function runCmd(cmd, args,opts = { stdio: ['inherit', 'pipe'] }){
 			 */
 			cmd += /^win/.test(process.platform) ? '.cmd' : '';
 			break;
+		case 'achecker':
+			cmd = resolveBin('accessibility-checker', {executable: 'achecker'})
+			break;	
 		case 'webpack':
 			cmd = resolveBin(cmd)
-			break
+			break;
 	}
 
 	return spawn.sync( cmd, args, {...opts, env: process.env});

package/lib/index.js

@@ -25,7 +25,9 @@ import {
 	convertToMultisite,
 	generateHTAccess,
 	getTaxonomies,
-    createTaxonomies
+    createTaxonomies,
+	CAWEB_OPTIONS,
+	DIVI_OPTIONS
 } from './wordpress/index.js';
 
 export {
@@ -49,5 +51,7 @@ export {
 	convertToMultisite,
 	generateHTAccess,
 	getTaxonomies,
-    createTaxonomies
+    createTaxonomies,
+	CAWEB_OPTIONS,
+	DIVI_OPTIONS
 }

package/package.json

@@ -1,16 +1,18 @@
 {
   "name": "@caweb/cli",
-  "version": "1.3.17",
+  "version": "1.4.1",
   "description": "CAWebPublishing Command Line Interface.",
   "exports": "./lib/env.js",
   "type": "module",
   "node": ">=20",
+  "main": "./lib/env.js",
   "author": "CAWebPublishing",
   "license": "ISC",
   "bin": {
     "caweb": "bin/caweb.js"
   },
   "files": [
+    "assets",
     "bin",
     "commands",
     "configs",
@@ -20,6 +22,7 @@
     "template"
   ],
   "scripts": {
+    "doc": "node ./docs/tool/index.js",
     "test": "echo \"Error: run tests from root\" && exit 0"
   },
   "homepage": "https://github.com/CAWebPublishing/cli#readme",
@@ -38,7 +41,7 @@
     "access": "public"
   },
   "config": {
-    "WP_VER": "6.5.3",
+    "WP_VER": "6.5.4",
     "PHP_VER": "8.1",
     "DEFAULTS": {
       "FS_METHOD": "direct",
@@ -56,19 +59,21 @@
     }
   },
   "dependencies": {
-    "@wordpress/create-block": "^4.41.0",
-    "@wordpress/env": "^9.9.0",
-    "@wordpress/scripts": "^27.8.0",
-    "accessibility-checker": "^3.1.71",
+    "@wordpress/create-block": "^4.44.0",
+    "@wordpress/env": "^10.1.0",
+    "@wordpress/scripts": "^28.1.0",
+    "accessibility-checker": "^3.1.73",
     "autoprefixer": "^10.4.19",
-    "axios": "^1.6.8",
-    "axios-retry": "^4.2.0",
+    "axios": "^1.7.2",
+    "axios-retry": "^4.4.0",
     "chalk": "^5.3.0",
-    "commander": "^12.0.0",
+    "check-valid-url": "^0.1.0",
+    "commander": "^12.1.0",
     "cross-spawn": "^7.0.3",
-    "css-loader": "^7.1.1",
+    "css-loader": "^7.1.2",
     "docker-compose": "^0.24.8",
     "fs-extra": "^11.2.0",
+    "got": "^14.4.1",
     "handlebars-loader": "^1.7.3",
     "html-to-json-parser": "^2.0.1",
     "html-webpack-plugin": "^5.6.0",
@@ -79,6 +84,6 @@
     "sass-loader": "^14.2.1",
     "terminal-link": "^3.0.0",
     "url": "^0.11.3",
-    "webpack": "^5.91.0"
+    "webpack": "^5.92.1"
   }
 }