@caweb/cli 1.4.2 → 1.4.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@caweb/cli",
-  "version": "1.4.2",
+  "version": "1.4.4",
   "description": "CAWebPublishing Command Line Interface.",
   "exports": "./lib/env.js",
   "type": "module",
@@ -9,21 +9,20 @@
   "author": "CAWebPublishing",
   "license": "ISC",
   "bin": {
-    "caweb": "bin/caweb.js"
+    "caweb": "bin/caweb.js",
+    "auditor": "bin/css-audit/index.js"
   },
   "files": [
-    "assets",
     "bin",
     "commands",
     "configs",
-    "docs",
-    "gen",
     "lib",
     "template"
   ],
   "scripts": {
     "doc": "node ./docs/tool/index.js",
-    "test": "echo \"Error: run tests from root\" && exit 0"
+    "test": "echo \"Error: run tests from root\" && exit 0",
+    "postinstall": "cd bin/css-audit && npm ci"
   },
   "homepage": "https://github.com/CAWebPublishing/cli#readme",
   "repository": {
@@ -41,7 +40,7 @@
     "access": "public"
   },
   "config": {
-    "WP_VER": "6.5.4",
+    "WP_VER": "6.5.5",
     "PHP_VER": "8.1",
     "DEFAULTS": {
       "FS_METHOD": "direct",
@@ -59,31 +58,38 @@
     }
   },
   "dependencies": {
-    "@wordpress/create-block": "^4.44.0",
-    "@wordpress/env": "^10.1.0",
-    "@wordpress/scripts": "^28.1.0",
+    "@wordpress/create-block": "^4.45.0",
+    "@wordpress/env": "^10.2.0",
+    "@wordpress/scripts": "^28.2.0",
     "accessibility-checker": "^3.1.73",
     "autoprefixer": "^10.4.19",
     "axios": "^1.7.2",
-    "axios-retry": "^4.4.0",
+    "axios-retry": "^4.4.1",
     "chalk": "^5.3.0",
     "check-valid-url": "^0.1.0",
     "commander": "^12.1.0",
     "cross-spawn": "^7.0.3",
+    "css-audit": "file:css-audit",
     "css-loader": "^7.1.2",
+    "deepmerge": "^4.3.1",
     "docker-compose": "^0.24.8",
     "fs-extra": "^11.2.0",
+    "get-all-files": "^5.0.0",
     "got": "^14.4.1",
     "handlebars-loader": "^1.7.3",
     "html-to-json-parser": "^2.0.1",
     "html-webpack-plugin": "^5.6.0",
+    "html-webpack-skip-assets-plugin": "^1.0.4",
+    "jshint": "^2.13.6",
     "mini-css-extract-plugin": "^2.9.0",
     "ora": "^8.0.1",
     "postcss-loader": "^8.1.1",
     "resolve-bin": "^1.0.1",
     "sass-loader": "^14.2.1",
+    "snyk": "^1.1292.1",
     "terminal-link": "^3.0.0",
     "url": "^0.11.3",
-    "webpack": "^5.92.1"
+    "webpack": "^5.92.1",
+    "webpack-dev-server": "^5.0.4"
   }
 }

package/commands/a11y.js

