deploy: 1acdb48

luckyframework · Sep 22, 2023 · bcee9d7 · bcee9d7
1 parent d2900a8
commit bcee9d7
Show file tree

Hide file tree

Showing 7 changed files with 94 additions and 100 deletions.
diff --git a/LuckyTask.html b/LuckyTask.html
@@ -127,14 +127,14 @@ <h2>
   </h2>
 
 
-      <a href="https://github.com/luckyframework/lucky_task/blob/c657bc5be5e955ff0959a0430208e1c92c24c7ef/src/lucky_task.cr#L5" target="_blank">
+      <a href="https://github.com/luckyframework/lucky_task/blob/1acdb4898eca1b9cab9824131d3ca80de63434ae/src/lucky_task.cr#L5" target="_blank">
         lucky_task.cr
       </a>
 
     <br/>
 
 
-      <a href="https://github.com/luckyframework/lucky_task/blob/c657bc5be5e955ff0959a0430208e1c92c24c7ef/src/lucky_task/text_helpers.cr#L1" target="_blank">
+      <a href="https://github.com/luckyframework/lucky_task/blob/1acdb4898eca1b9cab9824131d3ca80de63434ae/src/lucky_task/text_helpers.cr#L1" target="_blank">
         lucky_task/text_helpers.cr
       </a>
 

diff --git a/LuckyTask/Runner.html b/LuckyTask/Runner.html
@@ -143,7 +143,7 @@ <h2>
   </h2>
 
 
-      <a href="https://github.com/luckyframework/lucky_task/blob/c657bc5be5e955ff0959a0430208e1c92c24c7ef/src/lucky_task/runner.cr#L1" target="_blank">
+      <a href="https://github.com/luckyframework/lucky_task/blob/1acdb4898eca1b9cab9824131d3ca80de63434ae/src/lucky_task/runner.cr#L1" target="_blank">
         lucky_task/runner.cr
       </a>
 
@@ -197,7 +197,7 @@ <h2>
       </li>
 
       <li class="entry-summary">
-        <a href="#register_task%28task%3ALuckyTask%3A%3ATask%29%3ANil-class-method" class="signature"><strong>.register_task</strong>(task : LuckyTask::Task) : Nil</a>
+        <a href="#register_task%28task%3ALuckyTask%3A%3ATask.class%29%3ANil-class-method" class="signature"><strong>.register_task</strong>(task : <span class="t">LuckyTask</span><span class="t">::</span><span class="t">Task</span>.<span class="k">class</span>) : Nil</a>
 
       </li>
 
@@ -207,7 +207,7 @@ <h2>
       </li>
 
       <li class="entry-summary">
-        <a href="#tasks%3AArray%28LuckyTask%3A%3ATask%29-class-method" class="signature"><strong>.tasks</strong> : Array(LuckyTask::Task)</a>
+        <a href="#tasks%3AArray%28LuckyTask%3A%3ATask.class%29-class-method" class="signature"><strong>.tasks</strong> : Array(<span class="t">LuckyTask</span><span class="t">::</span><span class="t">Task</span>.<span class="k">class</span>)</a>
 
       </li>
 
@@ -271,7 +271,7 @@ <h2>
       <br/>
       <div>
 
-          [<a href="https://github.com/luckyframework/lucky_task/blob/c657bc5be5e955ff0959a0430208e1c92c24c7ef/src/lucky_task/runner.cr#L3" target="_blank">View source</a>]
+          [<a href="https://github.com/luckyframework/lucky_task/blob/1acdb4898eca1b9cab9824131d3ca80de63434ae/src/lucky_task/runner.cr#L3" target="_blank">View source</a>]
 
       </div>
     </div>
@@ -287,7 +287,7 @@ <h2>
       <br/>
       <div>
 
-          [<a href="https://github.com/luckyframework/lucky_task/blob/c657bc5be5e955ff0959a0430208e1c92c24c7ef/src/lucky_task/runner.cr#L3" target="_blank">View source</a>]
+          [<a href="https://github.com/luckyframework/lucky_task/blob/1acdb4898eca1b9cab9824131d3ca80de63434ae/src/lucky_task/runner.cr#L3" target="_blank">View source</a>]
 
       </div>
     </div>
@@ -303,7 +303,7 @@ <h2>
       <br/>
       <div>
 
