is-git-ref-name-valid
Check that a git reference name is well formed, per git-check-ref-format(1)
.
Usage
const validRef = // true // false
Same as git check-ref-format
, the reference name must contain a /
by default. This can be disabled:
// false // true
To validate branch names, for which there are additional rules, use is-git-branch-name-valid
.
API
validRef(name[, onelevel])
Takes a string name
and an optional onelevel
boolean. Returns true if name
is well formed. Throws if name
is not a string. If onelevel
is true then name
does not have to contain a /
.
Install
With npm do:
npm install is-git-ref-name-valid
License
MIT © Vincent Weevers