@@ -1,95 +0,0 @@
-#!/usr/bin/env node
-
-/**
- * External dependencies
- */
-import achecker from 'accessibility-checker';
-import path from 'path';
-import { isUrl } from 'check-valid-url';
-import fs from 'fs';
-
-/**
- * Internal dependencies
- */
-// Our default A11y Checker Configuration 
-import defaultConfig from '../configs/aceconfig.js';
-
-import { 
-    runCmd, 
-} from '../lib/index.js';
-import { stderr, stdout } from 'process';
-
-
-/**
- * Run accessibility checks
- * 
- * @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();
-
-    const {
-        ruleArchive,
-        policies,
-        failLevels,
-        reportLevels,
-        outputFolder,
-        outputFormat,
-        outputFilenameTimestamp
-    } = defaultConfig;
-
-    
-    // pass any arguments from the cli
-    // overwriting our default config flags.
-    // users can overwrite any values by creating a .achecker.yml or aceconfig.js.
-    let acheckerArgs = [
-        '--ruleArchive',
-        ruleArchive,
-        '--policies',
-        Array.isArray(policies) ? policies.join(',') : policies,
-        '--failLevels',
-        Array.isArray(failLevels) ? failLevels.join(',') : failLevels,
-        '--reportLevels',
-        Array.isArray(reportLevels) ? reportLevels.join(',') : reportLevels,
-        '--outputFolder',
-        outputFolder,
-        '--outputFormat',
-        outputFormat,
-        '---outputFilenameTimestamp',
-        outputFilenameTimestamp,
-        url
-    ];
-
-    // 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/build.js

@@ -1,80 +0,0 @@
-#!/usr/bin/env node
-
-/**
- * External dependencies
- */
-import path from 'path';
-import fs from 'fs';
-
-/**
- * Internal dependencies
- */
-import { 
-    runCmd, 
-    projectPath,
-    appPath
-} from '../lib/index.js';
-
-
-/**
- * Build the current project
- * 
- * @param {Object}  options
- * @param {Object}  options.spinner A CLI spinner which indicates progress.
- * @param {boolean} options.debug   True if debug mode is enabled.
- */
-export default async function build({
-	spinner,
-	debug, 
-} ) {
-
-    // Spinner not needed at the moment
-	spinner.stop()
-
-    // Since we use @wordpress/scripts webpack config we can leverage
-    // the environment variables as well.
-    process.env.WP_COPY_PHP_FILES_TO_DIST  = true;
-
-    // Our default Webpack Configuration 
-    const defaultConfig = path.join( projectPath, 'configs', 'webpack.config.js' );
-
-    // pass any arguments from the cli
-    // add our default config as an extension.
-    // users can overwrite any values by creating a webconfig of their own.
-    let webPackArgs = [
-        '--mode=none',
-        '--progress',
-        '--config',
-        defaultConfig
-    ];
-
-    // CommonJS
-    if( fs.existsSync( path.join(appPath, 'webpack.config.cjs' ))){
-        webPackArgs.push(
-            '--config',
-            path.join(appPath, 'webpack.config.cjs' ),
-            '--merge'
-        )
-    // ESM
-    }else if( fs.existsSync(path.join(appPath, 'webpack.config.js' )) ){
-        webPackArgs.push(
-            '--config',
-            path.join(appPath, 'webpack.config.js' ),
-            '--merge'
-        )
-    }
-
-    // run webpack with our arguments.
-    await runCmd(
-		'webpack', 
-		webPackArgs, 
-	).then(({stdout, stderr}) => {
-        // if an error was thrown, and no output
-        if( stderr && ! stdout.toString() ){
-            console.log( stderr.toString() )
-        }else{
-            spinner.text = 'Done'
-        }
-    });
-
-};

package/commands/serve.js