-          [<a href="https://github.com/luckyframework/lucky_task/blob/c657bc5be5e955ff0959a0430208e1c92c24c7ef/src/lucky_task/runner.cr#L49" target="_blank">View source</a>]
+          [<a href="https://github.com/luckyframework/lucky_task/blob/1acdb4898eca1b9cab9824131d3ca80de63434ae/src/lucky_task/runner.cr#L49" target="_blank">View source</a>]
 
       </div>
     </div>
@@ -319,7 +319,7 @@ <h2>
       <br/>
       <div>
 
-          [<a href="https://github.com/luckyframework/lucky_task/blob/c657bc5be5e955ff0959a0430208e1c92c24c7ef/src/lucky_task/runner.cr#L39" target="_blank">View source</a>]
+          [<a href="https://github.com/luckyframework/lucky_task/blob/1acdb4898eca1b9cab9824131d3ca80de63434ae/src/lucky_task/runner.cr#L39" target="_blank">View source</a>]
 
       </div>
     </div>
@@ -335,7 +335,7 @@ <h2>
       <br/>
       <div>
 
-          [<a href="https://github.com/luckyframework/lucky_task/blob/c657bc5be5e955ff0959a0430208e1c92c24c7ef/src/lucky_task/runner.cr#L64" target="_blank">View source</a>]
+          [<a href="https://github.com/luckyframework/lucky_task/blob/1acdb4898eca1b9cab9824131d3ca80de63434ae/src/lucky_task/runner.cr#L67" target="_blank">View source</a>]
 
       </div>
     </div>
@@ -351,23 +351,23 @@ <h2>
       <br/>
       <div>
 
-          [<a href="https://github.com/luckyframework/lucky_task/blob/c657bc5be5e955ff0959a0430208e1c92c24c7ef/src/lucky_task/runner.cr#L68" target="_blank">View source</a>]
+          [<a href="https://github.com/luckyframework/lucky_task/blob/1acdb4898eca1b9cab9824131d3ca80de63434ae/src/lucky_task/runner.cr#L71" target="_blank">View source</a>]
 
       </div>
     </div>
 
-    <div class="entry-detail" id="register_task(task:LuckyTask::Task):Nil-class-method">
+    <div class="entry-detail" id="register_task(task:LuckyTask::Task.class):Nil-class-method">
       <div class="signature">
 
-        def self.<strong>register_task</strong>(task : <a href="../LuckyTask/Task.html">LuckyTask::Task</a>) : Nil
+        def self.<strong>register_task</strong>(task : <span class="t">LuckyTask</span><span class="t">::</span><span class="t">Task</span>.<span class="k">class</span>) : Nil
 
-        <a class="method-permalink" href="#register_task%28task%3ALuckyTask%3A%3ATask%29%3ANil-class-method">#</a>
+        <a class="method-permalink" href="#register_task%28task%3ALuckyTask%3A%3ATask.class%29%3ANil-class-method">#</a>
       </div>
 
       <br/>
       <div>
 
-          [<a href="https://github.com/luckyframework/lucky_task/blob/c657bc5be5e955ff0959a0430208e1c92c24c7ef/src/lucky_task/runner.cr#L7" target="_blank">View source</a>]
+          [<a href="https://github.com/luckyframework/lucky_task/blob/1acdb4898eca1b9cab9824131d3ca80de63434ae/src/lucky_task/runner.cr#L7" target="_blank">View source</a>]
 
       </div>
     </div>
@@ -383,23 +383,23 @@ <h2>
       <br/>
       <div>
 
-          [<a href="https://github.com/luckyframework/lucky_task/blob/c657bc5be5e955ff0959a0430208e1c92c24c7ef/src/lucky_task/runner.cr#L15" target="_blank">View source</a>]
+          [<a href="https://github.com/luckyframework/lucky_task/blob/1acdb4898eca1b9cab9824131d3ca80de63434ae/src/lucky_task/runner.cr#L15" target="_blank">View source</a>]
 
       </div>
     </div>
 
-    <div class="entry-detail" id="tasks:Array(LuckyTask::Task)-class-method">
+    <div class="entry-detail" id="tasks:Array(LuckyTask::Task.class)-class-method">
       <div class="signature">
 
