2
0
Fork 0
mirror of https://github.com/kdabir/has.git synced 2024-11-11 14:40:48 +01:00
Find a file
2018-12-03 09:17:49 +05:30
.editorconfig release 1.0 2017-08-29 12:01:11 +05:30
.gitattributes adding usual suspects for project root 2015-02-12 19:28:24 +05:30
.gitignore implements #15 2018-11-16 16:01:11 +05:30
.hasrc #15 docs on project specific .hasrc 2018-11-16 17:19:46 +05:30
.hastest.bats fix regression created with #15. self verion had stopped working. now added a test for it 2018-11-17 11:05:14 +05:30
.travis.yml release 1.0 2017-08-29 12:01:11 +05:30
demo.svg update demo 2018-11-15 13:24:22 +05:30
has release v1.4.0 2018-11-18 17:37:01 +05:30
LICENSE its possible because of many more 2018-11-15 10:44:33 +05:30
Makefile release 1.0 2017-08-29 12:01:11 +05:30
README.md Update README.md 2018-12-03 09:17:49 +05:30

has

has checks presence of various command line tools on the PATH and reports their installed version.

Build Status Open Source Helpers

demo

How ?

Install the has script. There is no dependency apart from bash itself

$ has node npm java git gradle 
✔ node 8.2.1
✔ npm 5.3.0
✔ java 1.8.0
✔ git 2.14.1
✔ gradle 4.0.1

If everything is good has exits with status code 0. The status code reflects number of commands not found on your path.

$ has node go javac
✔ node 8.2.1
✔ go 1.8.3
✘ javac

And echo the status:

$ echo $?
1

Installing

has is a single bash script that does it all. Just download the script and make it available on your $PATH. However, to make it even simpler, just follow one of these methods.

Cloning the Repo

Just execute the following command in terminal, it clones has repo and install it in your path

git clone https://github.com/kdabir/has.git && cd has && make install

To update just do a git pull and make install.

Downloading to a file

curl -sL https://git.io/_has > /usr/local/bin/has

This command is safe to be called multiple times as well. (to update has)

Running directly off the internet

If you are lazy, you can run has directly off the internet as well:

curl -sL https://git.io/_has | bash -s git node npm
✔ git 2.14.1
✔ node 8.2.1
✔ npm 5.3.0

ProTip: if that's too much of typing every time, setup an alias in your .bashrc/.zshrc file:

alias has="curl -sL https://git.io/_has | bash -s"

And use it

$ has git
✔ git 2.14.1

Command not understood by has?

Let's say $ has foobar returns foobar not understood, because has may not have whitelisted foobar.

In such cases, pass HAS_ALLOW_UNSAFE=y has foobar. This is should still check for existance of foobar and tries to detect version as well.

The .hasrc file

has looks for .hasrc file in the directory from where has command is issued. This file can contain commands that has will check for. List one command per line. Lines starting with # are treated as comments.

Following is example of .hasrc file:

# tools
git
curl

# interpreters
ruby
node

When has is run in dir containing this file, it produces:

$ has
✔ git 2.19.1
✔ curl 7.54.0
✔ ruby 2.3.1
✔ node 10.7.0

Also, CLI arguments passed to has are additive to .hasrc file. For example, in the same dir, if the following command is fired, has checks for both commands passed from cli args and provided in .hasrc file.

$ has java
✔ java 11.0.1
✔ git 2.19.1
✔ curl 7.54.0
✔ ruby 2.3.1
✔ node 10.7.0

Pro Tip: commit .hasrc file in root of your project. This can work as a quick check for confirming presence all command line tools required to build and run your project.

On machines that don't even have has installed, your project's .hasrc is honored by this command:

curl -sL https://git.io/_has | bash -s

take a look at .hasrc file of this repo

Contributing

  1. Star the repo, tweet about it, spread the word
  2. Update the documentation (i.e. the README file)
  3. Adding support for more commands
  4. Adding more features to has

Adding Features

If you are contributing a feature, please ensure to check current tests. Add test cases for your feature. Tests are executed using the excellent bats testing framework. Add tests and run make test

Raise the PR and make sure the tests pass on Travis-CI.