feat: print help without title for doc (#146)

* feat: print help without title for doc

* feat: more help

* fix: recursive imports

* fix: dev help

* chore: fmt

src/commands/dev.ts

@@ -1,8 +1,8 @@
 import {red} from 'kleur';
+import {logHelpDev} from '../help/dev.help';
 import {build} from '../services/build.services';
 import {start, stop} from '../services/docker.services';
 import {eject} from '../services/eject.services';
-import {helpDev} from './help';
 
 export const dev = async (args?: string[]) => {
   const [subCommand] = args ?? [];
@@ -22,6 +22,6 @@ export const dev = async (args?: string[]) => {
       break;
     default:
       console.log(`${red('Unknown subcommand.')}`);
-      console.log(helpDev);
+      logHelpDev();
   }
 };

src/commands/upgrade.ts

@@ -1,9 +1,9 @@
 import {nextArg} from '@junobuild/cli-tools';
 import {red} from 'kleur';
+import {logHelpUpgrade} from '../help/upgrade.help';
 import {upgradeMissionControl} from '../services/upgrade/upgrade.mission-control.services';
 import {upgradeOrbiters} from '../services/upgrade/upgrade.orbiter.services';
 import {upgradeSatellite} from '../services/upgrade/upgrade.satellite.services';
-import {helpUpgrade} from './help';
 
 export const upgrade = async (args?: string[]) => {
   const target = nextArg({args, option: '-t'}) ?? nextArg({args, option: '--target'});
@@ -23,6 +23,6 @@ export const upgrade = async (args?: string[]) => {
       break;
     default:
       console.log(`${red('Unknown target.')}`);
-      console.log(helpUpgrade);
+      logHelpUpgrade();
   }
 };

src/help/clear.help.ts

@@ -0,0 +1,31 @@
+import {cyan, green, yellow} from 'kleur';
+import {helpMode, helpOutput} from './common.help';
+import {TITLE} from './help';
+
+export const CLEAR_DESCRIPTION =
+  'Clear existing dapp code by removing JavaScript, HTML, CSS, and other files from your satellite.';
+
+const usage = `Usage: ${green('juno')} ${cyan('clear')} ${yellow('[options]')}
+
+Options:
+  ${yellow('-f, --fullPath')}        Clear a particular file of your dapp.
+  ${helpMode}
+  ${yellow('-h, --help')}            Output usage information.`;
+
+const doc = `${CLEAR_DESCRIPTION}
+
+\`\`\`bash
+${usage}
+\`\`\`
+`;
+
+const help = `${TITLE}
+
+${CLEAR_DESCRIPTION}
+
+${usage}
+`;
+
+export const logHelpClear = (args?: string[]) => {
+  console.log(helpOutput(args) === 'doc' ? doc : help);
+};

src/help/common.help.ts

@@ -0,0 +1,7 @@
+import {hasArgs} from '@junobuild/cli-tools';
+import {yellow} from 'kleur';
+
+export const helpMode = `${yellow('-m, --mode')}            Set env mode. For example production or a custom string. Default is production.`;
+
+export const helpOutput = (args?: string[]): 'doc' | 'cli' =>
+  hasArgs({args, options: ['-d', '--doc']}) ? 'doc' : 'cli';

src/help/config.help.ts

@@ -0,0 +1,29 @@
+import {cyan, green, yellow} from 'kleur';
+import {helpMode, helpOutput} from './common.help';
+import {TITLE} from './help';
+
+export const CONFIG_DESCRIPTION = 'Apply configuration to satellite.';
+
+const usage = `Usage: ${green('juno')} ${cyan('config')} ${yellow('[options]')}
+
+Options:
+  ${helpMode}
+  ${yellow('-h, --help')}            Output usage information.`;
+
+const doc = `${CONFIG_DESCRIPTION}
+
+\`\`\`bash
+${usage}
+\`\`\`
+`;
+
+const help = `${TITLE}
+
+${CONFIG_DESCRIPTION}
+
+${usage}
+`;
+
+export const logHelpConfig = (args?: string[]) => {
+  console.log(helpOutput(args) === 'doc' ? doc : help);
+};

src/help/deploy.help.ts

@@ -0,0 +1,30 @@
+import {cyan, green, yellow} from 'kleur';
+import {helpMode, helpOutput} from './common.help';
+import {TITLE} from './help';
+
+export const DEPLOY_DESCRIPTION = 'Deploy your dapp to your satellite.';
+
+const usage = `Usage: ${green('juno')} ${cyan('deploy')} ${yellow('[options]')}
+
+Options:
+  ${yellow('-c, --clear')}           Clear existing dapp files before proceeding with deployment.
+  ${helpMode}
+  ${yellow('-h, --help')}            Output usage information.`;
+
+const doc = `${DEPLOY_DESCRIPTION}
+
+\`\`\`bash
+${usage}
+\`\`\`
+`;
+
+const help = `${TITLE}
+
+${DEPLOY_DESCRIPTION}
+
+${usage}
+`;
+
+export const logHelpDeploy = (args?: string[]) => {
+  console.log(helpOutput(args) === 'doc' ? doc : help);
+};

src/help/dev.help.ts

@@ -0,0 +1,42 @@
+import {cyan, green, magenta} from 'kleur';
+import {helpOutput} from './common.help';
+import {TITLE} from './help';
+
+export const DEV_DESCRIPTION =
+  'Handle development-related tasks such as building and deploying locally using Cargo and Docker.';
+
+const helpDevBuild = `${magenta('build')}               Compile satellite features using Cargo.`;
+const helpDevStart = `${magenta(
+  'start'
+)}               Start a local Internet Computer network, encapsulated in a Docker environment.`;
+
+export const helpDevContinue = `${helpDevBuild}
+  ${helpDevStart}`;
+
+const usage = `Usage: ${green('juno')} ${cyan('dev')} ${magenta('<subcommand>')}
+
+Subcommands:
+  ${helpDevBuild}
+  ${magenta(
+    'eject'
+  )}               Create a Rust template for custom satellite feature hooks and extensions.
+  ${helpDevStart}
+  ${magenta('stop')}                Stop the Docker environment.`;
+
+const doc = `${DEV_DESCRIPTION}
+
+\`\`\`bash
+${usage}
+\`\`\`
+`;
+
+const help = `${TITLE}
+
+${DEV_DESCRIPTION}
+
+${usage}
+`;
+
+export const logHelpDev = (args?: string[]) => {
+  console.log(helpOutput(args) === 'doc' ? doc : help);
+};