-        def self.<strong>tasks</strong> : Array(<a href="../LuckyTask/Task.html">LuckyTask::Task</a>)
+        def self.<strong>tasks</strong> : Array(<span class="t">LuckyTask</span><span class="t">::</span><span class="t">Task</span>.<span class="k">class</span>)
 
-        <a class="method-permalink" href="#tasks%3AArray%28LuckyTask%3A%3ATask%29-class-method">#</a>
+        <a class="method-permalink" href="#tasks%3AArray%28LuckyTask%3A%3ATask.class%29-class-method">#</a>
       </div>
 
       <br/>
       <div>
 
-          [<a href="https://github.com/luckyframework/lucky_task/blob/c657bc5be5e955ff0959a0430208e1c92c24c7ef/src/lucky_task/runner.cr#L11" target="_blank">View source</a>]
+          [<a href="https://github.com/luckyframework/lucky_task/blob/1acdb4898eca1b9cab9824131d3ca80de63434ae/src/lucky_task/runner.cr#L11" target="_blank">View source</a>]
 
       </div>
     </div>
@@ -415,7 +415,7 @@ <h2>
       <br/>
       <div>
 
-          [<a href="https://github.com/luckyframework/lucky_task/blob/c657bc5be5e955ff0959a0430208e1c92c24c7ef/src/lucky_task/runner.cr#L53" target="_blank">View source</a>]
+          [<a href="https://github.com/luckyframework/lucky_task/blob/1acdb4898eca1b9cab9824131d3ca80de63434ae/src/lucky_task/runner.cr#L56" target="_blank">View source</a>]
 
       </div>
     </div>

diff --git a/LuckyTask/Task.html b/LuckyTask/Task.html
@@ -129,7 +129,7 @@ <h2>
   </h2>
 
 
-      <a href="https://github.com/luckyframework/lucky_task/blob/c657bc5be5e955ff0959a0430208e1c92c24c7ef/src/lucky_task/task.cr#L1" target="_blank">
+      <a href="https://github.com/luckyframework/lucky_task/blob/1acdb4898eca1b9cab9824131d3ca80de63434ae/src/lucky_task/task.cr#L1" target="_blank">
         lucky_task/task.cr
       </a>
 
@@ -159,11 +159,6 @@ <h2>
 
       </li>
 
-      <li class="entry-summary">
-        <a href="#summary%3AString-instance-method" class="signature"><strong>#summary</strong> : String</a>
-
-      </li>
-
   </ul>
 
 
@@ -192,6 +187,13 @@ <h2>
 
       </li>
 
+      <li class="entry-summary">
+        <a href="#help_message%28help_text%29-macro" class="signature"><strong>help_message</strong>(help_text)</a>
+
+          <div class="summary"><p>Customize your help message with the provided <code>help_text</code></p></div>
+
+      </li>
+
       <li class="entry-summary">
         <a href="#int32%28arg_name%2Cdescription%2Cshortcut%3Dnil%2Cdefault%3Dnil%29-macro" class="signature"><strong>int32</strong>(arg_name, description, shortcut = <span class="n">nil</span>, default = <span class="n">nil</span>)</a>
 
@@ -202,7 +204,7 @@ <h2>
       <li class="entry-summary">
         <a href="#name%28name_text%29-macro" class="signature"><strong>name</strong>(name_text)</a>
 
-          <div class="summary"><p><span class="flag red">DEPRECATED</span>  Use <code><a href="../LuckyTask/Task.html#task_name%28name_text%29-macro">task_name</a></code> instead</p></div>
+          <div class="summary"><p>Renames the task name for CLI use</p></div>
 
       </li>
 
@@ -216,6 +218,8 @@ <h2>
       <li class="entry-summary">
         <a href="#summary%28summary_text%29-macro" class="signature"><strong>summary</strong>(summary_text)</a>
 
+          <div class="summary"><p>The general description of what this task does</p></div>
+
       </li>
 
       <li class="entry-summary">
@@ -225,13 +229,6 @@ <h2>
 
       </li>
 
-      <li class="entry-summary">
-        <a href="#task_name%28name_text%29-macro" class="signature"><strong>task_name</strong>(name_text)</a>
-
-          <div class="summary"><p>Renames the task name for CLI use</p></div>
-
-      </li>
-
   </ul>
 
 
@@ -285,23 +282,7 @@ <h2>
       <br/>
       <div>
 
