added tests related to tips; updated README

README.md

@@ -66,7 +66,7 @@ Features:
 * Supports default values and automatic conversions for arguments. 
 * Automatically generates error, usage  and help(__NYI__) messages. 
 * Supports commands(e.g. in [git](http://git-scm.com/) CLI `add`, `commit`, `push`, etc. are commands). Each command has its own set of options and arguments. 
-* Automatically generates tips on typos(__NYI__). 
+* Automatically generates tips on typos. 
 
     Example: 
 

spec/tip_spec.lua

@@ -0,0 +1,95 @@
+local argparse = require "argparse"
+
+describe("tests related to tips", function()
+   describe("provides tips when data is too long", function()
+      it("for options", function()
+         local parser = argparse.parser()
+         parser:option "-q" "--quiet"
+
+         assert.has_error(function() parser:parse{"--quiett=true"} end,
+            "unknown option '--quiett'\r\nDid you mean '--quiet'?")
+      end)
+
+      it("for commands", function()
+         local parser = argparse.parser "name"
+         parser:command "install"
+
+         assert.has_error(function() parser:parse{"installq"} end,
+            "unknown command 'installq'\r\nDid you mean 'install'?")
+      end)
+   end)
+
+   describe("provides tips when data is too short", function()
+      it("for options", function()
+         local parser = argparse.parser()
+         parser:option "-q" "--quiet"
+
+         assert.has_error(function() parser:parse{"--quet=true"} end,
+            "unknown option '--quet'\r\nDid you mean '--quiet'?")
+      end)
+
+      it("for commands", function()
+         local parser = argparse.parser "name"
+         parser:command "install"
+
+         assert.has_error(function() parser:parse{"nstall"} end,
+            "unknown command 'nstall'\r\nDid you mean 'install'?")
+      end)
+   end)
+
+   describe("provides tips on substitution", function()
+      it("for options", function()
+         local parser = argparse.parser()
+         parser:option "-q" "--quiet"
+
+         assert.has_error(function() parser:parse{"--qriet=true"} end,
+            "unknown option '--qriet'\r\nDid you mean '--quiet'?")
+      end)
+
+      it("for commands", function()
+         local parser = argparse.parser "name"
+         parser:command "install"
+
+         assert.has_error(function() parser:parse{"inntall"} end,
+            "unknown command 'inntall'\r\nDid you mean 'install'?")
+      end)
+   end)
+
+   describe("provides tips on transpositions", function()
+      it("for options", function()
+         local parser = argparse.parser()
+         parser:option "-q" "--quiet"
+
+         assert.has_error(function() parser:parse{"--queit=true"} end,
+            "unknown option '--queit'\r\nDid you mean '--quiet'?")
+      end)
+
+      it("for commands", function()
+         local parser = argparse.parser "name"
+         parser:command "install"
+
+         assert.has_error(function() parser:parse{"isntall"} end,
+            "unknown command 'isntall'\r\nDid you mean 'install'?")
+      end)
+   end)
+
+   describe("provides multiple tips", function()
+      it("for options", function()
+         local parser = argparse.parser()
+         parser:option "-q" "--quiet"
+         parser:option "--quick"
+
+         assert.has_error(function() parser:parse{"--quiec=true"} end,
+            "unknown option '--quiec'\r\nDid you mean one of these: '--quick' '--quiet'?")
+      end)
+
+      it("for commands", function()
+         local parser = argparse.parser "name"
+         parser:command "install"
+         parser:command "instant"
+
+         assert.has_error(function() parser:parse{"instanl"} end,
+            "unknown command 'instanl'\r\nDid you mean one of these: 'install' 'instant'?")
+      end)
+   end)
+end)