@haxtheweb/create 9.0.18 → 9.0.20

package/README.md

@@ -63,12 +63,18 @@ Commands:
   help [command]                 display help for command
 ```
 
-## Site  context
+## 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
+## Web component context
 - launch element
 
 # Alternative Usage
@@ -83,7 +89,6 @@ npm init @haxtheweb
   "scripts": {
     "hax": "hax"
   }
-}
 ```
 
 ```bash
@@ -94,6 +99,15 @@ npm run hax -- --name my-element --y
 ## Windows problems?
 Try setting a different cache path to load from `npm config set cache C:\tmp\nodejs\npm-cache --global`
 
+If you wish to use PowerShell over Command Prompt, you may need to change your execution policy to allow scripts using the `Set-ExecutionPolicy` command with the `-ExecutionPolicy` and `-Scope` parameters. You should **not** need to do this if you are using Command Prompt.
+
+```powershell
+# To see your current execution policy
+Get-ExecutionPolicy
+```
+
+`Set-ExecutionPolicy` command documentation: https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.security/set-executionpolicy?view=powershell-7.4
+
 Follow the prompts and let's HAX the Web together!
 
 ## Web component

package/dist/create.js

@@ -61,7 +61,7 @@ async function main() {
       commandRun.arguments.action = action;
       commandRun.options.skip = true;
     }
-  }).option('--path <char>', 'path the project should be created in').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('--no-i', 'prevent interactions / sub-process, good for scripting').option('--to-file <char>', 'redirect command output to a file').option('--item-import <char>', 'import items from a file / site').version(await HAXCMS.getHAXCMSVersion());
+  }).option('--path <char>', 'path the project should be created in').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('--no-i', 'prevent interactions / sub-process, good for scripting').option('--title-scrape <char>', 'CSS Selector for `title` in resource').option('--content-scrape <char>', 'CSS Selector for `body` in resource').option('--to-file <char>', 'redirect command output to a file').option('--item-import <char>', 'import items from a file / site').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}`);
@@ -351,7 +351,7 @@ async function main() {
             results
           }) => {
             let themes = await (0, _site.siteThemeList)();
-            if (!commandRun.options.theme) {
+            if (results.type === "site" && !commandRun.options.theme) {
               // support having no theme but autoselecting
               if (!commandRun.options.auto && !commandRun.options.skip) {
                 commandRun.options.theme = themes[0];

package/dist/docs/hax.1

@@ -0,0 +1,153 @@
+.TH HAX\-CREATE 1 hax 9.0.18 "HAX COMMAND INTERFACE MANUAL"
+
+.SH NAME
+hax \- a tool to create HAX websites and web components quickly.
+
+.SH SYNOPSIS
+hax [options] [command]
+
+.SH DESCRIPTION
+HAX seeks to be the smallest possible back-end CMS to make HAX work and be able to build websites with it. Leveraging JSON Outline Schema, HAX is able to author multiple pages, which it then writes onto the file system. This way a slim server layer is just for basic authentication, knowing how to save files, and placing them in version control.
+
+This command line tool can be used to create and modify two different HAX based file structures. Web components (essentially custom HTML tags) using Lit or HAX Single-Sites (a single website editable in the browser with the CMS tools)
+
+.SH COMMANDS
+.PP
+.B start
+\- Interactive program to pick options
+.PP
+.B site
+[options] [action] \- Create a HAX website
+.PP
+.B webcomponent
+[options] [name] \- Create Lit based web components, with HAX recommendations
+.PP
+.B help
+[command] \- Display help for command
+
+.SH OPTIONS
+.TP
+\--v
+Verbose output
+.TP
+\--debug
+Output for developers
+.TP
+\--format [format]
+Output format\; json (default), yaml
+.TP
+\--path [path]
+Where to perform operation
+.TP
+\--npm\-client [client]
+NPM client to use (must be installed); npm (default), yarn, pnpm
+.TP
+\--y, \--auto
+Yes to all questions
+.TP
+\--skip
+Skip extras (e.g. animations) in tool
+.TP
+\--quiet
+Remove console logging
+.TP
+\--no\-i
+Prevent interactions / sub\-process, good for scripting
+.TP
+\--to\-file [char]
+Redirect command output to a file
+.TP
+\--org [organization]
+Organization for package.json
+.TP
+\--author [author]
+Author for site / package.json
+.TP
+\--writeHaxProperties
+Write haxProperties for the element
+.TP
+\--import\-site [url]
+URL of site to import
+.TP
+\--import\-structure [method]
+Import method to use: pressbooksToSite | elsmlnToSite | haxcmsToSite | notionToSite | gitbookToSite | evolutionToSite | htmlToSite | docxToSite
+.TP
+\--node\-op [operation]
+Node operation to perform
+.TP
+\--item\-id [id]
+Node ID to operate on
+.TP
+\--name [name]
+Name of the project
+.TP
+\--domain [name]
+Published domain name
+.TP
+\--items\-import [char]
+Import items from a file / site
+.TP
+\--title [title]
+Title
+.TP
+\--content [content]
+Page content
+.TP
+\--slug [slug]
+Path (slug)
+.TP
+\--published [status]
+Publishing status
+.TP
+\--tags [tag]
+Tags
+.TP
+\--parent [parent]
+Parent
+.TP
+\--order [order]
+Order
+.TP
+\--theme [theme]
+Theme
+.TP
+\--hide\-in\-menu [char]
+Hide in menu
+.TP
+\-h, \--help
+Display help for command
+
+.SH EXAMPLES
+.TP
+.B hax start
+Navigatable interface
+.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) 
+
+.SH BUGS
+Bugs can be viewed at GitHub Issues: https://github.com/haxtheweb/issues/issues
+
+Bugs can also be submitted through Merlin on a HAX Site (in the browser) by typing "Issue" to jump start a report!
+
+.SH EXTRA
+.PP
+.B Website: 
+https://haxtheweb.org/
+.PP
+.B CLI Repository: 
+https://github.com/haxtheweb/create
+.PP
+.B Web Components Repository:
+https://github.com/haxtheweb/webcomponents
+
+.SH AUTHORS
+.PP
+.B CLI Contributors:
+https://github.com/haxtheweb/create/graphs/contributors
+.PP
+.B Web Components Contributors:
+https://github.com/haxtheweb/webcomponents/graphs/contributors

package/dist/templates/webcomponent/hax/package.json

@@ -27,9 +27,9 @@
       "test:watch": "web-test-runner test/**/*.test.js --node-resolve --watch"
     },
     "dependencies": {
-      "lit": "^3.2.0",
-      "@haxtheweb/d-d-d": "^9.0.13",
-      "@haxtheweb/i18n-manager": "^9.0.13"
+      "lit": "^3.2.1",
+      "@haxtheweb/d-d-d": "^9.0.21",
+      "@haxtheweb/i18n-manager": "^9.0.18"
     },
     "devDependencies": {
       "@babel/preset-env": "^7.16.4",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@haxtheweb/create",
-  "version": "9.0.18",
+  "version": "9.0.20",
   "publishConfig": {
     "access": "public"
   },
@@ -26,6 +26,9 @@
     "dev": "nodemon --watch src",
     "haxcms-nodejs": "haxcms-nodejs"
   },
+  "man": [
+    "./dist/docs/hax.1"
+  ],
   "bin": {
     "create-haxtheweb": "./dist/create.js",
     "hax": "./dist/create.js"