@haxtheweb/create 10.0.4 → 10.0.5

package/README.md

@@ -22,6 +22,7 @@ hax start
 - `hax webcomponent my-element --y` - Make a new HAX capable, i18n wired, Design system (DDD) driven web component
   -  if in a monorepo root, will place in correct location / inherit settings
 - `hax site mysite --y` - create a new HAXsite (HAXcms, single site)
+- `hax audit` - Audits web components for compliance with DDD (HAX design system)
 
 ## --help
 Run `hax help` or `hax webcomponent --help` or `hax site --help` for up-to-date listing
@@ -30,53 +31,74 @@ Usage: hax [options] [command]
 
 Options:
   --
-  --v                            Verbose output for developers
-  --path <char>                  where to perform operation
-  --npm-client <char>            npm client to use (must be installed) npm,
-                                 yarn, pnpm (default: "npm")
-  --y                            yes to all questions
-  --skip                         skip frills like animations
-  --auto                         yes to all questions, alias of y
-  --org <char>                   organization for package.json
-  --author <char>                author for site / package.json
-  --import-site <char>           URL of site to import
-  --node-op <char>               node operation to perform
-  --item-id <char>               node ID to operate on
-  --name <char>                  name of the project
-  --domain <char>                published domain name
-  --title <char>                 Title
-  --content <char>               Page content
-  --slug <char>                  Path (slug)
-  --published <char>             Publishing status
-  --tags <char>                  Tags
-  --parent <char>                Parent
-  --order <char>                 Order
-  --theme <char>                 Theme
-  --hide-in-menu <char>          Hide in menu
-  -h, --help                     display help for command
+  --v                             Verbose output
+  --debug                         Output for developers
+  --format <char>                 Output format; json (default), yaml
+  --path <char>                   where to perform operation
+  --npm-client <char>             npm client to use (must be installed) npm,
+                                  yarn, pnpm (default: "npm")
+  --y                             yes to all questions
+  --skip                          skip frills like animations
+  --quiet                         remove console logging
+  --auto                          yes to all questions, alias of y
+  --no-i                          prevent interactions / sub-process, good for
+                                  scripting
+  --to-file <char>                redirect command output to a file
+  --no-extras                     skip all extra / automatic command processing
+  --root <char>                   root location to execute the command from
+  --org <char>                    organization for package.json
+  --author <char>                 author for site / package.json
+  --writeHaxProperties            Write haxProperties for the element
+  --import-site <char>            URL of site to import
+  --import-structure <char>       import method to use:
+                                  pressbooksToSite
+                                  elmslnToSite
+                                  haxcmsToSite
+                                  notionToSite
+                                  gitbookToSite
+                                  evolutionToSite
+                                  htmlToSite
+                                  docxToSite
+  --node-op <char>                node operation to perform
+  --item-id <char>                node ID to operate on
+  --name <char>                   name of the project
+  --domain <char>                 published domain name
+  --title-scrape <char>           CSS Selector for `title` in resource
+  --content-scrape <char>         CSS Selector for `body` in resource
+  --items-import <char>           import items from a file / site
+  --recipe <char>                 path to recipe file
+  --custom-theme-name <char>      custom theme name
+  --custom-theme-template <char>  custom theme template; (options: base,
+                                  polaris-flex, polaris-sidebar)
+  -V, --version                   output the version number
+  --title <char>                  Title
+  --content <char>                Page content
+  --slug <char>                   Path (slug)
+  --published <char>              Publishing status
+  --tags <char>                   Tags
+  --parent <char>                 Parent
+  --order <char>                  Order
+  --theme <char>                  Theme
+  --hide-in-menu <char>           Hide in menu
+  -h, --help                      display help for command
 
 Commands:
-  start                          Interactive program to pick options
-  site [options] [action]
-  webcomponent [options] [name]  Create Lit based web components, with HAX
-                                 recommendations
-  help [command]                 display help for command
+  start                           Select which hax sub-program to run
+  site [options] [action]         create or administer a HAXsite
+  webcomponent [options] [name]   Create Lit based web components, with HAX
+                                  recommendations
+  audit [options]                 Audits web components for compliance with DDD
+                                  (HAX Design System)
+  help [command]                  display help for command
 ```
-
+## Examples
+For a detailed list of example commands that you can perform with `hax` see [examples](examples.md).
 ## Manual
 
 ### Linux / macOS
 
 Run `man hax` to get detailed manual.
 
-## Site context
-- listing stats
-- launch site
-- publish to surge.sh (if installed)
-
-## Web component context
-- launch element
-
 # Alternative Usage
 
 ```bash
