v0.2.0: Config file feature fuctionality

0.2.0: Config file

Author: CTNOriginals

.gitignore

@@ -7,5 +7,6 @@ bitburner/
 build/
 .vscode/
 .nvim
+*.toml
 
 *.exe

Makefile

@@ -30,43 +30,68 @@ CURRENT_VERSION_MINOR := $(MAJOR).$(NEXT_MINOR).0
 CURRENT_VERSION_MAJOR := $(NEXT_MAJOR).0.0
 endif
 
+.DEFAULT_GOAL := help
 # --- Version commands ---
-.PHONY: version
-
-version:
+.PHONY: help version proto
+
+help: ##@help Display all commands and descriptions
+	@awk 'BEGIN {FS = ":.*##@"; printf "\nUsage:\n  make <target>\n"} \
+	/^[.a-zA-Z_-]+:.*?##@/ { \
+		split($$2, parts, " "); \
+		section = parts[1]; \
+		description = substr($$2, length(section) + 2); \
+		sections[section] = sections[section] sprintf("  \033[36m%-15s\033[0m %s\n", $$1, description); \
+	} \
+	END { \
+		for (section in sections) { \
+			printf "\n\033[1m%s\033[0m\n", section; \
+			printf "%s", sections[section]; \
+		} \
+	}' $(MAKEFILE_LIST)
+
+version: ##@help Log the current version
 	@echo "v$(CURRENT_VERSION_PATCH)"
 
+# proto: ##@help For prototyping makefile functionality
+# 	@echo hello "$@"
+
 # -- Project --
-.PHONY: run wrun build-win build-linux build
+.PHONY: run wrun debug test build-win build-linux build
+
+run: ##@run Run normally. Pass arguments like so: args="arg1 arg2 ...".
+	go run ./main.go $(args)
+
+wrun: ##@run Run and watch for file changes. Requires wgo: https://github.com/bokwoon95/wgo
+	wgo run ./main.go $(args)
 
-run:
-	go run ./main.go
+debug: ##@run Run and watch with the --test flag. Requires wgo: https://github.com/bokwoon95/wgo
+	wgo run . $(args) --test
 
-wrun: # requires wgo: https://github.com/bokwoon95/wgo
-	wgo run ./main.go
+test: ##@run go test and watch. Requires wgo: https://github.com/bokwoon95/wgo
+	wgo -file .go go test -v ./...
 
-build-win:
-	GOOS=windows GOARCH=386 go build -o ./build/BitburnerGoFilesync.exe ./main.go
+build-win: ##@build Build for windows. Binary will be located at ./build/
+	GOOS=windows GOARCH=amd64 go build -o ./build/BitburnerGoFilesync.exe ./main.go
 
-build-linux:
+build-linux: ##@build Build for linux. Binary will be located at ./build/
 	GOOS=linux GOARCH=amd64 go build -o ./build/BitburnerGoFilesync ./main.go
 
-build:
+build: ##@build Build for both windows and linux. Binary will be located at ./build/
 	$(MAKE) build-win
 	$(MAKE) build-linux
 
 # -- Release --
 .PHONY: version-update patch minor major
 
-version-update:
+version-update: 
 	git tag "v$(VERS)"
 	git push --tags
 
-patch:
+patch: ##@versioning Release a patch (vx.x.+commits)
 	$(MAKE) version-update VERS=$(MAJOR).$(MINOR).$(NEXT_PATCH)
 
-minor:
+minor: ##@versioning Release a minor (vx.+1.x)
 	$(MAKE) version-update VERS=$(MAJOR).$(NEXT_MINOR).0
 
-major:
+major: ##@versioning Release a major (v+1.x.x)
 	$(MAKE) version-update VERS=$(NEXT_MAJOR).0.0

README.md

@@ -30,34 +30,58 @@ Current automated triggers:
     - linux: `BitburnerGoFilesync`
 2. Put the executable in same directory where you keep all your bitburner scripts
 3. Open a commandline in the directory you put the executable in
