ruby-shell 0.10.1 → 0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c7ebd4a7beebe30b2df0d2fcf14d1edc9f503730aaa1a3bf43253c83c844bec
-  data.tar.gz: 602746338bda097043bf6bd465d39949cd1401660073b10f736bccf9d6b64aed
+  metadata.gz: 002e79c6d55d5d7f9aedab8fd39f1e1712a00cc5346d5971017023bb98be6a36
+  data.tar.gz: e55bcd60840eb1e244dfd74868a0efe28c9fa4d5eb85da778dd5642219a23647
 SHA512:
-  metadata.gz: 50f8c28add6488b720bb28f669136c74c6f09681e4a8690293e1a9a5e7cb2ab13247d3e13c6cec090841c3f30229af9e87bfed322afec373920662b4a9477a91
-  data.tar.gz: 89c72e7a3205a18c1d496dc1e2b058998b65b93fea587fc012b619365154d56d65d75d55b471d03b03e1f6c137431fbf760607407761897d22bfaca565f03faf
+  metadata.gz: d14305387565d0c2ec54843d4a3f256563e7079567c6f75b51a3357494582439f49648b43a0c60a7b509b5f01a52bcee23e293dbbbf47d82fbb8d58325173f58
+  data.tar.gz: e5647e1c8b7218a50e76fab9cf1170ed5c5df863ad6530f66a571f083a881deaf3a94bad242d0543585f4c65bd38f7496466764c525d3ec8adfac25552997741

data/README.md

@@ -37,6 +37,7 @@ Special commands:
 * `:gnick 'h = /home/me'` to make a general alias (h) point to something (/home/me)
 * `:nick?` will list all command nicks and general nicks (you can edit your nicks in .rshrc)
 * `:history` will list the command history, while `:rmhistory` will delete the history
+* `:help` will display this help text
 
 ## Nicks
 Add command nicks (aliases) with `:nick "some_nick = some_command"`, e.g. `:nick "ls = ls --color"`. Add general nicks that will substitute anything on a command line (not just commands) like this `:gnick "some_gnick = some_command"`, e.g. `:gnick "x = /home/user/somewhere"`. List (g)nicks with `:nick?`. Remove a nick with `:nick "-some_command"`, e.g. `:nick "-ls"` to remove an `ls` nick. Same for gnicks.

data/bin/rsh

@@ -14,7 +14,7 @@
 #             for any damages resulting from its use. Further, I am under no
 #             obligation to maintain or extend this software. It is provided 
 #             on an 'as is' basis without any expressed or implied warranty.
-@version    = "0.10"
+@version    = "0.11"
 
 # MODULES, CLASSES AND EXTENSIONS
 class String # Add coloring to strings (with escaping for Readline)
@@ -129,9 +129,9 @@ begin # Initialization
   @cmd         = ""                       # Initiate variable @cmd
 end
 
-# GENERIC FUNCTIONS
-def firstrun
-  @firstrun = <<~FIRSTRUN
+# HELP TEXT
+@help = <<~HELP
+
   Hello #{@user}, welcome to rsh - the Ruby SHell. 
   
   rsh does not attempt to compete with the grand old shells like bash and zsh. 
@@ -160,16 +160,19 @@ def firstrun
   * `:gnick 'h = /home/me'` to make a general alias (h) point to something (/home/me)
   * `:nick?` will list all command nicks and general nicks (you can edit your nicks in .rshrc)
   * `:history` will list the command history, while `:rmhistory` will delete the history
+  * `:help` will display this help text
   
-  Since there is no rsh configuration file (.rshrc), I will help you set it up to suit your needs.
-FIRSTRUN
+HELP
 
-  puts @firstrun
-  puts "The prompt you see now is the very basic rsh prompt: "
+# GENERIC FUNCTIONS
+def firstrun
+  puts @help
+  puts "Since there is no rsh configuration file (.rshrc), I will help you set it up to suit your needs.\n\n"
+  puts "The prompt you see now is the very basic rsh prompt:"
   print "#{@prompt} (press ENTER)"
   STDIN.gets
-  puts "I will now change the prompt into something more useful."
-  puts "Feel free to amend the prompt in your .rshrc."
+  puts "\nI will now change the prompt into something more useful."
+  puts "Feel free to amend the prompt in your .rshrc.\n\n"
   rc = <<~RSHRC
   # PROMPT
   # The numbers in parenthesis are 256 color codes (the '.c()' is a String extention
@@ -190,7 +193,6 @@ FIRSTRUN
   @nick = {"ls"=>"ls --color -F"}
 RSHRC
   File.write(Dir.home+'/.rshrc', rc)
-
 end
 def getchr # Process key presses
   c = STDIN.getch
@@ -509,6 +511,9 @@ def rshrc # Write updates to .rshrc
 end
 
 # RSH FUNCTIONS
+def help
+  puts @help
+end
 def history # Show history
   puts "History:"
   puts @history

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-shell
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: '0.11'
 platform: ruby
 authors:
 - Geir Isene
@@ -12,8 +12,7 @@ date: 2023-06-04 00:00:00.000000000 Z
 dependencies: []
 description: 'A shell written in Ruby with extensive tab completions, aliases/nicks,
   history, syntax highlighting, theming and more. In continual development. New in
-  0.10: Added introduction and creation of .rshrc on first run. Improved rtfm integration.
-  0.10.1: Fixed depricated Dir.exists?'
+  0.11: Added command :help to display the help text'
 email: g@isene.com
 executables:
 - rsh