@@ -128,9 +150,58 @@ Build a HAX site that can be published and transported anywhere. Your users migh
 - Theme development starting point to be able to build themes locally
 - Primed to publish to gh-pages, vercel and more
 
+## HAX Audit
+Audits your HAX based web components to suggest improvements to better align with DDD, the design system built into HAX components.
+- Use `.dddignore` file to instruct audit program what files should be ignored. Each component generated comes with a `.dddignore` file in its root directory.
+- Run command from root of the component project.
+- Provides suggested changes for component CSS to align with DDD design standards, if a change cannot be suggested, developer will be refered to look at the manual for a change that works for them!
+
+### `.dddignore` Template
+
+```gitignore
+# Directories
+# (Must start with with / or \, as seen below)
+/.github # Inline comments are supported
+/.vscode
+/.idea
+/locales
+\test
+/dist
+/build
+/public # ignored by program regardless of presence in .dddignore
+/node_modules # ignored by program regardless of presence in .dddignore
+
+# Files 
+# (Must include filename and extension, as seen below)
+LICENSE
+.dddignore
+.editorconfig
+.gitignore
+.nojekyll
+.npmignore
+.surgeignore
+rollup.config.js
+
+# File extension
+# (Must start with *, as seen below)
+*.html
+*.md
+*.yml
+*.json
+*.toml
+*.mjs
+*.cjs
+*.png
+*.ico
+*.svg
+*.jpg
+*.jpeg
+```
+
 # Get Help / Issues / Support
 - Discord Channel - https://bit.ly/hax-discord
 - Unified issue queue - https://github.com/haxtheweb/issues/issues
+- DDD Documentation - https://haxtheweb.org/documentation/ddd
 - Using Merlin directly in any HAX spaces and type "Issue" to jump start a report!
 
 ## Watch and Learn more about HAX here:

package/dist/create.js

@@ -8,6 +8,7 @@ var p = _interopRequireWildcard(require("@clack/prompts"));
 var _picocolors = _interopRequireDefault(require("picocolors"));
 var _statements = require("./lib/statements.js");
 var _logging = require("./lib/logging.js");
+var _audit = require("./lib/programs/audit.js");
 var _webcomponent = require("./lib/programs/webcomponent.js");
 var _site = require("./lib/programs/site.js");
 var _utils = require("./lib/utils.js");
@@ -61,7 +62,7 @@ async function main() {
       commandRun.arguments.action = action;
       commandRun.options.skip = true;
     }
-  }).option('--v', 'Verbose output').option('--debug', 'Output for developers').option('--format <char>', 'Output format; json (default), yaml').option('--path <char>', 'where to perform operation').option('--npm-client <char>', 'npm client to use (must be installed) npm, yarn, pnpm', 'npm').option('--y', 'yes to all questions').option('--skip', 'skip frills like animations').option('--quiet', 'remove console logging').option('--auto', 'yes to all questions, alias of y').option('--no-i', 'prevent interactions / sub-process, good for scripting').option('--to-file <char>', 'redirect command output to a file').option('--no-extras', 'skip all extra / automatic command processing').option('--root <char>', 'root location to execute the command from').option('--import-site <char>', 'URL of site to import').option('--import-structure <char>', `import method to use:\n\rpressbooksToSite\n\relmslnToSite\n\rhaxcmsToSite\n\rnotionToSite\n\rgitbookToSite\n\revolutionToSite\n\rhtmlToSite\n\rdocxToSite`).option('--name <char>', 'name of the site (when creating a new one)').option('--domain <char>', 'published domain name').option('--node-op <char>', 'node operation to perform').option('--title-scrape <char>', 'CSS Selector for `title` in resource').option('--content-scrape <char>', 'CSS Selector for `body` in resource').option('--item-import <char>', 'import items from a file / site').option('--recipe <char>', 'path to recipe file').option('--custom-theme-name <char>', 'custom theme name').option('--custom-theme-template <char>', 'custom theme template (options: base, polaris-flex, polaris-sidebar)').version(await HAXCMS.getHAXCMSVersion());
+  }).option('--v', 'Verbose output').option('--debug', 'Output for developers').option('--format <char>', 'Output format; json (default), yaml').option('--path <char>', 'where to perform operation').option('--npm-client <char>', 'npm client to use (must be installed) npm, yarn, pnpm', 'npm').option('--y', 'yes to all questions').option('--skip', 'skip frills like animations').option('--quiet', 'remove console logging').option('--auto', 'yes to all questions, alias of y').option('--no-i', 'prevent interactions / sub-process, good for scripting').option('--to-file <char>', 'redirect command output to a file').option('--no-extras', 'skip all extra / automatic command processing').option('--root <char>', 'root location to execute the command from').option('--import-site <char>', 'URL of site to import').option('--import-structure <char>', `import method to use:\n\rpressbooksToSite\n\relmslnToSite\n\rhaxcmsToSite\n\rnotionToSite\n\rgitbookToSite\n\revolutionToSite\n\rhtmlToSite\n\rdocxToSite`).option('--name <char>', 'name of the site (when creating a new one)').option('--domain <char>', 'published domain name').option('--node-op <char>', 'node operation to perform').option('--title-scrape <char>', 'CSS Selector for `title` in resource').option('--content-scrape <char>', 'CSS Selector for `body` in resource').option('--items-import <char>', 'import items from a file / site').option('--recipe <char>', 'path to recipe file').option('--custom-theme-name <char>', 'custom theme name').option('--custom-theme-template <char>', 'custom theme template (options: base, polaris-flex, polaris-sidebar)').version(await HAXCMS.getHAXCMSVersion());
   let siteNodeOps = (0, _site.siteNodeOperations)();
   for (var i in siteNodeOps) {
     _commander.program.option(`--${(0, _utils.camelToDash)(siteNodeOps[i].value)} <char>`, `${siteNodeOps[i].label}`);
@@ -80,6 +81,16 @@ async function main() {
       commandRun.options.skip = true;
     }
   }).option('--path <char>', 'path the project should be created in').option('--org <char>', 'organization for package.json').option('--author <char>', 'author for site / package.json').option('--writeHaxProperties', 'Write haxProperties for the element').option('--to-file <char>', 'redirect command output to a file').option('--no-extras', 'skip all extra / automatic command processing').option('--no-i', 'prevent interactions / sub-process, good for scripting').option('--root <char>', 'root location to execute the command from').version(await HAXCMS.getHAXCMSVersion());
