@caweb/cli 1.4.3 → 1.4.5

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/audit.js

@@ -1,135 +0,0 @@
-#!/usr/bin/env node
-
-/**
- * External dependencies
- */
-import path from 'path';
-import fs from 'fs';
-import { getAllFiles, getAllFilesSync } from 'get-all-files'
-
-/**
- * Internal dependencies
- */
-
-import { 
-    runCmd, 
-    projectPath,
-    appPath
-} from '../lib/index.js';
-
-/**
- * Run WordPress CSS Audit
- * 
- * @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 audit({
-	spinner,
-	debug
-} ) {
-    
-    let files = [];
-
-    process.argv.slice(3).forEach( (paths, i) => {
-        let resolvePath = path.resolve(paths);
-        try {
-            // if given path is a directory
-            if( fs.statSync(resolvePath).isDirectory() ){
-                // get all .css files
-                getAllFilesSync(path.resolve(resolvePath)).toArray().forEach(f => {
-                    if( f.endsWith('.css') ){
-                        files.push(f)
-                    }
-                })
-            // if given path is a file and a .css file
-            }else if( fs.statSync(paths).isFile() && paths.endsWith('.css') ){
-                files.push(paths)
-            }
-        // invalid path/file
-        } catch (error) {
-
-        }
-
-    });
-    
-    // if no files were passed 
-    if( ! files.length ){
-        // if the default build directory exists we audit it
-        if( fs.existsSync(path.resolve('build')) ){
-            // get all .css files in build folder
-            getAllFilesSync(path.resolve('build')).toArray().forEach(f => {
-                if( f.endsWith('.css') ){
-                    files.push(f)
-                }
-            })
-        }
-    }   
-
-    // if files are to be audited.
-    if( files.length ){
-        let auditArgs = [
-            ...files
-        ];
-
-        // default audits.
-        let audits = [
-            'colors',
-            'alphas',
-            'important',
-            'display-none',
-            'selectors',
-            'media-queries',
-            'typography',
-            [ 'property-values', 'font-size' ],
-            [ 'property-values', 'padding,padding-top,padding-bottom,padding-right,padding-left' ],
-            [ 'property-values', 'margin,margin-top,marin-bottom,marin-right,marin-left' ]
-        ]
-        
-        audits.forEach(a => {
-            let audit = Array.isArray(a) ? a[0] : a;
-
-            if( ! process.argv.includes(`--no-${audit}`) ){
-                if( Array.isArray(a) ){
-                    auditArgs.push(`--${audit}=` + a.splice(1).join(','))
-                }else{
-                    auditArgs.push(`--${audit}`)
-                }
-            }
-        })
-               
-        const auditConfigPath = fs.existsSync(path.join(appPath, 'css-audit.config.cjs')) ? 
-            appPath :
-            path.join(projectPath, 'configs')
-
-
-        await runCmd(
-            'auditor', 
-            auditArgs,
-            {
-                cwd: auditConfigPath
-            }
-        ).then(({stderr, stdout}) => {
-            // Audit result handling.
-            if( stderr ){
-                console.log( stderr.toString())
-            }
-            if( stdout ){
-                let msg = stdout.toString().replace('undefined', '');
-            
-                if( 'audit' === process.argv[2] ){
-                    console.log( msg )
-                }else{
-                    return msg;
-                }
-
-            }
-        })
-            
-    }else{
-        spinner.warn('No file(s) or directory path(s) were given.');
-        spinner.warn('Default build directory was not found.');
-        spinner.warn('Auditor did not execute.');
-    }
-
-};

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/configs/css-audit.config.cjs

@@ -1,9 +0,0 @@
-/**
- * External dependencies
- */
-
-
-module.exports = {
-	format: 'html',
-	filename: 'css-audit'
-};

package/docs/CREDITS.MD