@@ -1,95 +0,0 @@
-#!/usr/bin/env node
-
-/**
- * External dependencies
- */
-import path from 'path';
-import fs from 'fs';
-
-/**
- * Internal dependencies
- */
-import { 
-    projectPath,
-    appPath,
-    runCmd
- } from '../lib/index.js';
-
-import a11y from './a11y.js';
-
-/**
- * Serves the current project
- * 
- * @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.template   Disables inclusion of the template page header & footer, starting off with a plain html page.
- */
-export default async function serve({
-	spinner,
-	debug,
-	template,
-} ) {
-    spinner.stop();
-    
-    // Since we use @wordpress/scripts webpack config we can leverage
-    // the environment variables as well.
-    process.env.WP_COPY_PHP_FILES_TO_DIST  = true;
-
-
-    // This lets the parser know to include the template 
-    // 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' );
-
-   let webPackArgs = [
-      'serve',
-      '--open',
-      '--hot',
-      '--mode=none',
-      '--config',
-      defaultConfig
-    ];
-
-   // merge user configurations
-   // CommonJS
-   if( fs.existsSync(path.join( appPath, 'webpack.config.cjs' ))){
-       webPackArgs.push(
-           '--config',
-           path.join( appPath, 'webpack.config.cjs' ),
-           '--merge'
-       )
-   // ESM
-   }else if( fs.existsSync(path.join( appPath, 'webpack.config.js' )) ){
-       webPackArgs.push(
-           '--config',
-           path.join( appPath, 'webpack.config.js' ),
-           '--merge'
-       )
-   }
-
-    // run webpack with our configuration.
-    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/aceconfig.js

@@ -1,28 +0,0 @@
-/**
- * Configuration for Accessibility Checker
- * @link https://www.npmjs.com/package/accessibility-checker
- */
-
-export default {
-    ruleArchive: "latest",
-    policies: [
-        'WCAG_2_1'
-    ],
-    failLevels: [
-        'violation', 
-        'potentialviolation'
-    ],
-    reportLevels: [
-        'violation', 
-        'potentialviolation',
-        'recommendation',
-        'potentialrecommendation',
-        'manual',
-        'pass'
-    ],
-    outputFolder: "a11y",
-    outputFormat: [
-        'html'
-    ],
-    outputFilenameTimestamp: false
-}

package/docs/CREDITS.MD

@@ -1,27 +0,0 @@
-# Sources  
-### <ins>Design System Components</ins>  
-[Github](https://github.com/cagov/design-system/tree/main/components)  
-[NPM Packages](https://www.npmjs.com/search?q=%40cagov)  
-
-### <ins>docker-compose</ins>  
-[Documentation](https://pdmlab.github.io/docker-compose/)  
-[Github](https://github.com/PDMLab/docker-compose)  
-[NPM Package](https://www.npmjs.com/package/docker-compose)  
-
-### <ins>wp-env</ins> 
-[Documentation](https://developer.wordpress.org/block-editor/reference-guides/packages/packages-env/)  
-[Github](https://github.com/WordPress/gutenberg/tree/HEAD/packages/env)  
-[NPM Package](https://www.npmjs.com/package/@wordpress/env)  
-
-### <ins>create-block</ins> 
-[Block API](https://developer.wordpress.org/block-editor/reference-guides/block-api/)  
-[Documentation](https://developer.wordpress.org/block-editor/reference-guides/packages/packages-create-block/)  
-[External Project Templates](https://developer.wordpress.org/block-editor/reference-guides/packages/packages-create-block/packages-create-block-external-template/)  
-[NPM Package](https://www.npmjs.com/package/@wordpress/create-block)   
-
-
-### <ins>wp cli</ins> 
-[Documentation](https://developer.wordpress.org/cli/commands/)
-
-### <ins>phpMyAdmin</ins> 
-[Docker](https://hub.docker.com/_/phpmyadmin)

package/docs/ISSUES.MD

@@ -1,7 +0,0 @@
-# Known Issues
-[[Bug](https://github.com/npm/cli/issues/3136)] Arguments are not correctly passed from CLI to npm script (npm 7, Windows, Powershell)
-- Workaround - If using < Node 20, add an additional `--` when passing arguments  
--- Example run  
-`npm run caweb start -- -- --multisite`  
-instead of  
-`npm run caweb start -- --multisite`

package/docs/OVERRIDES.md

@@ -1,53 +0,0 @@
-## [.wp-env.override.json](https://developer.wordpress.org/block-editor/reference-guides/packages/packages-env/#wp-env-override-json)
-Any fields here will take precedence over .wp-env.json.
-## <ins>Special Config Values</ins>
-### <ins>CAWeb Options</ins>
-`CAWEB_TEMPLATE_VER` - Updates CAWeb State Template Version  
-`CAWEB_NAV_MENU_STYLE` - Updates CAWeb Header Menu Type  
-`CAWEB_COLORSCHEME` - Updates CAWeb Color Scheme  
-`CAWEB_TITLE_DISPLAY` - Updates CAWeb Title Display Default  
-`CAWEB_STICKY_NAV` - Updates CAWeb Sticky Navigation  
-`CAWEB_MENU_HOME_LINK` - Updates CAWeb Menu Home Link  
-`CAWEB_DISPLAY_POSTS_DATE` - Updates CAWeb Display Date for Non-Divi Posts  
-`CAWEB_X_UA_COMPATIBILITY` - Updates CAWeb Legacy Browser Support  
-`CAWEB_FRONTPAGE_SEARCH` - Updates CAWeb Show Search on Front Page  
-`CAWEB_CONTACT_US_PAGE` - Updates CAWeb Contact Us Page  
-`CAWEB_GEO_LOCATOR` - Updates CAWeb Enable Geo Locator  
-`CAWEB_UTILITY_HOME_LINK` - Updates CAWeb Home Link  
-`CAWEB_UTILITY_LINK1_ENABLED` - Updates CAWeb Custom Link 1  
-`CAWEB_UTILITY_LINK1_LABEL` - Updates CAWeb Custom Link 1 Label  
-`CAWEB_UTILITY_LINK1_URL` - Updates CAWeb Custom Link 1 URL  
-`CAWEB_UTILITY_LINK1_NEW_WINDOW` - Updates CAWeb Custom Link 1 Open in New Tab  
-`CAWEB_UTILITY_LINK2_ENABLED` - Updates CAWeb Custom Link 2  
-`CAWEB_UTILITY_LINK2_LABEL` - Updates CAWeb Custom Link 2 Label  
-`CAWEB_UTILITY_LINK2_URL` - Updates CAWeb Custom Link 2 URL  
-`CAWEB_UTILITY_LINK2_NEW_WINDOW` - Updates CAWeb Custom Link 2 Open in New Tab  
-`CAWEB_UTILITY_LINK3_ENABLED` - Updates CAWeb Custom Link 3  
-`CAWEB_UTILITY_LINK3_LABEL` - Updates CAWeb Custom Link 3 Label  
-`CAWEB_UTILITY_LINK3_URL` - Updates CAWeb Custom Link 3 URL  
-`CAWEB_UTILITY_LINK3_NEW_WINDOW` - Updates CAWeb Custom Link 3 Open in New Tab  
-`CAWEB_CAWEB_ORG_LOGO_ALT_TEXT` - Updates CAWeb Organization Logo-Alt Text  
-`CAWEB_GOOGLE_SEARCH_ENGINE_ID` - Updates CAWeb Search Engine ID  
-`CAWEB_GOOGLE_ANALYTICS_ID` - Updates CAWeb Analytics ID  
-`CAWEB_GOOGLE_ANALYTICS4_ID` - Updates CAWeb Analytics 4 ID  
-`CAWEB_GOOGLE_TAG_MANAGER_ID` - Updates CAWeb Tag Manager ID  
-`CAWEB_GOOGLE_META_ID` - Updates CAWeb Site Verification Meta ID  
-`CAWEB_GOOGLE_TRANSLATE_MODE` - Updates CAWeb Enable Google Translate  
-`CAWEB_GOOGLE_TRANSLATE_PAGE` - Updates CAWeb Translate Page  
-`CAWEB_GOOGLE_TRANSLATE_PAGE_NEW_WINDOW` - Updates CAWeb Open in New Tab  
-`CAWEB_GOOGLE_TRANSLATE_ICON` - Updates CAWeb Icon  
-`CAWEB_PRIVATE_REPO` - Updates CAWeb Is Private?  
-`CAWEB_GIT_USER` - Updates CAWeb Username  
-`CAWEB_ACCESS_TOKEN` - Updates CAWeb Token  
-### <ins>Divi Options</ins>
-`ET_DYNAMIC_MODULE` - Updates CAWeb Dynamic Module Framework  
-`ET_DYNAMIC_CSS` - Updates CAWeb Dynamic CSS  
-`ET_CRITICAL_CSS` - Updates CAWeb Critical CSS  
-`ET_DYNAMIC_JS` - Updates CAWeb Dynamic JavaScript Libraries  
-`ET_CLASSIC_EDITOR` - Updates CAWeb Enable Classic Editor  
-`ET_STATIC_CSS_GENERATION` - Updates CAWeb Static CSS File Generation  
-`ET_PRODUCT_TOUR` - Updates CAWeb Product Tour  
-`ET_NEW_BUILDER_EXPERIENCE` - Updates CAWeb Enable The Latest Divi Builder Experience  
-`ET_OUTPUT_STYLES_INLINE` - Updates CAWeb Output Styles Inline  
-`ET_USERNAME` - Updates CAWeb Username  
-`ET_API_KEY` - Updates CAWeb API Key  

package/docs/ROADMAP.MD

@@ -1,19 +0,0 @@
-# Roadmap Features:
-
-## Testaro
-https://www.npmjs.com/package/testaro  
-
-## Sonarqube Scanner
-https://www.npmjs.com/package/sonarqube-scanner
-
-## BrowserStack
-https://www.npmjs.com/package/browserstack
-
-## Accessibility Checker
-https://www.npmjs.com/package/accessibility-checker
-
-## Control Panel
-https://aapanel.com/new/download.html
-
-## SNYK
-https://www.npmjs.com/package/snyk

package/docs/SYNC.MD

@@ -1,29 +0,0 @@
-# caweb.json  Configuration  
-Under the `sync` property you can list the various WordPress Instances. Each Instance, requires a WordPress Username, Application Password and the Site URL.
-
-Sync Example Command:  
-Using the example, if you wanted to sync all the changes from the dev instance to your local instance.  
-`caweb sync dev local`  
-
-Sync Configuration Example:  
-<pre>
-{
-    "sync": {
-        "local": {
-            "user": "&lt;Username&gt;",
-            "pwd": "<a href="https://developer.wordpress.org/rest-api/using-the-rest-api/authentication/#basic-authentication-with-application-passwords">Application Password</a>",
-            "url": "http://example1.com"
-        },
-        "dev": {
-            "user": "&lt;Username&gt;",
-            "pwd": "<a href="https://developer.wordpress.org/rest-api/using-the-rest-api/authentication/#basic-authentication-with-application-passwords">Application Password</a>",
-            "url": "http://example2.com"
-        },
-        "test": {
-            "user": "&lt;Username&gt;",
-            "pwd": "<a href="https://developer.wordpress.org/rest-api/using-the-rest-api/authentication/#basic-authentication-with-application-passwords">Application Password</a>",
-            "url": "http://example3.com"
-        }
-    }
-}
-</pre>

package/docs/tool/index.js

@@ -1,45 +0,0 @@
-'use strict';
-
-
-/**
- * External dependencies
- */
-import path from 'node:path';
-import fs from 'fs-extra';
-
-import { CAWEB_OPTIONS, DIVI_OPTIONS } from '../../lib/index.js';
-
-generateOverridesMD()
-
-/**
- * Generates the OVERRIDES.MD
- * 
- */
-export default async function generateOverridesMD() {
-
-	let output = [
-		'## [.wp-env.override.json](https://developer.wordpress.org/block-editor/reference-guides/packages/packages-env/#wp-env-override-json)',
-		'Any fields here will take precedence over .wp-env.json.',
-		'## <ins>Special Config Values</ins>',
-	];
-
-	// Generate CAWeb Options overrides.
-	output.push('### <ins>CAWeb Options</ins>');
-	for (const [key, option] of Object.entries(CAWEB_OPTIONS)) {
-		output.push(`\`${key}\` - Updates CAWeb ${option.label}  `);
-	}
-	  
-	// Generate Divi Options overrides.
-	output.push('### <ins>Divi Options</ins>');
-	for (const [group, options] of Object.entries(DIVI_OPTIONS)) {
-		for (const [key, option] of Object.entries(options)) {
-			output.push(`\`${key}\` - Updates CAWeb ${option.label}  `);
-		}
-	}
-
-	fs.writeFileSync(
-		path.join(process.cwd(), 'docs', 'OVERRIDES.MD'),
-		output.join('\n')
-	);
-
-};