+
+  // audit program
+  _commander.program.command('audit').description('Audits web components for compliance with DDD (HAX design system)').action(() => {
+    commandRun = {
+      command: 'audit',
+      arguments: {},
+      options: {}
+    };
+  }).option('--debug', 'Output for developers').version(await HAXCMS.getHAXCMSVersion());
+
   // process program arguments
   _commander.program.parse();
   commandRun.options = {
@@ -168,13 +179,17 @@ async function main() {
           commandRun.options.isMonorepo = true;
           commandRun.options.auto = true;
           // assumed if monorepo
-          commandRun.command = 'webcomponent';
-          commandRun.options.path = path.join(process.cwd(), packageData.workspaces.packages[0].replace('/*', ''));
-          if (packageData.orgNpm) {
-            commandRun.options.org = packageData.orgNpm;
+          if (commandRun.command === "audit") {
+            (0, _audit.auditCommandDetected)(commandRun);
+          } else {
+            commandRun.command = 'webcomponent';
+            commandRun.options.path = path.join(process.cwd(), packageData.workspaces.packages[0].replace('/*', ''));
+            if (packageData.orgNpm) {
+              commandRun.options.org = packageData.orgNpm;
+            }
+            commandRun.options.gitRepo = packageData.repository.url;
+            commandRun.options.author = packageData.author.name ? packageData.author.name : author;
           }
-          commandRun.options.gitRepo = packageData.repository.url;
-          commandRun.options.author = packageData.author.name ? packageData.author.name : author;
         }
       } catch (err) {
         console.error(err);
@@ -189,6 +204,8 @@ async function main() {
     commandRun.program = 'site';
     commandRun.options.skip = true;
     await (0, _site.siteCommandDetected)(commandRun);
+  } else if (commandRun.command === 'audit') {
+    (0, _audit.auditCommandDetected)(commandRun);
   } else if (packageData && (packageData.customElements || packageData.hax && packageData.hax.cli) && packageData.scripts.start) {
     commandRun.program = 'webcomponent';
     commandRun.options.skip = true;
@@ -220,7 +237,7 @@ async function main() {
           options: {}
         };
       }
-      if (['site', 'webcomponent'].includes(commandRun.command)) {
+      if (['site', 'webcomponent', 'audit'].includes(commandRun.command)) {
         project = {
           type: commandRun.command
         };

package/dist/docs/hax.1

@@ -1,4 +1,4 @@
-.TH HAX\-CREATE 1 hax 9.0.18 "HAX COMMAND INTERFACE MANUAL"
+.TH HAX\-CREATE 1 hax hax "HAX COMMAND INTERFACE MANUAL"
 
 .SH NAME
 hax \- a tool to create HAX websites and web components quickly.
@@ -22,6 +22,9 @@ This command line tool can be used to create and modify two different HAX based
 .B webcomponent
 [options] [name] \- Create Lit based web components, with HAX recommendations
 .PP
+.B audit
+[options] \- Audits web components for compliance with DDD (HAX design system)
+.PP
 .B help
 [command] \- Display help for command
 
@@ -57,6 +60,12 @@ Prevent interactions / sub\-process, good for scripting
 \--to\-file [char]
 Redirect command output to a file
 .TP
+\--no\-extras
+Skip all extra / automatic commmand processing
+.TP
+\--root [location]
+Root location to execute the command from
+.TP
 \--org [organization]
 Organization for package.json
 .TP
@@ -84,9 +93,27 @@ Name of the project
 \--domain [name]
 Published domain name
 .TP
+\--title\-scrape [selector]
+CSS selector for `title` in resource
+.TP
+\--content\-scrape [selector[
+CSS selector for `body` in resource
+.TP
 \--items\-import [char]
 Import items from a file / site
 .TP
+\--recipe [path]
+Path to recipe file
+.TP
+\--custom\-theme\-name [name]
+Custom theme name
+.TP
+\--custom\-theme\-template [option]
+Custom theme template (Options: base | polaris-flex | polaris-sidebar)
+.TP
+\-V, \--version
+Output the version number
+.TP
 \--title [title]
 Title
 .TP
@@ -122,11 +149,14 @@ Display help for command
 .B hax start
 Navigatable interface
 .TP
+.B hax site mysite --y
+Create a new HAXsite (HAXcms, single site) 
+.TP
 .B hax webcomponent my-element --y
 Make a new HAX capable, i18n wired, design system (DDD) driven web component
 .TP
-.B hax site mysite --y
-Create a new HAXsite (HAXcms, single site) 
+.B hax audit
+Audit web components for compliance with DDD (HAX design system)
 
 .SH BUGS
 Bugs can be viewed at GitHub Issues: https://github.com/haxtheweb/issues/issues
@@ -143,6 +173,10 @@ https://github.com/haxtheweb/create
 .PP
 .B Web Components Repository:
 https://github.com/haxtheweb/webcomponents
+.PP
+.B DDD Design System Documentation
+https://haxtheweb.org/documentation/ddd
+
 
 .SH AUTHORS
 .PP

package/dist/lib/micro-frontend-registry.js

@@ -8,7 +8,7 @@ exports.enableCoreServices = enableCoreServices;
 exports.enableExperimentalServices = enableExperimentalServices;
 exports.enableHAXcmsServices = enableHAXcmsServices;
 exports.enableServices = enableServices;
-var _statements = require("./statements.js");
+var _logging = require("./logging.js");
 // because node hates mixing modern web at times this is a fork of @haxtheweb/micro-frontend-registry
 // and can fall out of date
 /**
@@ -51,8 +51,8 @@ const MicroFrontendRegCapabilities = function (SuperClass) {
      */
     define(item) {
       if (!(item instanceof MicroFrontend)) {
-        (0, _statements.log)("MicroFrontendRegistry: use class MicroFrontend instance but if keys match it will register still.", 'warn');
-        (0, _statements.log)(item, 'warn');
+        (0, _logging.log)("MicroFrontendRegistry: use class MicroFrontend instance but if keys match it will register still.", 'warn');
+        (0, _logging.log)(item, 'warn');
       }
       // validate item has all keys we care about
       if (Object.keys(item).every(key => MicroFrontendKeys.includes(key))) {
@@ -103,7 +103,7 @@ const MicroFrontendRegCapabilities = function (SuperClass) {
         }
       }
       if (!testOnly) {
-        (0, _statements.log)(`call for ${name} but not found in micro-frontend-registry`, 'error');
+        (0, _logging.log)(`call for ${name} but not found in micro-frontend-registry`, 'error');
       }
       return null;
     }
@@ -171,7 +171,7 @@ const MicroFrontendRegCapabilities = function (SuperClass) {
                 data: null
               };
             }).catch((e, d) => {
-              (0, _statements.log)("Request failed", 'warn');
+              (0, _logging.log)("Request failed", 'warn');
               // this is endpoint completely failed to respond
               return {
                 status: 500,
@@ -191,7 +191,7 @@ const MicroFrontendRegCapabilities = function (SuperClass) {
                 data: null
               };
             }).catch((e, d) => {
-              (0, _statements.log)("Request failed", 'warn');
+              (0, _logging.log)("Request failed", 'warn');
               // this is endpoint completely failed to respond
               return {
                 status: 500,