-          [<a href="https://github.com/luckyframework/lucky_task/blob/c657bc5be5e955ff0959a0430208e1c92c24c7ef/src/lucky_task/task.cr#L281" target="_blank">View source</a>]
-
-      </div>
-    </div>
-
-    <div class="entry-detail" id="summary:String-instance-method">
-      <div class="signature">
-        abstract 
-        def <strong>summary</strong> : String
-
-        <a class="method-permalink" href="#summary%3AString-instance-method">#</a>
-      </div>
-
-      <br/>
-      <div>
-
-          [<a href="https://github.com/luckyframework/lucky_task/blob/c657bc5be5e955ff0959a0430208e1c92c24c7ef/src/lucky_task/task.cr#L282" target="_blank">View source</a>]
+          [<a href="https://github.com/luckyframework/lucky_task/blob/1acdb4898eca1b9cab9824131d3ca80de63434ae/src/lucky_task/task.cr#L295" target="_blank">View source</a>]
 
       </div>
     </div>
@@ -343,7 +324,7 @@ <h2>
       <br/>
       <div>
 
-          [<a href="https://github.com/luckyframework/lucky_task/blob/c657bc5be5e955ff0959a0430208e1c92c24c7ef/src/lucky_task/task.cr#L138" target="_blank">View source</a>]
+          [<a href="https://github.com/luckyframework/lucky_task/blob/1acdb4898eca1b9cab9824131d3ca80de63434ae/src/lucky_task/task.cr#L152" target="_blank">View source</a>]
 
       </div>
     </div>
@@ -374,7 +355,34 @@ <h2>
       <br/>
       <div>
 
-          [<a href="https://github.com/luckyframework/lucky_task/blob/c657bc5be5e955ff0959a0430208e1c92c24c7ef/src/lucky_task/task.cr#L255" target="_blank">View source</a>]
+          [<a href="https://github.com/luckyframework/lucky_task/blob/1acdb4898eca1b9cab9824131d3ca80de63434ae/src/lucky_task/task.cr#L269" target="_blank">View source</a>]
+
+      </div>
+    </div>
+
+    <div class="entry-detail" id="help_message(help_text)-macro">
+      <div class="signature">
+
+        macro <strong>help_message</strong>(help_text)
+
+        <a class="method-permalink" href="#help_message%28help_text%29-macro">#</a>
+      </div>
+
+        <div class="doc">
+
+          <p>Customize your help message with the provided <code>help_text</code></p>
+<pre><code class="language-crystal"><span class="k">class</span> <span class="t">KeyGen</span> <span class="o">&lt;</span> <span class="t">LuckyTask</span><span class="t">::</span><span class="t">Task</span>
+  summary <span class="s">&quot;Generate a new key&quot;</span>
+  help_message <span class="s">&quot;Call lucky key_gen to generate a new key&quot;</span>
+
+  <span class="c"># other methods, etc.</span>
+<span class="k">end</span></code></pre>
+        </div>
+
+      <br/>
+      <div>
+
+          [<a href="https://github.com/luckyframework/lucky_task/blob/1acdb4898eca1b9cab9824131d3ca80de63434ae/src/lucky_task/task.cr#L92" target="_blank">View source</a>]
 
       </div>
     </div>
@@ -405,7 +413,7 @@ <h2>
       <br/>
       <div>
 
-          [<a href="https://github.com/luckyframework/lucky_task/blob/c657bc5be5e955ff0959a0430208e1c92c24c7ef/src/lucky_task/task.cr#L218" target="_blank">View source</a>]
+          [<a href="https://github.com/luckyframework/lucky_task/blob/1acdb4898eca1b9cab9824131d3ca80de63434ae/src/lucky_task/task.cr#L232" target="_blank">View source</a>]
 
       </div>
     </div>
@@ -420,13 +428,22 @@ <h2>
 
         <div class="doc">
 
-          <p><span class="flag red">DEPRECATED</span>  Use <code><a href="../LuckyTask/Task.html#task_name%28name_text%29-macro">task_name</a></code> instead</p>
+          <p>Renames the task name for CLI use</p>
+<p>By default the task name is derived from the full module and class name.
+However if that task name is not desired, a custom one can be set.</p>
+<pre><code class="language-crystal"><span class="k">class</span> <span class="t">Dev</span><span class="t">::</span><span class="t">Prime</span> <span class="o">&lt;</span> <span class="t">LuckyTask</span><span class="t">::</span><span class="t">Task</span>
+  <span class="c"># Would be &quot;dev.prime&quot; by default, but we want to set it to &quot;dev.setup&quot;:</span>
+  task_name <span class="s">&quot;dev.setup&quot;</span>
+  summary <span class="s">&quot;Seed the development database with example data&quot;</span>
+
+  <span class="c"># other methods, etc.</span>
+<span class="k">end</span></code></pre>
         </div>
 
       <br/>
       <div>
 
-          [<a href="https://github.com/luckyframework/lucky_task/blob/c657bc5be5e955ff0959a0430208e1c92c24c7ef/src/lucky_task/task.cr#L53" target="_blank">View source</a>]
+          [<a href="https://github.com/luckyframework/lucky_task/blob/1acdb4898eca1b9cab9824131d3ca80de63434ae/src/lucky_task/task.cr#L76" target="_blank">View source</a>]
 
       </div>
     </div>
@@ -458,7 +475,7 @@ <h2>
       <br/>
       <div>
 
-          [<a href="https://github.com/luckyframework/lucky_task/blob/c657bc5be5e955ff0959a0430208e1c92c24c7ef/src/lucky_task/task.cr#L96" target="_blank">View source</a>]
+          [<a href="https://github.com/luckyframework/lucky_task/blob/1acdb4898eca1b9cab9824131d3ca80de63434ae/src/lucky_task/task.cr#L110" target="_blank">View source</a>]
 
       </div>
     </div>
@@ -471,10 +488,17 @@ <h2>
         <a class="method-permalink" href="#summary%28summary_text%29-macro">#</a>
       </div>
 
+        <div class="doc">
+
+          <p>The general description of what this task does</p>
+<p>This is used in the help_text when a help flag is passed
+to the task through the CLI</p>
+        </div>
+
       <br/>
       <div>
 
-          [<a href="https://github.com/luckyframework/lucky_task/blob/c657bc5be5e955ff0959a0430208e1c92c24c7ef/src/lucky_task/task.cr#L46" target="_blank">View source</a>]
+          [<a href="https://github.com/luckyframework/lucky_task/blob/1acdb4898eca1b9cab9824131d3ca80de63434ae/src/lucky_task/task.cr#L56" target="_blank">View source</a>]
 
       </div>
     </div>
@@ -501,37 +525,7 @@ <h2>
       <br/>
       <div>
 
-          [<a href="https://github.com/luckyframework/lucky_task/blob/c657bc5be5e955ff0959a0430208e1c92c24c7ef/src/lucky_task/task.cr#L188" target="_blank">View source</a>]
-
-      </div>
-    </div>
-
-    <div class="entry-detail" id="task_name(name_text)-macro">
-      <div class="signature">
-
-        macro <strong>task_name</strong>(name_text)
-
-        <a class="method-permalink" href="#task_name%28name_text%29-macro">#</a>
-      </div>
-
-        <div class="doc">
-
-          <p>Renames the task name for CLI use</p>
-<p>By default the task name is derived from the full module and class name.
-However if that task name is not desired, a custom one can be set.</p>
-<pre><code class="language-crystal"><span class="k">class</span> <span class="t">Dev</span><span class="t">::</span><span class="t">Prime</span> <span class="o">&lt;</span> <span class="t">LuckyTask</span><span class="t">::</span><span class="t">Task</span>
-  <span class="c"># Would be &quot;dev.prime&quot; by default, but we want to set it to &quot;dev.setup&quot;:</span>
-  task_name <span class="s">&quot;dev.setup&quot;</span>
-  summary <span class="s">&quot;Seed the development database with example data&quot;</span>
-
-  <span class="c"># other methods, etc.</span>
-<span class="k">end</span></code></pre>
-        </div>
-
-      <br/>
-      <div>
-
-          [<a href="https://github.com/luckyframework/lucky_task/blob/c657bc5be5e955ff0959a0430208e1c92c24c7ef/src/lucky_task/task.cr#L78" target="_blank">View source</a>]
+          [<a href="https://github.com/luckyframework/lucky_task/blob/1acdb4898eca1b9cab9824131d3ca80de63434ae/src/lucky_task/task.cr#L202" target="_blank">View source</a>]
 
       </div>
     </div>