@caweb/cli 1.3.16 → 1.4.0

package/README.md

@@ -195,5 +195,6 @@ Arguments:
 
 Options:
   -h, --help         display help for command
-  -t,--tax [tax...]  Taxonomy that should be synced. Omitting this option will sync the full site. (choices: "pages", "posts", "media", "menus")
+  -i, --include [include...]     IDs to of taxonomies to include. Omitting this option will sync all items for given taxonomy.
+  -t, --tax [tax...]  Taxonomy that should be synced. Omitting this option will sync the full site. (choices: "pages", "posts", "media", "menus")
 </pre>

package/commands/serve.js

@@ -39,6 +39,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 +48,7 @@ export default async function serve({
    let webPackArgs = [
       'serve',
       '--open',
-      '--mode=development',
+      '--mode=none',
       '--config',
       defaultConfig
     ];
@@ -72,7 +74,14 @@ 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{
+            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/CREDITS.MD

@@ -0,0 +1,27 @@
+# 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

@@ -0,0 +1,7 @@
+# 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

@@ -0,0 +1,53 @@
+## [.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

@@ -0,0 +1,19 @@
+# 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

@@ -0,0 +1,29 @@
+# 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

@@ -0,0 +1,45 @@
+'use strict';
+
+
+/**
+ * External dependencies
+ */
+import path from 'node:path';
+import fs from 'fs-extra';
+
+import { CAWEB_OPTIONS, DIVI_OPTIONS } from '../../lib/options.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/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/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@caweb/cli",
-  "version": "1.3.16",
+  "version": "1.4.0",
   "description": "CAWebPublishing Command Line Interface.",
   "exports": "./lib/env.js",
   "type": "module",
   "node": ">=20",
+  "main": "./lib/env.js",
   "author": "CAWebPublishing",
   "license": "ISC",
   "bin": {
@@ -15,6 +16,7 @@
     "bin",
     "commands",
     "configs",
+    "docs",
     "gen",
     "lib",
     "template"
@@ -22,13 +24,13 @@
   "scripts": {
     "test": "echo \"Error: run tests from root\" && exit 0"
   },
-  "homepage": "https://github.com/CAWebPublishing/caweb-cli#readme",
+  "homepage": "https://github.com/CAWebPublishing/cli#readme",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/CAWebPublishing/caweb-cli.git"
+    "url": "git+https://github.com/CAWebPublishing/cli.git"
   },
   "bugs": {
-    "url": "https://github.com/CAWebPublishing/caweb-cli/issues"
+    "url": "https://github.com/CAWebPublishing/cli/issues"
   },
   "keywords": [
     "caweb",
@@ -38,7 +40,7 @@
     "access": "public"
   },
   "config": {
-    "WP_VER": "6.4.3",
+    "WP_VER": "6.5.4",
     "PHP_VER": "8.1",
     "DEFAULTS": {
       "FS_METHOD": "direct",
@@ -56,29 +58,30 @@
     }
   },
   "dependencies": {
-    "@wordpress/create-block": "^4.32.0",
-    "@wordpress/env": "^9.6.0",
-    "@wordpress/scripts": "^27.5.0",
-    "accessibility-checker": "^3.1.68",
+    "@wordpress/create-block": "^4.43.0",
+    "@wordpress/env": "^10.0.0",
+    "@wordpress/scripts": "^28.0.0",
+    "accessibility-checker": "^3.1.72",
     "autoprefixer": "^10.4.19",
-    "axios": "^1.6.8",
-    "axios-retry": "^4.1.0",
+    "axios": "^1.7.2",
+    "axios-retry": "^4.4.0",
     "chalk": "^5.3.0",
-    "commander": "^12.0.0",
+    "commander": "^12.1.0",
     "cross-spawn": "^7.0.3",
-    "css-loader": "^6.10.0",
-    "docker-compose": "^0.24.7",
+    "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",
-    "mini-css-extract-plugin": "^2.8.1",
+    "mini-css-extract-plugin": "^2.9.0",
     "ora": "^8.0.1",
     "postcss-loader": "^8.1.1",
     "resolve-bin": "^1.0.1",
-    "sass-loader": "^14.1.1",
+    "sass-loader": "^14.2.1",
     "terminal-link": "^3.0.0",
     "url": "^0.11.3",
-    "webpack": "^5.91.0"
+    "webpack": "^5.92.0"
   }
 }