Categorygithub.com/windmillcode/go_cli_scripts/v4
modulepackage
4.5.5
Repository: https://github.com/windmillcode/go_cli_scripts.git
Documentation: pkg.go.dev
Overview
Versions
4
Dependencies
5
Dependents
0
Files
163 SLOC

# README

Changelog

v1.0.0

  • utils.GetItemsInFolder now has just one argument for convenience

v1.0.1

  • added FilterArray which makes it more convenient to filter an array given an array and predicate(condition function)
  • added methods that would cast the interface to the appropriate type

v1.0.2

  • made a slight change

v1.0.3

  • added index to element

v1.1.0

  • added FilterMapByKeys all all the respective casting fns

v1.1.1

  • added func OverwriteMap which is like js Object.assign

v1.1.2

  • added func OverwriteMap which is like js Object.assign

v2.0.0

  • replaced FilterMapByKeys with FilterMap where its predicate fn accepts key,val

v2.0.1

  • added FilterJSONByPredicate

v2.0.2

  • added WriteCustomFormattedJSONToFile to help format files

v2.0.5

  • WriteCustomFormattedJSONToFile supports bytes and interface strcutures, added UnicodeUnquote which will remove all unicode from a string when writing from bytes to a file,

v2.0.6

  • added AddContentToEachLineInFile AddContentToFile, which takes a predicate function and updates the file based on the return of the predicate fn

v2.1.1

  • added MergeDirectories fn which would merge all files and folders from target dir into source dir w/o overrting anything

v2.1.2

  • added RunCommandWithOptions fn which supports optional target dir,optional get output, and panic on error

v2.1.3

  • added TraverseDirectory with a predicate fn

v2.1.4

  • added TruncateStringByRegex fn which allows the end user to provide a regex and has a predicate fn for every match in the pattern matcher which if returns true removes the substr from the array

v2.1.5

  • additional updates

v3.0.0

  • added cli and changed name to go_cli_scripts

v3.1.0

  • updated RunCommandWithOptions to print out standard err along with the reason why the command failed

v3.1.1

  • indicated all RunCommand fns are deprecated and RunCommandWithOptions should be used instead

v3.1.2

  • added ProcessFoldersMatchingPattern just like ProcessFilesMatchingPattern

v3.1.5

added CreateStringObject an object that will give all sorts of cases camelCase kebab snakeCase classify

  • fixied CreateStringObject

v3.1.6

added IsRunningInDocker to see whether the given go script is running in a docker container or not

v3.2.0

  • [PATCH] updated GetInputFromStdin and ShowMenu to immediately cancel when the user hits Ctrl+C

v3.2.1 [1/5/24]

  • [PATCH] build mechanism seems to unexpectedly add unwanted code this patch should fix that

v3.3.0 [1/6/24]

  • [PATCH] fixed issue with RunCommandWithOptions where output gets returned from the program and printed to console
  • added Uppercase method to CreateStringObjectType

v3.3.1 [1/11/24]

  • [PATCH] IsRunningInDocker will able to detect for macbooks as well

v3.3.3 [1/17/24]

  • [UPDATE] added ProxyURLs string json:"proxyURLs" for the VSCodeSettings.ExtensionPack struct

v4.0.2 [1/17/24]

  • [BREAKING CHANGE] TakeVariableArgs returns TakeVariableArgsResultStruct
type TakeVariableArgsResultStruct struct{
	inputString  string
	inputArray   []string
}

v4.1.0 [1/17/24]

  • added github_utils and

  • file_utils FindExecutable GetSourceFilePath ExtractArchive DownloadFile

  • string_utils ContainsAny

methods

v4.2.0 [1/18/24]

  • [MAJOR UPDATE] finally got RunCommandWithOptions to work as intended stdout prints to terminal in addition to returning output from the inner running program to the main program

v4.2.1 [1/18/24]

  • [UPDATE] added PrintOutput to CommandOptions to optionally prevent output from getting to the command line

v4.2.4 [1/18/24]

  • [UPDATE] added PrintOutputOnly to CommandOptions by default stdOut. returns the final value of the program to the outer command running it and prints output to the command line, because of edge case this was added to only print output to the command line for convience sake
  • [UPDATE] added TasksToRunOnFolderOpen for the vscode extension

