gmake

command module
v0.0.0-...-1d1855d Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 11, 2019 License: MIT Imports: 6 Imported by: 0

README

rmake

Usage

rmake is a wrapper around make written in Go.

rmake invokes make with any arguments that it was passed.

rmake looks for a Makefile in the current working directory, if none is found it moves up to the parent directory.

This process is repeated till a Makefile is found or till the user's home directory is reached at which point rmake will make a best effort call to make from the original directory in which rmake was called

Install

Install rmake by running the following command in your shell.

go get github.com/joshi4/rmake

To install go and setup the work environment see this link.

NOTE: Make sure you've set the GOPATH variable correctly :)

Motivation

The most common mistake I make while using make ( no pun intended ) is to invoke the command from a child directory where no Makefile is present.

I estimate I run make about 50 - 100 times a day and hit the above error about 90% of the time. This tool is my attempt to solve this pain point.

Alternatives

make provides a -C flag which accepts the path to the make file but that defeats the purpose as it is more effort/time consuming to type it out.

Using your bash history reduces the pain of repeating the -C flag, however, that fails when you have to switch amongst different repos/makefiles quite frequently.

Infact, using rmake will make it possible to use your bash history more consistently as rmake test or rmake build are common enough and the -C flag is abstracted away

Testing

We have a simple end to end test for rmake in CI. Please see the .travis.yml file

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL