actions_help.html

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8" />
    <title>Mixin: actions/help | Generator</title>

    <script src="scripts/prettify/prettify.js"></script>
    <script src="scripts/prettify/lang-css.js"></script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/bootstrap.min.css" />
    <link type="text/css" rel="stylesheet" href="styles/prettify-jsdoc.css" />
    <link
      type="text/css"
      rel="stylesheet"
      href="styles/prettify-tomorrow.css"
    />
    <link type="text/css" rel="stylesheet" href="styles/tui-doc.css" />
  </head>
  <body>
    <nav class="lnb" id="lnb">
      <div class="logo" style="width: 127px; height: 14px">
        <img
          src="https://raw.githubusercontent.com/yeoman/yeoman.github.io/source/app/assets/img/logo.png"
          width="100%"
          height="100%"
        />
      </div>
      <div class="title">
        <h1><a href="index.html" class="link">Generator</a></h1>

        <span class="version">v5.8.0</span>
      </div>
      <div class="search-container" id="search-container">
        <input type="text" placeholder="Search" />
        <ul></ul>
      </div>

      <div class="lnb-api hidden">
        <h3>Modules</h3>
        <ul>
          <li>
            <a href="module-promptSuggestion.html">promptSuggestion</a>
            <button type="button" class="hidden toggle-subnav btn btn-link">
              <span class="glyphicon glyphicon-plus"></span>
            </button>
            <div class="hidden" id="module:promptSuggestion_sub"></div>
          </li>
        </ul>
      </div>
      <div class="lnb-api hidden">
        <h3>Classes</h3>
        <ul>
          <li>
            <a href="Generator.html">Generator</a>
            <button type="button" class="hidden toggle-subnav btn btn-link">
              <span class="glyphicon glyphicon-plus"></span>
            </button>
            <div class="hidden" id="Generator_sub">
              <div class="member-type">Members</div>
              <ul class="inner">
                <li><a href="Generator.html#config">config</a></li>
                <li><a href="Generator.html#packageJson">packageJson</a></li>
              </ul>
              <div class="member-type">Methods</div>
              <ul class="inner">
                <li>
                  <a href="Generator.html#_templateData">_templateData</a>
                </li>
                <li>
                  <a href="Generator.html#addDependencies">addDependencies</a>
                </li>
                <li>
                  <a href="Generator.html#addDevDependencies">
                    addDevDependencies
                  </a>
                </li>
                <li><a href="Generator.html#argument">argument</a></li>
                <li>
                  <a href="Generator.html#argumentsHelp">argumentsHelp</a>
                </li>
                <li>
                  <a href="Generator.html#cancelCancellableTasks">
                    cancelCancellableTasks
                  </a>
                </li>
                <li><a href="Generator.html#composeWith">composeWith</a></li>
                <li>
                  <a href="Generator.html#copyDestination">copyDestination</a>
                </li>
                <li><a href="Generator.html#copyTemplate">copyTemplate</a></li>
                <li>
                  <a href="Generator.html#copyTemplateAsync">
                    copyTemplateAsync
                  </a>
                </li>
                <li>
                  <a href="Generator.html#createStorage">createStorage</a>
                </li>
                <li><a href="Generator.html#debug">debug</a></li>
                <li>
                  <a href="Generator.html#deleteDestination">
                    deleteDestination
                  </a>
                </li>
                <li><a href="Generator.html#desc">desc</a></li>
                <li>
                  <a href="Generator.html#destinationPath">destinationPath</a>
                </li>
                <li>
                  <a href="Generator.html#destinationRoot">destinationRoot</a>
                </li>
                <li>
                  <a href="Generator.html#determineAppname">determineAppname</a>
                </li>
                <li><a href="Generator.html#git.email">git.email</a></li>
                <li>
                  <a href="Generator.html#existsDestination">
                    existsDestination
                  </a>
                </li>
                <li><a href="Generator.html#getFeatures">getFeatures</a></li>
                <li><a href="Generator.html#help">help</a></li>
                <li>
                  <a href="Generator.html#moveDestination">moveDestination</a>
                </li>
                <li><a href="Generator.html#git.name">git.name</a></li>
                <li><a href="Generator.html#option">option</a></li>
                <li><a href="Generator.html#optionsHelp">optionsHelp</a></li>
                <li><a href="Generator.html#prompt">prompt</a></li>
                <li><a href="Generator.html#queueMethod">queueMethod</a></li>
                <li><a href="Generator.html#queueTask">queueTask</a></li>
                <li>
                  <a href="Generator.html#queueTaskGroup">queueTaskGroup</a>
                </li>
                <li><a href="Generator.html#queueTasks">queueTasks</a></li>
                <li>
                  <a href="Generator.html#queueTransformStream">
                    queueTransformStream
                  </a>
                </li>
                <li>
                  <a href="Generator.html#readDestination">readDestination</a>
                </li>
                <li>
                  <a href="Generator.html#readDestinationJSON">
                    readDestinationJSON
                  </a>
                </li>
                <li><a href="Generator.html#readTemplate">readTemplate</a></li>
                <li>
                  <a href="Generator.html#registerConfigPrompts">
                    registerConfigPrompts
                  </a>
                </li>
                <li>
                  <a href="Generator.html#registerPriorities">
                    registerPriorities
                  </a>
                </li>
                <li>
                  <a href="Generator.html#renderTemplate">renderTemplate</a>
                </li>
                <li>
                  <a href="Generator.html#renderTemplateAsync">
                    renderTemplateAsync
                  </a>
                </li>
                <li>
                  <a href="Generator.html#renderTemplates">renderTemplates</a>
                </li>
                <li>
                  <a href="Generator.html#renderTemplatesAsync">
                    renderTemplatesAsync
                  </a>
                </li>
                <li>
                  <a href="Generator.html#rootGeneratorName">
                    rootGeneratorName
                  </a>
                </li>
                <li>
                  <a href="Generator.html#rootGeneratorVersion">
                    rootGeneratorVersion
                  </a>
                </li>
                <li><a href="Generator.html#run">run</a></li>
                <li><a href="Generator.html#setFeatures">setFeatures</a></li>
                <li><a href="Generator.html#sourceRoot">sourceRoot</a></li>
                <li><a href="Generator.html#spawnCommand">spawnCommand</a></li>
                <li>
                  <a href="Generator.html#spawnCommandSync">spawnCommandSync</a>
                </li>
                <li><a href="Generator.html#startOver">startOver</a></li>
                <li><a href="Generator.html#templatePath">templatePath</a></li>
                <li><a href="Generator.html#usage">usage</a></li>
                <li>
                  <a href="Generator.html#github.username">github.username</a>
                </li>
                <li>
                  <a href="Generator.html#writeDestination">writeDestination</a>
                </li>
                <li>
                  <a href="Generator.html#writeDestinationJSON">
                    writeDestinationJSON
                  </a>
                </li>
              </ul>
            </div>
          </li>
          <li>
            <a href="Storage.html">Storage</a>
            <button type="button" class="hidden toggle-subnav btn btn-link">
              <span class="glyphicon glyphicon-plus"></span>
            </button>
            <div class="hidden" id="Storage_sub">
              <div class="member-type">Methods</div>
              <ul class="inner">
                <li><a href="Storage.html#createProxy">createProxy</a></li>
                <li><a href="Storage.html#createStorage">createStorage</a></li>
                <li><a href="Storage.html#defaults">defaults</a></li>
                <li><a href="Storage.html#delete">delete</a></li>
                <li><a href="Storage.html#get">get</a></li>
                <li><a href="Storage.html#getAll">getAll</a></li>
                <li><a href="Storage.html#getPath">getPath</a></li>
                <li><a href="Storage.html#merge">merge</a></li>
                <li><a href="Storage.html#save">save</a></li>
                <li><a href="Storage.html#set">set</a></li>
                <li><a href="Storage.html#setPath">setPath</a></li>
              </ul>
            </div>
          </li>
        </ul>
      </div>
      <div class="lnb-api hidden">
        <h3>Mixins</h3>
        <ul>
          <li>
            <a href="actions_fs.html">actions/fs</a>
            <button type="button" class="hidden toggle-subnav btn btn-link">
              <span class="glyphicon glyphicon-plus"></span>
            </button>
            <div class="hidden" id="actions/fs_sub">
              <div class="member-type">Methods</div>
              <ul class="inner">
                <li>
                  <a href="actions_fs.html#._templateData">_templateData</a>
                </li>
                <li>
                  <a href="actions_fs.html#.copyDestination">copyDestination</a>
                </li>
                <li>
                  <a href="actions_fs.html#.copyTemplate">copyTemplate</a>
                </li>
                <li>
                  <a href="actions_fs.html#.copyTemplateAsync">
                    copyTemplateAsync
                  </a>
                </li>
                <li>
                  <a href="actions_fs.html#.deleteDestination">
                    deleteDestination
                  </a>
                </li>
                <li>
                  <a href="actions_fs.html#.existsDestination">
                    existsDestination
                  </a>
                </li>
                <li>
                  <a href="actions_fs.html#.moveDestination">moveDestination</a>
                </li>
                <li>
                  <a href="actions_fs.html#.readDestination">readDestination</a>
                </li>
                <li>
                  <a href="actions_fs.html#.readDestinationJSON">
                    readDestinationJSON
                  </a>
                </li>
                <li>
                  <a href="actions_fs.html#.readTemplate">readTemplate</a>
                </li>
                <li>
                  <a href="actions_fs.html#.renderTemplate">renderTemplate</a>
                </li>
                <li>
                  <a href="actions_fs.html#.renderTemplateAsync">
                    renderTemplateAsync
                  </a>
                </li>
                <li>
                  <a href="actions_fs.html#.renderTemplates">renderTemplates</a>
                </li>
                <li>
                  <a href="actions_fs.html#.renderTemplatesAsync">
                    renderTemplatesAsync
                  </a>
                </li>
                <li>
                  <a href="actions_fs.html#.writeDestination">
                    writeDestination
                  </a>
                </li>
                <li>
                  <a href="actions_fs.html#.writeDestinationJSON">
                    writeDestinationJSON
                  </a>
                </li>
              </ul>
            </div>
          </li>
          <li>
            <a href="actions_help.html">actions/help</a>
            <button type="button" class="hidden toggle-subnav btn btn-link">
              <span class="glyphicon glyphicon-plus"></span>
            </button>
            <div class="hidden" id="actions/help_sub">
              <div class="member-type">Methods</div>
              <ul class="inner">
                <li>
                  <a href="actions_help.html#.argumentsHelp">argumentsHelp</a>
                </li>
                <li><a href="actions_help.html#.desc">desc</a></li>
                <li><a href="actions_help.html#.help">help</a></li>
                <li>
                  <a href="actions_help.html#.optionsHelp">optionsHelp</a>
                </li>
                <li><a href="actions_help.html#.usage">usage</a></li>
              </ul>
            </div>
          </li>
          <li>
            <a href="actions_install.html">actions/install</a>
            <button type="button" class="hidden toggle-subnav btn btn-link">
              <span class="glyphicon glyphicon-plus"></span>
            </button>
            <div class="hidden" id="actions/install_sub">
              <div class="member-type">Methods</div>
              <ul class="inner">
                <li>
                  <a href="actions_install.html#.bowerInstall">bowerInstall</a>
                </li>
                <li>
                  <a href="actions_install.html#.installDependencies">
                    installDependencies
                  </a>
                </li>
                <li>
                  <a href="actions_install.html#.npmInstall">npmInstall</a>
                </li>
                <li>
                  <a href="actions_install.html#.scheduleInstallTask">
                    scheduleInstallTask
                  </a>
                </li>
                <li>
                  <a href="actions_install.html#.yarnInstall">yarnInstall</a>
                </li>
              </ul>
            </div>
          </li>
          <li>
            <a href="actions_package-json.html">actions/package-json</a>
            <button type="button" class="hidden toggle-subnav btn btn-link">
              <span class="glyphicon glyphicon-plus"></span>
            </button>
            <div class="hidden" id="actions/package-json_sub">
              <div class="member-type">Methods</div>
              <ul class="inner">
                <li>
                  <a href="actions_package-json.html#addDependencies">
                    addDependencies
                  </a>
                </li>
                <li>
                  <a href="actions_package-json.html#addDevDependencies">
                    addDevDependencies
                  </a>
                </li>
              </ul>
            </div>
          </li>
          <li>
            <a href="actions_spawn-command.html">actions/spawn-command</a>
            <button type="button" class="hidden toggle-subnav btn btn-link">
              <span class="glyphicon glyphicon-plus"></span>
            </button>
            <div class="hidden" id="actions/spawn-command_sub">
              <div class="member-type">Methods</div>
              <ul class="inner">
                <li>
                  <a href="actions_spawn-command.html#.spawnCommand">
                    spawnCommand
                  </a>
                </li>
                <li>
                  <a href="actions_spawn-command.html#.spawnCommandSync">
                    spawnCommandSync
                  </a>
                </li>
              </ul>
            </div>
          </li>
          <li>
            <a href="actions_user.html">actions/user</a>
            <button type="button" class="hidden toggle-subnav btn btn-link">
              <span class="glyphicon glyphicon-plus"></span>
            </button>
            <div class="hidden" id="actions/user_sub">
              <div class="member-type">Methods</div>
              <ul class="inner">
                <li><a href="actions_user.html#.git.email">git.email</a></li>
                <li><a href="actions_user.html#.git.name">git.name</a></li>
                <li>
                  <a href="actions_user.html#.github.username">
                    github.username
                  </a>
                </li>
              </ul>
            </div>
          </li>
        </ul>
      </div>
      <div class="lnb-api hidden">
        <h3>Global</h3>
        <ul>
          <li class="hidden"><a href="global.html#Priority">Priority</a></li>
          <li><a href="global.html#proxyHandler">proxyHandler</a></li>
          <li class="hidden">
            <a href="global.html#QueueOptions">QueueOptions</a>
          </li>
          <li class="hidden"><a href="global.html#Task">Task</a></li>
          <li class="hidden">
            <a href="global.html#TaskOptions">TaskOptions</a>
          </li>
          <li class="hidden">
            <a href="global.html#WrappedMethod">WrappedMethod</a>
          </li>
        </ul>
      </div>
    </nav>
    <div id="resizer"></div>

    <div class="main" id="main">
      <section>
        <header>
          <h2>actions/help</h2>
        </header>

        <article>
          <div class="container-overview">
            <dl class="details"></dl>
          </div>

          <h3 class="subsection-title">Methods</h3>

          <dl>
            <dt>
              <h4 class="name" id=".argumentsHelp">
                <span class="type-signature">
                  <span class="icon green">static</span>
                </span>
                argumentsHelp
                <span class="signature">()</span>
                <span class="type-signature">&rarr; {String}</span>

                <div class="container-source members">
                  <code>
                    <a href="actions_help.js.html">actions/help.js</a>
                  </code>
                  ,
                  <code><a href="actions_help.js.html#line93">line 93</a></code>
                </div>
              </h4>
            </dt>
            <dd>
              <div class="description">
                <p>Get help text for arguments</p>
              </div>

              <div class="container-returns">
                <h5>Returns:</h5>

                <span class="param-type">String</span>

                -
                <p>Text of options in formatted table</p>
              </div>

              <dl class="details"></dl>
            </dd>

            <dt>
              <h4 class="name" id=".desc">
                <span class="type-signature">
                  <span class="icon green">static</span>
                </span>
                desc
                <span class="signature">(description)</span>
                <span class="type-signature"></span>

                <div class="container-source members">
                  <code>
                    <a href="actions_help.js.html">actions/help.js</a>
                  </code>
                  ,
                  <code><a href="actions_help.js.html#line84">line 84</a></code>
                </div>
              </h4>
            </dt>
            <dd>
              <div class="description">
                <p>
                  Simple setter for custom
                  <code>description</code>
                  to append on help output.
                </p>
              </div>

              <div class="container-params">
                <h5>Parameters:</h5>

                <table class="params">
                  <thead>
                    <tr>
                      <th>Name</th>

                      <th>Type</th>

                      <th class="last">Description</th>
                    </tr>
                  </thead>

                  <tbody>
                    <tr>
                      <td class="name"><code>description</code></td>

                      <td class="type">
                        <span class="param-type">String</span>
                      </td>

                      <td class="description last"></td>
                    </tr>
                  </tbody>
                </table>
              </div>

              <dl class="details"></dl>
            </dd>

            <dt>
              <h4 class="name" id=".help">
                <span class="type-signature">
                  <span class="icon green">static</span>
                </span>
                help
                <span class="signature">()</span>
                <span class="type-signature">&rarr; {String}</span>

                <div class="container-source members">
                  <code>
                    <a href="actions_help.js.html">actions/help.js</a>
                  </code>
                  ,
                  <code><a href="actions_help.js.html#line19">line 19</a></code>
                </div>
              </h4>
            </dt>
            <dd>
              <div class="description">
                <p>
                  Tries to get the description from a USAGE file one folder
                  above the source root otherwise uses a default description
                </p>
              </div>

              <div class="container-returns">
                <h5>Returns:</h5>

                <span class="param-type">String</span>

                -
                <p>Help message of the generator</p>
              </div>

              <dl class="details"></dl>
            </dd>

            <dt>
              <h4 class="name" id=".optionsHelp">
                <span class="type-signature">
                  <span class="icon green">static</span>
                </span>
                optionsHelp
                <span class="signature">()</span>
                <span class="type-signature">&rarr; {String}</span>

                <div class="container-source members">
                  <code>
                    <a href="actions_help.js.html">actions/help.js</a>
                  </code>
                  ,
                  <code>
                    <a href="actions_help.js.html#line111">line 111</a>
                  </code>
                </div>
              </h4>
            </dt>
            <dd>
              <div class="description">
                <p>Get help text for options</p>
              </div>

              <div class="container-returns">
                <h5>Returns:</h5>

                <span class="param-type">String</span>

                -
                <p>Text of options in formatted table</p>
              </div>

              <dl class="details"></dl>
            </dd>

            <dt>
              <h4 class="name" id=".usage">
                <span class="type-signature">
                  <span class="icon green">static</span>
                </span>
                usage
                <span class="signature">()</span>
                <span class="type-signature">&rarr; {String}</span>

                <div class="container-source members">
                  <code>
                    <a href="actions_help.js.html">actions/help.js</a>
                  </code>
                  ,
                  <code><a href="actions_help.js.html#line59">line 59</a></code>
                </div>
              </h4>
            </dt>
            <dd>
              <div class="description">
                <p>
                  Output usage information for this given generator, depending
                  on its arguments or options
                </p>
              </div>

              <div class="container-returns">
                <h5>Returns:</h5>

                <span class="param-type">String</span>

                -
                <p>Usage information of the generator</p>
              </div>

              <dl class="details"></dl>
            </dd>
          </dl>
        </article>
      </section>
    </div>

    <footer>
      <img
        class="logo"
        src="https://raw.githubusercontent.com/yeoman/yeoman.github.io/source/app/assets/img/logo.png"
        style="width: 127px; height: 14px"
      />
      <div class="footer-text">BSD license Copyright (c) Google</div>
    </footer>
    <script>
      prettyPrint();
    </script>
    <script src="scripts/jquery.min.js"></script>
    <script src="scripts/tui-doc.js"></script>
    <script src="scripts/linenumber.js"></script>

    <script>
      var id = "actions/help_sub".replace(/"/g, "_");
      var selectedApi = document.getElementById(id); // do not use jquery selector
      var $selectedApi = $(selectedApi);

      $selectedApi.removeClass("hidden");
      $selectedApi
        .parent()
        .find(".glyphicon")
        .removeClass("glyphicon-plus")
        .addClass("glyphicon-minus");
      showLnbApi();
    </script>
  </body>
</html>