run_tasks 3.2.0 → 3.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f162dd89c96e5d57659848493488f2b9f02337f169d01077e1b58554142efb32
-  data.tar.gz: f6c6316654baf6399507b90f144c4fbbc5c50e66e430242e36fc791d2aaa0080
+  metadata.gz: d9e8f32ee31f48e5f7d451f2b956faac1881b4a1a20b40de21eb02a32831a7ad
+  data.tar.gz: dd121f1d5f725e9497fe05a3b04423415f65c1621f53ba9f59a9c453b4569c7e
 SHA512:
-  metadata.gz: c9f6edcb2af5b824bad3c59f7f649664152a95347edd341e7de96ff4e0c613bdee171d06f04e3bede97f8b81c4c0042d97192f71821a9f6d252b4fd342b0296d
-  data.tar.gz: a041c5d2b79f74550443cca60b2a0901bb2f0a38de20e2f09b00cede5472ec4ac3a56bf79de7d8b677f683e49d0fab7d4f37148c474c869328f5fa6c128e40f2
+  metadata.gz: fe92ecc38071af0a6b80ed2e98288c308a6c191dd95a5610f6039672f5a4f25ae61d6dc3b5cceb0b78e1bae30f61f9f9f00848cadc15b061b909403dd14fc809
+  data.tar.gz: d022b3de66d9d7642b76ec7a852dc427e4ca67244f1fbc0cca5d9d0449bd4d5f6c8331892a6dcbad37b708239c0a406bbd84078023f3bd82c15a4a9ad2be2d0c

data/CHEATSHEET.md

@@ -0,0 +1,218 @@
+# Defining a task
+
+```rb
+task :eslint do
+end
+```
+
+# Defining a task with aliases
+
+```rb
+task [:console, :c] do
+end
+```
+
+# Defining a task with parameters
+
+```rb
+task :hello do |name, age|
+  puts "Hello #{name}, you are #{age}."
+end
+```
+
+# Running commands
+
+```rb
+task :clear_all do
+  run "rm -rf /*"
+end
+```
+
+# Running subtasks
+
+```rb
+task :linting do
+  run :eslint
+  run :rubocop
+end
+```
+
+# Running a task/command in quiet mode
+
+```rb
+task :clear_cache do
+  run "rm -rf cache/*", quiet: true
+end
+```
+
+# Using named booleans
+
+```sh
+run server +tunnel
+```
+
+```rb
+task :server do |tunnel: false|
+  run "http_server #{tunnel ? "--tunnel" : ""}"
+end
+```
+
+# Helpers
+
+## are_you_sure
+
+```rb
+task :dangerous_task do
+  are_you_sure "This task will delete your hard drive. Are you sure about that?"
+  # Some dangerous actions.
+end
+```
+
+## bind
+
+```rb
+task :rails do
+  run "bundle exec unicorn -c config/unicorn.rb -p 3000"
+end
+
+task :vite do
+  run "bin/vite dev"
+end
+
+task :dev do
+  # Bind `rails` and `vite` tasks together, if one closes, the other terminates too.
+  bind :rails, :vite
+end
+```
+
+```rb
+task :dev do
+  # Plug STDIN to the `rails` task.
+  bind :rails, :vite, stdin: :rails
+end
+```
+
+## catch_interruption
+
+```rb
+task :server do
+  catch_interruption("docker run -d -p 8080:80 web_server") do
+    run :clear_cache
+  end
+end
+```
+
+## exists
+
+```rb
+task :man do
+  command = exists("bat") ? "bat" : "cat"
+  run "#{command} #{__dir__}/README.md"
+end
+```
+
+## expand
+
+```rb
+task :scan do |glob|
+  expand(glob).each do |file_path|
+    puts file_path
+  end
+end
+```
+
+## menu
+
+```rb
+task :deploy_aws do
+  region = menu "Location?", ["us‑east‑2", "us-west-1", "eu-west-1"]
+end
+```
+
+```rb
+task :deploy_aws do
+  region = menu "Location?", {
+    "US East (Ohio)" => "us‑east‑2",
+    "US West (N. California)" => "us-west-1",
+    "Europe (Ireland)" => "eu-west-1",
+  }
+end
+```
+
+## pause
+
+```rb
+task :deploy do
+  puts "Press enter to continue.".yellow
+  pause
+  run :deploy_production
+end
+```
+
+## question
+
+```rb
+task :survey do
+  comment = question "Did your meal was good?"
+end
+```
+
+```rb
+task :age do
+  age = question "What is your age?", /^\d+$/
+end
+```
+
+## wait_for_interruption
+
+```rb
+task :server do
+  Thread.new do
+    run :rails
+  end
+  Thread.new do
+    run :vite
+  end
+  wait_for_interruption do
+    run :kill_rails
+    run :kill_vite
+  end
+end
+```
+
+# Colorization
+
+```rb
+puts "hello".bold
+puts "hello".dim
+puts "hello".italic
+puts "hello".underline
+puts "hello".inverse
+puts "hello".strikethrough
+puts "hello".black
+puts "hello".red
+puts "hello".green
+puts "hello".yellow
+puts "hello".blue
+puts "hello".magenta
+puts "hello".cyan
+puts "hello".white
+puts "hello".bright_black
+puts "hello".bright_red
+puts "hello".bright_green
+puts "hello".bright_yellow
+puts "hello".bright_blue
+puts "hello".bright_magenta
+puts "hello".bright_cyan
+puts "hello".bright_white
+```
+
+```rb
+puts "hello".green.bold.italic
+```
+
+# Advanced usage
+
+```sh
+RUNFILE=/path/to/Runfile.rb run my_task
+```

data/src/bootstrap.rb

@@ -79,8 +79,7 @@ end
 
 # Display the manual.
 task :man do
-  command = exists("bat") ? "bat" : "cat"
-  run "#{command} #{__dir__}/../CHEATSHEET.md"
+  puts Markdown::Engine.new(File.read("#{__dir__}/../CHEATSHEET.md")).to_ansi
 end
 
 # Expose helpers.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: run_tasks
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.2.3
 platform: ruby
 authors:
 - Aurélien Delogu
@@ -71,6 +71,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- CHEATSHEET.md
 - bin/run
 - completions/_run
 - src/bootstrap.rb