Last active
September 10, 2021 10:32
-
-
Save AlSquire/e97a4c689dc232e018261ae349ad26c4 to your computer and use it in GitHub Desktop.
Now exists as a gem: https://github.com/AlSquire/commands - Display a menu of commands defined in ./commands.yml in the current directory, so you can have a simple cheatsheet AND a quick launch by project :)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
#!/usr/bin/env ruby | |
# Put this file in your PATH and give it execution rights, run to have a commands.yml example. | |
# Alias it and/or remove .rb extension for convenience. | |
# Usage: | |
# commands.rb [ALIAS_OR_NUMBER [ARGS]] | |
# TODO: stdin and stdout for shell compatibility (useful?) | |
require 'readline' | |
require 'yaml' | |
# Check for commands.yml in current working directory | |
file = File.read('commands.yml') rescue nil | |
# If command contains %{argX}, replace it with the Xth argument | |
# Otherwise, all arguments are put at the end of command | |
def resolve_command_line(command, args) | |
if command.match(/%\{arg\d+\}/) | |
hashed_args = {} | |
args.each.with_index do |arg, index| | |
hashed_args["arg#{index + 1}".to_sym] = arg | |
end | |
command % hashed_args | |
else | |
[command, args] * ' ' | |
end | |
end | |
if file | |
commands = YAML.load(file) | |
input, *args = ARGV | |
if !input | |
# Display commands | |
commands.each.with_index do |command, index| | |
puts | |
puts "#{index + 1}/ #{command['desc']}" | |
puts "=> #{command['command']}" | |
puts "- alias: #{command['alias']}" if command['alias'] | |
end | |
puts | |
puts "Enter a number or alias followed by optionnal args, nothing to exit" | |
puts | |
prompt = "> " | |
input, *args = Readline.readline(prompt, true).split(' ') | |
end | |
if input && input != "" | |
command = if input.match? /^[1-9][0-9]*$/ | |
commands[input.to_i - 1] | |
else | |
commands.detect do |c| | |
c['alias'] && c['alias'] == input | |
end | |
end | |
if command | |
command_line = resolve_command_line(command['command'], args) | |
puts " => #{command_line}" | |
system(command_line) | |
else | |
puts "No command found for #{input}" | |
end | |
end | |
else | |
puts "commands.yml not found in current directory" | |
puts | |
puts "Example of commands.yml:" | |
puts %Q{ | |
- | |
desc: "Rails server" | |
command: "bundle exec rails server" | |
alias: "rs" | |
- | |
desc: "Webpack dev server" | |
command: "./bin/webpack-dev-server" | |
alias: "ws" | |
- | |
desc: "Some reversed ordered arguments" | |
command: "echo %{arg3} %{arg2} %{arg1}" | |
} | |
end |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment