add flags and docs for the same

Author: barelyhuman

commitlog.md

@@ -10,13 +10,31 @@ also, to get better at nimlang
 
 ## Features
 
-- Sort git's logs into `features, fixes, others`
+- Categorize git's logs into `["build","chore","ci","docs","feat","fix","perf","refactor","revert","style","test"]`
+- Doesn't support scoped commits right now
 - That's about it.
 
+## Usage
+
+```sh
+# for everything
+nimclog
+
+# for a specific range
+nimclog --start=<gitrevision> --end=<gitrevision>
+
+# shorthand props for the same
+nimclog -s=<gitrevision>
+nimclog -e=<gitrevision>
+
+```
+
 ## Installation
 
-I'm still testing the cross compiled binaries so you'll have to wait for it.
-Till then, you can compile it on your system using `nim` or `nimble`
+Cross compiled binaries can be found on the releases pages.
+Windows builds have not been tested, please report if you find any issues running them.
+
+You can also compile it on your own system using `nim` or `nimble`
 
 ```sh
 nimble build

readme.md

@@ -1,23 +1,62 @@
 import std/os
 import std/strutils
+import std/parseopt
 import re
 
 
 type
     CategoryPair* = object
         commit: string
         category: string
-
-
-proc createInitialCommits*() =
+    Flags* = object 
+        startCommit: string
+        endCommit: string
+
+
+proc readParams():Flags = 
+    var flags = Flags(
+        startCommit:"",
+        endCommit:""    
+    )
+    var resString = ""
+    
+    for param in commandLineParams():
+        resString = resString & " " & param
+
+    var parser = initOptParser(resString)
+
+    while true:
+        parser.next()
+        case parser.kind
+        of cmdEnd: break
+        of cmdShortOption, cmdLongOption:
+            if parser.val == "":
+                echo "hello"
+            else:
+                case parser.key
+                of "s","start":
+                    flags.startCommit = parser.val
+                of "e","end":
+                    flags.endCommit = parser.val    
+                
+        of cmdArgument:
+            echo "Argument: ", parser.key
+    
+    return flags
+
+proc createInitialCommits*(flags:Flags) =
     when defined(posix):
-        # TODO:
-        # handle params where you get the start and end commit
-        discard execShellCmd("git log --pretty=oneline > commitlog.md")
+        var cmd = "git log"
+        if flags.startCommit != "":
+            cmd = cmd & " " & flags.startCommit
+        if flags.endCommit != "":
+            cmd = cmd & " " & flags.endCommit
+        cmd = cmd & " --pretty=oneline > commitlog.md"
+        discard execShellCmd(cmd)
 
 
 proc categorise*(commit: string): string =
-    const categories = ["ci", "feat", "fix", "others"]
+    const categories = ["build","chore","ci","docs","feat","fix","perf","refactor","revert","style","test"]
     var selected: string;
     for i, cat in categories:
         if commit.startsWith(cat & ":"):
@@ -69,12 +108,11 @@ proc clean*() =
     removeFile("commitlog.md")
 
 proc clog*() =
-    createInitialCommits()
-    var categorizedCommits = processInitialCommits();
-    printCategorized(categorizedCommits)
-    clean()
-
-
-
-
-
+    when declared(commandLineParams):
+        var flags = readParams()
+        createInitialCommits(flags)
+        var categorizedCommits = processInitialCommits();
+        printCategorized(categorizedCommits)
+        clean()
+    else:
+        echo "Failed to execute program..."