v4.3.4 [1/24/24]

  • [NEW FEATURE] Enhanced WatchDirectory function for dynamic directory monitoring with advanced filtering options.

    type WatchDirectoryParams struct {
    DirectoryToWatch string
    DebounceInMs     int
    Predicate        func(event fsnotify.Event)
    StartOnWatch     bool
    IncludePatterns  []string
    ExcludePatterns  []string
}
    • The WatchDirectory function now includes parameters for include and exclude patterns using glob strings, allowing for more precise monitoring of directory changes.
    • Added StartOnWatch boolean parameter to immediately invoke the predicate function on the existing files in the directory at the start.
    • The include and exclude patterns are compiled using CompileGlobs and checked against each file event using MatchAnyGlob.

  • [UPDATE] CommandOptions struct enhancements for process control.

    type CommandOptions struct {
    // ... existing fields ...
    CmdObj      *exec.Cmd
    NonBlocking bool
}

func (c CommandOptions) EndProcess() error {
    return c.CmdObj.Process.Kill()
}
    • Enhanced CommandOptions to include CmdObj for direct process handling and NonBlocking boolean for asynchronous command execution.
    • Added EndProcess method to facilitate immediate termination of the process associated with CmdObj.

v4.4.1 [1/24/24]

  • [UPDATE] - added ShowMenuMultiple to allow the user to select multiple options along with SelectionLimit int SelectedValues []string SelectedDelimiter string properties
  • [UPDATE] - added RemoveContentFromFile function
  • [FIX] - fixed EndProcess command to leverage the pointer to Self on the options.CommandOptions struct via the Self property
  • you the developer have to provide the self property in order for EndProcess to find the command and kill it effectively

v4.4.2 [1/28/24]

[PATCH] - fixed issue with EndProcess where it would kill the process but hang in the function it was called

  • a glitch allows this fix to be found in 4.4.1

v4.4.3 [1/30/24]

  • [UPDATE] - added RemoveElementsNotInSource ArrayContainsAny array fns

v4.4.4 [2/29/24]

  • [UPDATE] - updated CDToLocation to accept a createIfNotExist parameter (2 argument)

v4.5.0 [3/9/24]

  • [UPDATE] - Added a new task "major update project" in .vscode/tasks.json.
  • [FEATURE] - Introduced a new utility file docker-utils.go with a function to check if running inside Docker.
  • [PATCH] - Updated vscode_settings_utils.go to use yaml.Unmarshal instead of json.Unmarshal.
  • [REMOVE] - Removed redundant IsRunningInDocker function from vscode_settings_utils.go.

v4.5.1 [3/9/24]

  • [UPDATE] - Added a new dependency github.com/tailscale/hujson in go.mod and updated go.sum accordingly.
  • [FEATURE] - Introduced a new function StandardizeJSON in utils/json_utils.go using hujson to standardize JSON input.
  • [FIX] - Modified GetSettingsJSON in utils/vscode_settings_utils.go to use StandardizeJSON for processing input before unmarshalling.

v4.5.4 [3/10/24]

  • [REMOVE] - Removed the dependency github.com/tailscale/hujson from go.mod.
  • [UPDATE] - Updated go.sum to reflect changes in dependencies.
  • [UPDATE] - Modified the StandardizeJSON function in utils/json_utils.go to RemoveComments, which now removes line and block comments from JSON strings.
  • [UPDATE] - Updated GetSettingsJSON in utils/vscode_settings_utils.go to use RemoveComments instead of StandardizeJSON for processing input before unmarshalling.
  • [FIX] - Added error handling in RemoveComments to check for JSON validity after removing comments.

v4.5.5 [3/28/24]

[REMOVE] output.txt and scratchpad.go files were deleted. The output.txt file contained various utility functions and scratchpad.go included main package content with file operations.

[UPDATE] copy_utils.go and file_utils.go in the utils directory were updated. In copy_utils.go, comments were removed, and error handling was improved for directory copying logic. In file_utils.go, a new function FilterFilesByExtension was added to filter files based on their extensions.

# Packages

19 types.