-4. Move on to **Usage**
+4. Move on to [Usage](#usage)
 
-You may skip step 2 and put the executable anywhere you like, but for the program to work you will then have to supply it with a `--dir` argument flag, more about that in **Arguments**.
+You may skip step 2 and put the executable anywhere you like, but for the program target the correct files,
+<br>you may need to specify youre preferred file path in the [config](#config),
+<br>or pass in the `--dir` argument, more about that in [Arguments](#arguments).
 
-Alternatively if you rather not download an executable from this repository (I would not blame you for being careful) you may also clone this repository and build it yourself:
+Alternatively if you rather not download an executable from this repository (I would not blame you for being careful)
+you may also clone this repository and [run/build it yourself](#how-to-build).
 
-## How to build
+## Usage
 
-### Requirements
-- [golang](https://go.dev/doc/install): To be able to run the code
+Once the executable is installed you are ready to get started with the game, the only thing you would still need to do is start the filesyncer via the commandline that you should have opened in step 3 of the installation guide.
 
-Once you have a clone of this repository and you installed the *long list* of requirements you may run the project in any of the following ways:
-- `make run`: This will run the project without any arguments.<br>
-    This method __does not__ accept arguments.
-- `go run main.go`: This is what `make run` would have done for you.<br>
-    This method __does accept__ arguments.
-- `make build`: This will compile the project into a binary.<br>
-    The binary will be located relative to the working directory of this project (where the main.go is) at `./build/`.
+Simply enter `BitburnerGoFilesync.exe` (or whatever the executable is called on your system) and pass in any arguments that you like to run it with.
 
-For more run methods you can check out the `./Makefile` and try any of its commands under `-- Project --`.
+## Config
 
+A config file will be created for you once you run the tool for the first time.
 
-## Usage
+The file will be located in the same directory that you ran the tool in, you can change that with the `--config` argument (use `--help config` for more info).
 
-Once the executable is installed you are ready to get started with the game, the only thing you would still need to do is start the filesyncer via the commandline that you should have opened in step 3 of the installation guide.
+The config file by default will be named `config.toml` and the initial content will be all possible fields for the config with their default values assigned to them.
+
+### Config Fields
 
-Simply enter `BitburnerGoFilesync.exe` (or whatever the executable is called on your system) and pass in any arguments that you like.
+**Legend**:
+- `[field]`: Group Section Header. This row's default column will instead be empty or hold relevant info.
+- `- field`: Section child field.
 
+| Field | Description | Default |
+|:-----|:------------|:-------:|
+| Port | Set the port for the server to connect to. | `"8080"` |
+| Directory | Specify the directory where this tool should watch for file changes to sync up with bitburner. | `"./"` |
+| FileScanInterval | The amount of miliseconds the file scanner waits each loop. | `100` |
+| [FilePatterns] | Holds include and exclude file pattern matching fields which allow you to define which files to sync and which not to. | [Pattern matching rules](https://github.com/bmatcuk/doublestar?tab=readme-ov-file#patterns) |
+| - Include | Which files should be included. | `["**/*.js", "**/*.ts"]` |
+| - Exclude | Which files to ignore. This is checked before the include patterns.  | `["**/*.d.ts"]` |
+
+## How to build
+
+### Requirements
+- [golang](https://go.dev/doc/install): To be able to run the project.
+- (Optional) [wgo](https://github.com/bokwoon95/wgo): This is required for some Makefile targets.
+<br>It is a tool that also watches the project for file changes and restarts it once anything is detected.
+
+Once you have a clone of this repository and you installed the "*long list*" of requirements you can run the project in one of two ways:
+1. Use `make [target]`.
+<br>To see all possible targets and their descriptions, run `make help`.
+2. Manually type out what you want to run.
+<br>This would be something along the lines of `go run . --arg1 param --arg2 ...`.
+
+If you are looking to contribute, please read the [Contribution Guidelines](https://github.com/CTNOriginals/BitburnerGoFilesync?tab=readme-ov-file).
 
 ## Arguments
 
@@ -67,11 +91,11 @@ Formatting Rules:
     Each new argument always has to start with a double dash '--'.
     If the argument does not start with '--' it is considered a parameter
     for the most recent argument that started with '--'.
-
+    
     Each argument may have any number of parameters,
     to check what an argument may accept or require,
     you can do --help followed by the name of the argument without the '--'.
-
+    
     Some arguments may accept a specific amount of parameters where others accept a range.
     If an argument doesnt have its required parameters, it will say so in the console,
     this argument will not execute anything after that and will be ignored.
@@ -90,6 +114,15 @@ Formatting Rules:
     The same as --help, but it also includes all of the extra information
     as if you entered --help <command> for each argument.
 
+--config:
+    Define the config.toml file path.
+    By default, the config file is located in the same directory as the binary.
+    If no config file exists at the specified location, one will be created.
+  Parameters:
+    filepath:
+      The path to the config file
+      Default: /home/ctn/code/bitburner/gofilesync/config.toml
+
 --dir:
     Specify the directory where this tool should watch
     for file changes to sync up with bitburner
@@ -128,7 +161,7 @@ Formatting Rules:
 
 DEBUG ARGUMENTS
 
---test:
+--test, --debug:
     Runs the test function if it exists
 
 --no-watcher:

arguments/arguments.go

@@ -9,6 +9,7 @@ import (
 	"github.com/CTNOriginals/BitburnerGoFilesync/communication"
 	"github.com/CTNOriginals/BitburnerGoFilesync/communication/constructor"
 	"github.com/CTNOriginals/BitburnerGoFilesync/communication/definitions"
+	"github.com/CTNOriginals/BitburnerGoFilesync/config"
 	"github.com/CTNOriginals/BitburnerGoFilesync/constants"
 	"github.com/CTNOriginals/BitburnerGoFilesync/test"
 	"github.com/gorilla/websocket"
@@ -107,6 +108,27 @@ var argumentList = argList{
 			os.Exit(0)
 		},
 	},
+	{Alias: []string{"--config"},
+		Description: []string{
+			"Define the config.toml file path.",
+			"By default, the config file is located in the same directory as the binary.",
+			"If no config file exists at the specified location, one will be created.",
+		},
+		Params: argParameters{
+			{Name: "filepath", Description: []string{
+				"The path to the config file",
+				"Default: " + constants.ConfigFilePath,
+			}},
+		},
+		Action: func(params []string) {
+			if len(params) == 0 {
+				fmt.Print("'--config' requires at least 1 parameter.\n")
+				os.Exit(1)
+			}
+
+			constants.ConfigFilePath = params[0]
+		},
+	},
 	{Alias: []string{"--dir"},
 		Description: []string{
 			"Specify the directory where this tool should watch",
@@ -129,7 +151,7 @@ var argumentList = argList{
 				os.Exit(1)
 			}
 
-			constants.SetBitburnerDir(params[0])
+			config.ValidateBitburnerDirectory(params[0])
 		},
 	},
 	{Alias: []string{"--include-ext", "--ext"},
@@ -144,7 +166,7 @@ var argumentList = argList{
 			}},
 		},
 		Action: func(params []string) {
-			constants.IncludeFileExt = params
+			config.Values.FilePatterns.Include = params
 		},
 	},
 	{Alias: []string{"--port"},
@@ -164,7 +186,7 @@ var argumentList = argList{
 				os.Exit(1)
 			}
 
-			constants.Port = params[0]
+			config.Values.Port = params[0]
 		},
 	},
 	{Alias: []string{"--scan-interval", "--interval"},
@@ -196,7 +218,7 @@ var argumentList = argList{
 				os.Exit(1)
 			}
 
-			constants.FileScanDelay = int(num)
+			config.Values.FileScanInterval = int(num)
 		},
 	},
 	{Alias: []string{"--get-definitions"},
@@ -217,7 +239,7 @@ var argumentList = argList{
 					fmt.Printf("'--get-definitions' expects a string response but received another type instead: %v", message.Response)
 					return
 				}
-				ctnfile.WriteFile(constants.BitburnerRoot+"/NetscriptDefinitions.d.ts", strings.Split(content, "\n"))
+				ctnfile.WriteFile(config.Values.Directory+"/NetscriptDefinitions.d.ts", strings.Split(content, "\n"))
 			}
 
 			var onConnect = func(ws *websocket.Conn) {
@@ -230,12 +252,13 @@ var argumentList = argList{
 
 	{Alias: []string{"DEBUG ARGUMENTS"}},
 
-	{Alias: []string{"--test"},
+	{Alias: []string{"--test", "--debug"},
 		Description: []string{
 			"Runs the test function if it exists",
 		},
 		Params: argParameters{},
 		Action: func(params []string) {
+			constants.Debug = true
 			test.DoTest()
 			os.Exit(0)
 		},

arguments/parser.go

@@ -1,12 +1,43 @@
 package arguments
 
-import "fmt"
+import (
+	"fmt"
+	"slices"
+)
 
 type argStream struct {
 	Alias  string
 	Params []string
 }
 
+// Parse specific args removes any args and their params
+// from args if they are not included in list
+// or if include is false, the args in list will be remove from args instead.
+func ParseSpecificArgs(args []string, include bool, list ...string) {
+	if len(list) == 0 {
+		if !include {
+			ParseArgs(args)
+		}
+
+		return
+	}
+
+	var validArgs = []string{}
+	var validArg = false
+
+	for _, part := range args {
+		if len(part) >= 2 && part[0:2] == "--" {
+			validArg = include == slices.Contains(list, part)
+		}
+
+		if validArg {
+			validArgs = append(validArgs, part)
+		}
+	}
+
+	ParseArgs(validArgs)
+}
+
 func ParseArgs(args []string) {
 	onInitList = argumentList