gofile

gofile

Gofile is a simple file and directory manipulation tool primarily useful for building go applications and libraries.

Go is module and GOPATH aware, and is cross-platform. Any directory can be represented as a module name, followed by a subdirectory and the real path of the module will be substituted for the module name. Path names should use forward slashes to separate directories, and you can substitute environment variables into the path names using $VAR, or ${VAR} syntax.

Gofile is particularly useful for making build scripts for open-source projects. The cross-platform feature allows you to create command-line scripts that will work on Windows and Unix based systems. The module aware feature allows you to specify a path relative to a module's location, simply by starting the path with the module specifier. If you are not working in Module-aware mode, it will use the GOPATH to locate packages instead.

If you are using modules, there may be times when you would like to work on packages and modules that are in your go.mod file's require statements. However, in module-aware mode, these files are located in your GOPATH and the GOPATH is write-protected, so you cannot edit those files. The solution is to use a replace statement in your go.mod file to temporarily point the module to different location on your disk. For example, the following replace statement will change where the go build system will look for the gofile source:

replace github.com/goradd/gofile => ../gofile-src // to work with a local version of gofile

However, this can pose other problems if your build system is copying files out of one of these modules. If you use the GOPATH environment variable in your build scripts to locate a module, it will not know about the change you made in the go.mod file. Gofile solves this problem by substituting a module name for its disk location. For example,

gofile copy github.com/goradd/gofile/README.md /a/b/ will copy this README file to the /a/b/ directory on your disk, even if you have changed the location of the gofile module using a replace statement. Gofile looks for the go.mod file by searching for it in the current working directory, and parent directories until it finds one. Note that this is standard behavior of the go build tools and not under gofile's control.

Gofile exports the ModulePaths() function as a library so you can build your own module aware tools.

Installation

go get -u github.com/goradd/gofile/...

Usage

gofile <command> <args...> [options] 

Commands

With most of the following commands, -v will output status information while gofile is running.

-x specifies what to exclude when expanding a path that uses * or ? expansions. Note that the * pattern does not match the path separator, so it only expands one level deep. The exclude pattern can include wild cards like * and ?, but it will only compare against the last item in a path. For example, if you have the following directories in the /tmp directory:

• test1
• test2

Then specifying -x test2 /tmp/* will result in only /tmp/test1 being used.

-o will force

Help

gofile -h

will print a complete description of the options and arguments of gofile.

Copy

Copies a file or directory to another file or directory.

Usage:

gofile copy [-x excludes...] [-o|-n] <src> <dest> 

-x specifies names of files or directories you want to exclude from the source. This is useful when expanding a directory using '*'.

Normally, a previously existing file will not be overwritten, and a previously existing directory will not be deleted first but rather files will be added that are not present in the directory. The -o option will force an overwrite of previously existing files, and the -n option will overwrite only if the new file is newer than the old one. If you want to replace a previously existing directory, use the remove command described below first.

Generate

Runs go generate on the given file.

Usage:

gofile generate [-x excludes...] <sources...>

-x specifies names of files or directories you want to exclude from the source. This is useful when expanding a directory using '*'.

Mkdir

Creates the named directory if it does not exist. Sets it to be writable.

Usage:

gofile mkdir <dest>

Remove

Deletes the named directories or files.

Usage:

gofile remove [-x excludes...] <dest...> 

-x specifies names of files or directories you want to exclude from the destination. This is useful when expanding a directory using '*'.

GZip

Compresses the given files.

If a directory is specified, then the files inside that directory are individually compressed. This will recursively do the same to directories within the specified directory.

Compressed files are placed in the same directory as the source file, and the file name is appended with ".gz"

Usage:

gofile gzip [-d] [-x excludes...] <dest...> 

-x specifies names of files or directories you want to exclude from compression. For exmaple, "-x *.txt" will prevent all files ending in ".txt" from being compressed. Specifying the name of a directory will exclude all the files within that directory.

-d will delete the source file after being compressed. Excluded files specified in the -x option are not deleted.