run_tasks 1.5.0 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ca212e97bece85ae70c8db267e09c31d0c135bd
-  data.tar.gz: 36636b9b276ccd8d4246cd748e09c5900223065d
+  metadata.gz: a8ca5b6161049b4ab439ac2f9138d50bcea418c8
+  data.tar.gz: '0929497d99ff80c07b4dcc434ca10322321653fb'
 SHA512:
-  metadata.gz: 97133b4706e5fd853ae1686ebc1079d28c016bf3f18ed1831051a4fc3d61b3277cc970f4112b59686fb45319b48d4be8d06c727525bfd2ec4cb67f64899d2010
-  data.tar.gz: a5f05889f869b1356e79dd577f1ed7fb390ac9bce118a017eef2f80a5a0e3dc42b444de3b61df2e66af4c52126380e4a7ca6987b3cb8ec3f3a391380722b1ed1
+  metadata.gz: 38b289ecbb3e0a0bb3cd0fa6fc0dc7872a6d9d2331bd9c3584f18a3eeaa220c5a3f9d2649b3ce0b1808c323b674329614e68342ecc5e12d3eb78cb142c883db2
+  data.tar.gz: a2aff1ef595a7e9e3d16417c25314a3bb9a452795f807f13e6dda09e5eb0b9baaa62ce45bdf0136d07787de1b4597ea992052baa6c429f0af302b3c54ca0116e

data/src/run.rb

@@ -25,26 +25,38 @@ HOMEPAGE = GEM&.homepage
 
 ##########################################################################################
 
-@tasks = Hash.new
+@tasks = {}
 
 # @param name [Symbol]
 # @param help [String]
 # @yield [*Array, **Hash]
-def task(name, help = "", &block)
+def task(name, help = nil, &block)
   if !name.is_a?(Symbol)
     puts
-    puts "First task parameter must be a symbol".red
+    puts "'name' parameter must be a symbol".red
     exit 6
   end
-  if !help.is_a?(String)
-    puts
-    puts "Second task parameter must be a string".red
-    exit 6
+  if !help.nil?
+    if !help.is_a?(String)
+      puts
+      puts "'help' parameter must be a string".red
+      exit 6
+    end
+  else
+    # Load comments directly above the task as help verbatim.
+    caller = caller_locations[0]
+    lines = File.readlines(caller.absolute_path)
+    help = (0..(caller.lineno - 2)).to_a.reverse.reduce([]) do |comments, lineno|
+      match = /^\s*#\s*(?<comment>.+?)\s*$/.match(lines[lineno])
+      break comments if match.nil?
+      comments << match[:comment]
+      comments
+    end.reverse
   end
   @tasks.store(
     name,
     {
-      :help => Markdown::Engine.new(help).to_ansi,
+      :help => help.is_a?(String) ? [help] : help,
       :block => block
     }
   )
@@ -143,7 +155,18 @@ if ARGV.size == 0 || (ARGV.size == 1 && ARGV[0] == "help")
   end
   # Display each task and their help.
   @tasks.sort.to_h.each do |name, task|
-    puts " #{name}".yellow + (" " * (max_size - name.size + 4)) + task[:help]
+    if task[:help].size == 0
+      puts " #{name}".yellow
+      next
+    end
+    task[:help].each_with_index do |help, index|
+      help = Markdown::Engine.new(help).to_ansi
+      if index == 0
+        puts " #{name}".yellow + (" " * (max_size - name.size + 4)) + help
+        next
+      end
+      puts (" " * (max_size + 5)) + help
+    end
   end
   exit
 end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: run_tasks
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.1
 platform: ruby
 authors:
 - Aurélien Delogu
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-11 00:00:00.000000000 Z
+date: 2023-07-27 00:00:00.000000000 Z
 dependencies: []
-description: 
+description:
 email: aurelien.delogu@gmail.com
 executables:
 - run
@@ -29,7 +29,7 @@ homepage: https://github.com/pyrsmk/run
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -44,9 +44,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
+rubyforge_project:
 rubygems_version: 2.5.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Run project tasks with ease
 test_files: []