@haxtheweb/create 11.0.7 → 25.0.0

package/README.md

@@ -1,4 +1,9 @@
+[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
+[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/haxtheweb/create/badge)](https://securityscorecards.dev/viewer/?uri=github.com/haxtheweb/create)
+[![Community Support](https://badgen.net/badge/support/community/cyan?icon=awesome)](/SUPPORT.md)
 [![License: Apache 2.0](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](/CODE_OF_CONDUCT.md)
+[![Discord](https://badgen.net/badge/icon/discord?icon=discord&label)](https://discord.gg/EKYJAjqGhf)
 [![Lit](https://img.shields.io/badge/-Lit-324fff?style=flat&logo=data:image/svg%2bxml;base64,PHN2ZyBmaWxsPSIjZmZmIiB2aWV3Qm94PSIwIDAgMTYwIDIwMCIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj48cGF0aCBkPSJtMTYwIDgwdjgwbC00MC00MHptLTQwIDQwdjgwbDQwLTQwem0wLTgwdjgwbC00MC00MHptLTQwIDQwdjgwbDQwLTQwem0tNDAtNDB2ODBsNDAtNDB6bTQwLTQwdjgwbC00MC00MHptLTQwIDEyMHY4MGwtNDAtNDB6bS00MC00MHY4MGw0MC00MHoiLz48L3N2Zz4%3D)](https://lit.dev/)
 [![#HAXTheWeb](https://img.shields.io/badge/-HAXTheWeb-999999FF?style=flat&logo=data:image/svg%2bxml;base64,PHN2ZyBpZD0iZmVhMTExZTAtMjEwZC00Y2QwLWJhMWQtZGZmOTQyODc0Njg1IiBkYXRhLW5hbWU9IkxheWVyIDEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgdmlld0JveD0iMCAwIDE4NC40IDEzNS45NyI+PGRlZnM+PHN0eWxlPi5lMWJjMjAyNS0xODAwLTRkYzItODc4NS1jNDZlZDEwM2Y0OTJ7ZmlsbDojMjMxZjIwO308L3N0eWxlPjwvZGVmcz48cGF0aCBjbGFzcz0iZTFiYzIwMjUtMTgwMC00ZGMyLTg3ODUtYzQ2ZWQxMDNmNDkyIiBkPSJNNzguMDcsODMuNDVWNTVIODYuMnY4LjEzaDE2LjI2djQuMDdoNC4wN1Y4My40NUg5OC40VjY3LjE5SDg2LjJWODMuNDVaIi8+PHBvbHlnb24gcG9pbnRzPSIxNTMuMTMgNjMuNyAxNTMuMTMgNTEuMzkgMTQwLjU0IDUxLjM5IDE0MC41NCAzOS4wOSAxMjcuOTUgMzkuMDkgMTI3Ljk1IDI2Ljc5IDEwMi43OCAyNi43OSAxMDIuNzggMzkuMDkgMTE1LjM2IDM5LjA5IDExNS4zNiA1MS4zOSAxMjcuOTUgNTEuMzkgMTI3Ljk1IDYzLjcgMTQwLjU0IDYzLjcgMTQwLjU0IDc2IDEyNy4zNiA3NiAxMjcuMzYgODguMyAxMTQuNzggODguMyAxMTQuNzggMTAwLjYxIDEwMi4xOSAxMDAuNjEgMTAyLjE5IDExMi45MSAxMjcuMzYgMTEyLjkxIDEyNy4zNiAxMDAuNjEgMTM5Ljk1IDEwMC42MSAxMzkuOTUgODguMyAxNTIuNTQgODguMyAxNTIuNTQgNzYgMTY1LjcyIDc2IDE2NS43MiA2My43IDE1My4xMyA2My43Ii8+PHBvbHlnb24gcG9pbnRzPSIzMy4xMyA2My43IDMzLjEzIDUxLjM5IDQ1LjcyIDUxLjM5IDQ1LjcyIDM5LjA5IDU4LjMxIDM5LjA5IDU4LjMxIDI2Ljc5IDgzLjQ4IDI2Ljc5IDgzLjQ4IDM5LjA5IDcwLjg5IDM5LjA5IDcwLjg5IDUxLjM5IDU4LjMxIDUxLjM5IDU4LjMxIDYzLjcgNDUuNzIgNjMuNyA0NS43MiA3NiA1OC44OSA3NiA1OC44OSA4OC4zIDcxLjQ4IDg4LjMgNzEuNDggMTAwLjYxIDg0LjA3IDEwMC42MSA4NC4wNyAxMTIuOTEgNTguODkgMTEyLjkxIDU4Ljg5IDEwMC42MSA0Ni4zMSAxMDAuNjEgNDYuMzEgODguMyAzMy43MiA4OC4zIDMzLjcyIDc2IDIwLjU0IDc2IDIwLjU0IDYzLjcgMzMuMTMgNjMuNyIvPjwvc3ZnPg==)](https://haxtheweb.org/)
 [![Published on npm](https://img.shields.io/npm/v/@haxtheweb/create?style=flat)](https://www.npmjs.com/package/@haxtheweb/create)
@@ -23,6 +28,8 @@ hax start
   -  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)
+- `hax update` - HAX CLI self update
+- `hax party` - Display options to join the HAX community and get involved!
 
 ## --help
 Run `hax help` or `hax webcomponent --help` or `hax site --help` for up-to-date listing

package/dist/create.js

@@ -52,11 +52,14 @@ async function main() {
   _commander.program.option('--').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('--name <char>', 'name of the project/web component').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')
 
   // options for webcomponent
-  .option('--org <char>', 'organization for package.json').option('--author <char>', 'author for site / package.json').option('--writeHaxProperties', 'Write haxProperties for the element')
+  .option('--org <char>', 'organization for package.json').option('--author <char>', 'author for site / package.json').option('--writeHaxProperties', 'Write haxProperties for the element').option('--force', 'force creation even if name exists in registry')
 
   // options for site
   .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('--node-op <char>', 'node operation to perform').option('--item-id <char>', 'node ID to operate on').option('--domain <char>', 'published domain name').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)')
 
+  // options for rsync
+  .option('--source <char>', 'rsync source directory or remote path').option('--destination <char>', 'rsync destination directory or remote path').option('--exclude <char>', 'comma-separated patterns to exclude from rsync').option('--dry-run', 'perform rsync dry run').option('--delete', 'delete extraneous files from destination')
+
   // options for party
   .option('--repos <char...>', 'repositories to clone').version(_package.default.version).helpCommand(true);
 
@@ -100,7 +103,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('--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(_package.default.version);
+  }).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)').option('--source <char>', 'rsync source directory or remote path').option('--destination <char>', 'rsync destination directory or remote path').option('--exclude <char>', 'comma-separated patterns to exclude from rsync').option('--dry-run', 'perform rsync dry run').option('--delete', 'delete extraneous files from destination').version(_package.default.version);
   let siteNodeOps = (0, _site.siteNodeOperations)();
   for (var i in siteNodeOps) {
     _commander.program.option(`--${(0, _utils.camelToDash)(siteNodeOps[i].value)} <char>`, `${siteNodeOps[i].label}`);
@@ -123,7 +126,7 @@ async function main() {
       commandRun.arguments.action = action;
       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('--name <char>', 'name of the web component').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(_package.default.version);
+  }).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('--name <char>', 'name of the web component').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').option('--force', 'force creation even if name exists in registry').version(_package.default.version);
 
   // audit program
   _commander.program.command('audit').description('Audits web components for compliance with DDD (HAX design system)').action(() => {
@@ -264,6 +267,7 @@ async function main() {
     }
     (0, _audit.auditCommandDetected)(commandRun, customPath);
   } else if (commandRun.command === 'party') {
+    commandRun.options.author = author;
     await (0, _party.partyCommandDetected)(commandRun);
   }
   // CLI works within context of the site if one is detected, otherwise we can do other things
@@ -452,7 +456,7 @@ async function main() {
                     return "Name must include at least one `-` and must not start or end name.";
                   }
                   // test that this is not an existing element we use in the registry
-                  if (results.type === "webcomponent" && wcReg[value]) {
+                  if (results.type === "webcomponent" && wcReg[value] && !commandRun.options.force) {
                     return "Name is already a web component in the wc-registry published for HAX.";
                   }
                   // Check for any other syntax errors
@@ -499,7 +503,7 @@ async function main() {
                 process.exit(1);
               }
               // test that this is not an existing element we use in the registry
-              if (results.type === "webcomponent" && wcReg[value]) {
+              if (results.type === "webcomponent" && wcReg[value] && !commandRun.options.force) {
                 _commander.program.error(_picocolors.default.red("Name is already a web component in the wc-registry published for HAX."));
                 process.exit(1);
               }

package/dist/docs/hax.1

@@ -14,19 +14,133 @@ This command line tool can be used to create and modify two different HAX based
 .SH COMMANDS
 .PP
 .B start
-\- Interactive program to pick options
+\- Select which hax sub\-program to run
+.PP
+.B update
+[options] \- hax cli self update
+.PP
+.B serve
+\- Launch HAXsite in development mode (http://localhost)
 .PP
 .B site
-[options] [action] \- Create a HAX website
+[options] [action] \- create or administer a HAXsite
+.RS
+Actions to perform on site include:
+.RS
+.B start
+\- Launch site in browser (http://localhost)
+.br
+.B serve
+\- Launch site in development mode
+.br
+.B node:stats
+\- Node Stats / data
+.br
+.B node:add
+\- Add a new page
+.br
+.B node:edit
+\- Edit a page
+.br
+.B node:delete
+\- Delete a page
+.br
+.B site:stats
+\- Site Status / stats
+.br
+.B site:items
+\- Site items
+.br
+.B site:items\-import
+\- Import items (JOS / site.json)
+.br
+.B site:list\-files
+\- List site files
+.br
+.B site:theme
+\- Change theme
+.br
+.B site:element
+\- Add new Lit component to custom/src
+.br
+.B site:html
+\- Full site as HTML
+.br
+.B site:md
+\- Full site as Markdown
+.br
+.B site:schema
+\- Full site as HAXElementSchema
+.br
+.B site:sync
+\- Sync git repo
+.br
+.B site:rsync
+\- Rsync site to remote/local directory
+.br
+.B site:surge
+\- Publish site to Surge.sh
+.br
+.B site:netlify
+\- Publish site to Netlify
+.br
+.B site:vercel
+\- Publish site to Vercel
+.br
+.B setup:github\-actions
+\- Setup GitHub Actions deployment
+.br
+.B setup:gitlab\-ci
+\- Setup GitLab CI deployment
+.br
+.B recipe:read
+\- Read recipe file
+.br
+.B recipe:play
+\- Play recipe file
+.br
+.B issue:general
+\- Issue: Submit an issue or suggestion
+.br
+.B issue:theme
+\- Issue: Suggest custom theme
+.RE
+.RE
 .PP
-.B webcomponent
-[options] [name] \- Create Lit based web components, with HAX recommendations
+.B wc | webcomponent
+[options] [action] \- Create Lit based web components, with HAX recommendations
+.RS
+Actions to perform on web component include:
+.RS
+.B start
+\- Launch project
+.br
+.B wc:stats
+\- Check status of web component
+.br
+.B wc:element
+\- Add new Lit component to existing project
+.br
+.B wc:haxproperties
+\- Write haxProperties schema
+.RE
+.RE
 .PP
 .B audit
 [options] \- Audits web components for compliance with DDD (HAX design system)
 .PP
+.B party
+[options] [action] \- Party time! Join the HAX community and get involved!
+.RS
+Actions to perform include:
+.RS
+.B test
+\- Test action
+.RE
+.RE
+.PP
 .B help
-[command] \- Display help for command
+[command] \- display help for command
 
 .SH OPTIONS
 .TP
@@ -34,129 +148,187 @@ This command line tool can be used to create and modify two different HAX based
 Verbose output
 .TP
 \--debug
-Output for developers
+output for developers
 .TP
-\--format [format]
-Output format\; json (default), yaml
+\--format <char>
+output format; json (default), yaml
 .TP
-\--path [path]
-Where to perform operation
+\--path <char>
+where to perform operation
 .TP
-\--npm\-client [client]
-NPM client to use (must be installed); npm (default), yarn, pnpm
+\--name <char>
+name of the project/web component
 .TP
-\--y, \--auto
-Yes to all questions
+\--npm\-client <char>
+npm client to use (must be installed) npm, yarn, pnpm (default: "npm")
+.TP
+\--y
+yes to all questions
 .TP
 \--skip
-Skip extras (e.g. animations) in tool
+skip frills like animations
 .TP
 \--quiet
-Remove console logging
+remove console logging
+.TP
+\--auto
+yes to all questions, alias of y
 .TP
 \--no\-i
-Prevent interactions / sub\-process, good for scripting
+prevent interactions / sub\-process, good for scripting
 .TP
-\--to\-file [char]
-Redirect command output to a file
+\--to\-file <char>
+redirect command output to a file
 .TP
 \--no\-extras
-Skip all extra / automatic commmand processing
+skip all extra / automatic command processing
 .TP
-\--root [location]
-Root location to execute the command from
+\--root <char>
+root location to execute the command from
 .TP
-\--org [organization]
-Organization for package.json
+\--org <char>
+organization for package.json
 .TP
-\--author [author]
-Author for site / package.json
+\--author <char>
+author for site / package.json
 .TP
 \--writeHaxProperties
-Write haxProperties for the element
+write haxProperties for the element
 .TP
-\--import\-site [url]
+\--import\-site <char>
 URL of site to import
 .TP
-\--import\-structure [method]
-Import method to use: pressbooksToSite | elsmlnToSite | haxcmsToSite | notionToSite | gitbookToSite | evolutionToSite | htmlToSite | docxToSite
+\--import\-structure <char>
+import method to use:
+.br
+pressbooksToSite
+.br
+elmslnToSite
+.br
+haxcmsToSite
+.br
+notionToSite
+.br
+gitbookToSite
+.br
+evolutionToSite
+.br
+htmlToSite
+.br
+docxToSite
+.TP
+\--node\-op <char>
+node operation to perform
+.TP
+\--item\-id <char>
+node ID to operate on
+.TP
+\--domain <char>
+published domain name
 .TP
-\--node\-op [operation]
-Node operation to perform
+\--title\-scrape <char>
+CSS Selector for `title` in resource
 .TP
-\--item\-id [id]
-Node ID to operate on
+\--content\-scrape <char>
+CSS Selector for `body` in resource
 .TP
-\--name [name]
-Name of the project
+\--items\-import <char>
+import items from a file / site
 .TP
-\--domain [name]
-Published domain name
+\--recipe <char>
+path to recipe file
 .TP
-\--title\-scrape [selector]
-CSS selector for `title` in resource
+\--custom\-theme\-name <char>
+custom theme name
 .TP
-\--content\-scrape [selector[
-CSS selector for `body` in resource
+\--custom\-theme\-template <char>
+custom theme template; (options: base, polaris\-flex, polaris\-sidebar)
 .TP
-\--items\-import [char]
-Import items from a file / site
+\--source <char>
+rsync source directory or remote path
 .TP
-\--recipe [path]
-Path to recipe file
+\--destination <char>
+rsync destination directory or remote path
 .TP
-\--custom\-theme\-name [name]
-Custom theme name
+\--exclude <char>
+comma\-separated patterns to exclude from rsync
 .TP
-\--custom\-theme\-template [option]
-Custom theme template (Options: base | polaris-flex | polaris-sidebar)
+\--dry\-run
+perform rsync dry run
+.TP
+\--delete
+delete extraneous files from destination
+.TP
+\--repos <char...>
+repositories to clone
 .TP
 \-V, \--version
-Output the version number
+output the version number
 .TP
-\--title [title]
-Title
+\--title <char>
+title
 .TP
-\--content [content]
-Page content
+\--content <char>
+page content
 .TP
-\--slug [slug]
-Path (slug)
+\--slug <char>
+path (slug)
 .TP
-\--published [status]
-Publishing status
+\--published <char>
+publishing status
 .TP
-\--tags [tag]
-Tags
+\--tags <char>
+tags
 .TP
-\--parent [parent]
-Parent
+\--parent <char>
+parent
 .TP
-\--order [order]
-Order
+\--order <char>
+order
 .TP
-\--theme [theme]
-Theme
+\--theme <char>
+theme
 .TP
-\--hide\-in\-menu [char]
-Hide in menu
+\--hide\-in\-menu <char>
+hide in menu
 .TP
 \-h, \--help
-Display help for command
+display help for command
 
 .SH EXAMPLES
 .TP
 .B hax start
-Navigatable interface
+Navigatable interface to select which hax sub\-program to run
+.TP
+.B hax site mysite \--y
+Create a new HAXsite (HAXcms, single site) with automatic yes to all questions
 .TP
-.B hax site mysite --y
-Create a new HAXsite (HAXcms, single site) 
+.B hax site mysite \--path /var/www \--author "John Doe"
+Create a new HAXsite in a specific path with custom author
 .TP
-.B hax webcomponent my-element --y
+.B hax webcomponent my\-element \--y
 Make a new HAX capable, i18n wired, design system (DDD) driven web component
 .TP
-.B hax audit
-Audit web components for compliance with DDD (HAX design system)
+.B hax wc my\-button \--org @mycompany \--author "Developer Name"
+Create a web component with specific organization and author
+.TP
+.B hax serve
+Launch HAXsite in development mode (http://localhost)
+.TP
+.B hax site site:theme \--theme polaris\-flex
+Change the theme of an existing site
+.TP
+.B hax site node:add \--title "New Page" \--content "Page content"
+Add a new page to an existing site
+.TP
+.B hax audit \--debug
+Audit web components for compliance with DDD (HAX design system) with debug output
+.TP
+.B hax party \--repos haxtheweb/webcomponents
+Join the HAX community by cloning specific repositories
+.TP
+.B hax update \--y
+Update HAX CLI to the latest version automatically
 
 .SH BUGS
 Bugs can be viewed at GitHub Issues: https://github.com/haxtheweb/issues/issues