FEAT: Allow positional directory input

Author: lwileczek

.github/workflows/go.yaml

@@ -22,7 +22,8 @@ jobs:
     - name: Set up Go
       uses: actions/setup-go@v4
       with:
-        go-version: 1.21
+        go-version: '>=1.21.0'
+        cache: true
 
     - name: Build the project
       run: go build -v ./...

.github/workflows/goreleaser.yaml

@@ -16,11 +16,14 @@ jobs:
       - uses: actions/checkout@v3
         with:
           fetch-depth: 0
+
       - run: git fetch --force --tags
+
       - uses: actions/setup-go@v4
         with:
           go-version: '>=1.21.0'
           cache: true
+
       # More assembly might be required: Docker logins, GPG, etc. It all depends
       # on your needs.
       - uses: goreleaser/goreleaser-action@v4

README.md

@@ -1,34 +1,42 @@
 # Go Find
-A file finder written in Go for my needs.
+A file finder written in Go.
 
-Uses a worker pool to search through directory trees quicker and take advantage of multi-core machines.
-Go concurrency allows it to run on single core machines.
-
-If you're looking for something specific you can limit the number of responses
+Uses a worker pool to search through directory trees quicker by taking advantage of multi-core machines.
+Go concurrency allows it to run on single core machines. 
 
 ### Features
- - Concurrency which may speed up or slow down the search depending on the tree structure. 
+ - Concurrency search directories for desired pattern
+ - Exit early with a max results option
  - Common paths are ignored to save time and checks, such as `node_modules`, `.git`, and python `venv`.
  - Searches for a pattern using basic sub-string
+ - Use a worker pool to avoid spinning up too many go routines if there are _many_ directories
 
 ## Warning
 > **warning**
 > Does not work on windows and I'm not trying too support this
 
-## TODO
- - [ ] user cobra for for a better cli experience
- - [ ] sub command to print paths that are ignored
- - [ ] create case sensative/insensative searching
- - [ ] exclude additional directories or patters
- - [ ] include specific patterns in the search path
- - [ ] switch to ignore all hidden files/directories
- - [x] can we create a worker pool instead of the number of initial directories
- - [x] cap the number of returned responses, say 1 (quit after the first match!)
- - [x] Auto-generate releases
- - [ ] cap the depth of the search
- - [x] use select statement with a fallback queue to prevent deadlock from happening
-
 ## Using
+### Usage
+Customise your search with the following flags
+
+```bash
+Usage: goFind [OPTIONS] <pattern> <path>
+  set pattern & path positionally or via flags
+  -c int
+        The maximum number of results to find (default -1)
+  -d string
+        The starting directory to check for files (default ".")
+  -i    perform a case insensative search
+  -p string
+        A pattern to check for within the file names
+  -q int
+        The max work queue size (default 512)
+  -v    print the version and build information
+  -w int
+        Number of workers (default -1)
+```
+
+## Contributing
 ### Build
 build with `go build -o gf main.go` and run with `./gf -d <starting-path> -p <pattern-to-match-on>`
 #### Requirements
@@ -40,18 +48,16 @@ You can use the [makefile](./Makefile) to build a production release with `make
  - Make
  - Go 1.21+
 
-### Flags
-Customise your search with the following flags
-```bash
-Usage of ./gf:
-  -c int
-    	The maximum number of results to find (default -1)
-  -d string
-    	The starting directory to check for files (default ".")
-  -p string
-    	A pattern to check for within the file names
-  -q int
-    	The max work queue size (default 2048)
-  -w int
-    	Number of workers (default 8)
-```
+## Roadmap
+ - [x] can we create a worker pool instead of the number of initial directories
+ - [x] cap the number of returned responses, say 1 (quit after the first match!)
+ - [x] Auto-generate releases
+ - [x] cap the depth of the search
+ - [x] use select statement with a fallback queue to prevent deadlock from happening
+ - [x] use postional args or flags to set the pattern/path
+ - [ ] Add flag to print which paths will be ignored
+ - [ ] create case sensative/insensative searching
+ - [ ] exclude additional directories or patters
+ - [ ] include specific patterns in the search path
+ - [ ] switch to ignore all hidden files/directories
+ - [ ] look for `.gitignore` files and use contents to build ignored patterns

cli.go

@@ -2,6 +2,8 @@ package main
 
 import (
 	"flag"
+	"fmt"
+	"os"
 	"runtime"
 )
 
@@ -16,7 +18,22 @@ type Config struct {
 	Version     bool
 }
 
-func parseCLI() *Config {
+// myUsage overwrite default usage message from ./<bin> --help
+func myUsage() {
+	bin := "gof"
+	if len(os.Args) > 0 {
+		bin = os.Args[0]
+	}
+
+	fmt.Printf("Usage: %s [OPTIONS] <pattern> <path>\n", bin)
+	fmt.Println("  set pattern & path positionally or via flags")
+	flag.PrintDefaults()
+}
+
+// parseArgs all arguments from the user to use with the program
+func parseArgs() *Config {
+	flag.Usage = myUsage
+
 	//The number of workers. If there are more workers the system can read from
 	//the work queue more often and a larger queue is not required.
 	workers := flag.Int("w", -1, "Number of workers")
@@ -25,7 +42,7 @@ func parseCLI() *Config {
 	maxResults := flag.Int("c", -1, "The maximum number of results to find")
 	dir := flag.String("d", ".", "The starting directory to check for files")
 	pattern := flag.String("p", "", "A pattern to check for within the file names")
-	insensative := flag.Bool("i", true, "perform a case insensative search")
+	insensative := flag.Bool("i", false, "perform a case insensative search")
 	v := flag.Bool("v", false, "print the version and build information")
 	flag.Parse()
 
@@ -40,6 +57,10 @@ func parseCLI() *Config {
 		w = runtime.NumCPU() + 2
 	}
 
+	if *dir == "." && flag.Arg(1) != "" {
+		*dir = flag.Arg(1)
+	}
+
 	//Only for OSX/Linux, sorry windows
 	//Remove any trailing slashes in the path
 	if (*dir)[len(*dir)-1:] == "/" {

main.go

@@ -26,7 +26,7 @@ func printBuildInfo() {
 }
 
 func main() {
-	cfg := parseCLI()
+	cfg := parseArgs()
 	if cfg.Version {
 		printBuildInfo()
 		return
@@ -37,6 +37,10 @@ func main() {
 		return
 	}
 
+	if cfg.Insensative {
+		fmt.Println("WARN: case insensative search is not yet supported")
+	}
+
 	printCh := make(chan string, cfg.Workers)
 	//The system will reach deadlock if the work queue reaches capacity
 	workQ := make(chan string, cfg.QueueSize)