@@ -1,32 +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)
-
-### <ins>css-audit</ins>
-[Documentation](https://developer.wordpress.org/coding-standards/wordpress-coding-standards/css/)  
-[Documentation](https://make.wordpress.org/core/2021/05/17/introducing-the-wordpress-css-audit-tool/)  
-[Github](https://github.com/wordpress/css-audit)   

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,20 +0,0 @@
-# Roadmap Features:
-## Validation with:
-
-- SNYK  
-    https://www.npmjs.com/package/snyk
-- CSS-Audit  
-    https://github.com/wordpress/css-audit
-
-## Testaro
-https://www.npmjs.com/package/testaro  
-
-## Sonarqube Scanner
-https://www.npmjs.com/package/sonarqube-scanner
-
-## BrowserStack
-https://www.npmjs.com/package/browserstack
-
-## Control Panel
-https://aapanel.com/new/download.html
-

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')
-	);
-
-};

package/gen/parser.js

@@ -1,166 +0,0 @@
-/**
- * External dependencies
- */
-import fs from 'fs';
-import path from 'path';
-import { HTMLToJSON } from 'html-to-json-parser';
-import jsdom from 'jsdom';
-
-/**
- * Internal dependencies
- */
-
-/**
- * Path Directory Locations
- * - appPath - Project Application Path
- * - srcPath - Project Application Src Path
- * - publicPath - Project Application Public Path
- * - dataPath - Project Application Data Path
- */
-const appPath = path.resolve(process.cwd());
-const srcPath = path.join( appPath, 'src');
-const dataPath = path.join( srcPath, 'data');
-const assetsPath = path.join( srcPath, 'assets');
-
-const fallbackPath = path.join( appPath, 'node_modules', '@cdt', 'template');
-
-/**
- * Generate Pages
- *
- * @async
- * @param {Object} siteData Data to use when creating pages
- * @returns {string}
- */
-async function generatePages(siteData){
-
-  // we start with a blank html and schema
-  let page = '<html><html>';
-  let schema = {};
-
-  // if src/index.html exists
-  if(fs.existsSync(path.join(srcPath, 'index.html'))){
-
-    // get index path file location
-    page = path.join(srcPath, 'index.html')
-      
-    // generate page schema
-    schema = await convertHTMLtoJson(page, false);
-
-    // read contents of index file, we strip any newlines
-    //page = fs.readFileSync( page ).toString().replace(/\n[\s]+/g,'');
-  }
-
-  // convert page to jsdom object
-  let dom = new jsdom.JSDOM( page );
-  
-  // if we should be using the template
-  if( process.env.CDT_TEMPLATE ){
-
-    // read contents of template index file, we strip any newlines
-    page = fs.readFileSync( path.join(fallbackPath, 'src', 'index.html') ).toString().replace(/\n[\s]+/g,'');
-      
-    // create template jsdom object
-    let templateDom = new jsdom.JSDOM( page );
-    
-    // colorscheme
-    let colorCSS = path.join(fallbackPath, 'build', 'oceanside.css');
-    let colorJS = path.join(fallbackPath, 'build', 'oceanside.js');
-
-    dom.window.document.querySelector('head').append(
-      `<link rel="stylesheet" type="text/css" href="${colorCSS}">`
-    );
-
-
-    // update template dom by appending contents of existing dom body
-    // after the header 
-    templateDom.window.document.querySelector('header').append(
-      dom.window.document.querySelector('body')
-    );
-
-    // update existing dom with templated changes.
-    dom = new jsdom.JSDOM( templateDom.window.document.documentElement.outerHTML);
-  }
-  
-  // generate any data attributes
-  populateDataAttrs( dom, siteData, schema );
-  
-  return dom.window.document.documentElement.outerHTML;
-
-}
-
-
-/**
- * Populate data-cagov attributes with siteData
- * 
- * @param {jsdom.JSDOM} dom HTML 
- * @param {Object} siteData
- * @param {Object} schema
- */
-function populateDataAttrs(dom, siteData, schema){
-  for( const [attr, data] of Object.entries(siteData) ){
-    // if attribute isn't in the schema don't do anything
-    if( ! schema.data || ! Object.keys(schema.data).includes(attr) ){
-      continue;
-    }
-
-    // any data- attributes should be prefixed with cagov
-    // get any elements with the appropriate data- attr 
-    let elements = dom.window.document.querySelectorAll(`[data-cagov-${attr}]`);
-
-    // if the data is an array|object pass as data
-    let value = Array.isArray(data) || 'object' === typeof data  ? JSON.stringify( data ) : data;
-
-    elements.forEach(element => {
-      element.setAttribute(`data-cagov-${attr}`, value);
-    });
-
-  }
-}
-
-
-/**
- * Generates a page schema including any data attributes in src/data/index.json
- *
- * @async
- * @param {*} file
- * @param {boolean} [write=true]
- * @param {string} [outputPath='']
- * @returns {unknown}
- */
-async function convertHTMLtoJson( file, write = true, outputPath = '' ){
-      if( fs.existsSync( file )){
-        let template = fs.readFileSync( file ).toString().replace(/\n[\s]+/g,'');
-        let markup = await HTMLToJSON(template, false )
-          
-        let data = fs.existsSync( path.join(dataPath, 'index.json') ) ?
-          JSON.parse( fs.readFileSync( path.join(dataPath, 'index.json') ) ) : {};
-
-        // remove any examples data
-        delete data.examples;
-
-        let schema = {
-          title: "California Department of Technology Schema",
-          $schema: "http://json-schema.org/2019-09/schema",
-          $id: "https://json-schema.org/draft/2019-09/schema",
-          type: "object",
-          description: "California Department of Technology Schema",
-          data,
-          markup,
-        };
-
-        // Write schema file.
-        if( write ){
-          fs.writeFileSync(
-            path.join(outputPath, 'schema.json'),
-              JSON.stringify( schema, null, 4 )
-          );
-        }else{
-          return schema;
-        }
-        
-      }
-}
-
-export {
-  generatePages
-};