This is a library for Git written in Node.js. It's as close a port of grit http://github.com/mojombo/grit.

The idea is to allow for manipulation of git repositories by the node.js application. Not everything isimplemented directly in node-git. Some of the stuff is using the native git command line instead ofdirect javascript code. Also it's fairly synchronous right now but that will hopefully change a littleby little over time as it gets more stable and I start using it in real life scenarios.

Installing git and running npm install from git-bash worked for me. Make sure you are in the correct directory. Make sure you are in the correct directory. Share| improve this answer. The idea is to allow for manipulation of git repositories by the node.js application. Not everything is implemented directly in node-git. Some of the stuff is using the native git command line instead of direct javascript code. I continue to have issues with node 6.9.0 and npm 5.3.0. I have gone as far as pushing all github packages to a private npm server to work around this issue.

Github information

The source code is available at http://github.com/christkv/node-git.You can either clone the repository or download a tarball of the latest release.

Once you have the source you can test the driver by running

On windows:

Examples

For simple examples of usage look at the tests included in the repository.

Notes

The current version is basic git support, don't expect everything to work as you expect itoff the bat.

License

Install

Usage

As a node module:

As a command-line utility:

Versions

A 'version' is described by the v2.0.0 specification found athttps://semver.org/.

A leading '=' or 'v' character is stripped off and ignored.

Ranges

A version range is a set of comparators which specify versionsthat satisfy the range.

A comparator is composed of an operator and a version. The setof primitive operators is:

• < Less than
• <= Less than or equal to
• > Greater than
• >= Greater than or equal to
• = Equal. If no operator is specified, then equality is assumed,so this operator is optional, but MAY be included.

For example, the comparator >=1.2.7 would match the versions1.2.7, 1.2.8, 2.5.3, and 1.3.9, but not the versions 1.2.6or 1.1.0.

Comparators can be joined by whitespace to form a comparator set,which is satisfied by the intersection of all of the comparatorsit includes.

A range is composed of one or more comparator sets, joined by ||. Aversion matches a range if and only if every comparator in at leastone of the ||-separated comparator sets is satisfied by the version.

For example, the range >=1.2.7 <1.3.0 would match the versions1.2.7, 1.2.8, and 1.2.99, but not the versions 1.2.6, 1.3.0,or 1.1.0.

The range 1.2.7 || >=1.2.9 <2.0.0 would match the versions 1.2.7,1.2.9, and 1.4.6, but not the versions 1.2.8 or 2.0.0.

Prerelease Tags

If a version has a prerelease tag (for example, 1.2.3-alpha.3) thenit will only be allowed to satisfy comparator sets if at least onecomparator with the same [major, minor, patch] tuple also has aprerelease tag.

For example, the range >1.2.3-alpha.3 would be allowed to match theversion 1.2.3-alpha.7, but it would not be satisfied by3.4.5-alpha.9, even though 3.4.5-alpha.9 is technically 'greaterthan' 1.2.3-alpha.3 according to the SemVer sort rules. The versionrange only accepts prerelease tags on the 1.2.3 version. Theversion 3.4.5would satisfy the range, because it does not have aprerelease flag, and 3.4.5 is greater than 1.2.3-alpha.7.

The purpose for this behavior is twofold. First, prerelease versionsfrequently are updated very quickly, and contain many breaking changesthat are (by the author's design) not yet fit for public consumption.Therefore, by default, they are excluded from range matchingsemantics.

Second, a user who has opted into using a prerelease version hasclearly indicated the intent to use that specific set ofalpha/beta/rc versions. By including a prerelease tag in the range,the user is indicating that they are aware of the risk. However, itis still not appropriate to assume that they have opted into taking asimilar risk on the next set of prerelease versions.

Note that this behavior can be suppressed (treating all prereleaseversions as if they were normal versions, for the purpose of rangematching) by setting the includePrerelease flag on the optionsobject to anyfunctions that dorange matching.

Prerelease Identifiers

The method .inc takes an additional identifier string argument thatwill append the value of the string as a prerelease identifier:

command-line example:

Which then can be used to increment further:

Advanced Range Syntax

Advanced range syntax desugars to primitive comparators indeterministic ways.

Advanced ranges may be combined in the same way as primitivecomparators using white space or ||.

Hyphen Ranges X.Y.Z - A.B.C

Specifies an inclusive set.

• 1.2.3 - 2.3.4 := >=1.2.3 <=2.3.4

If a partial version is provided as the first version in the inclusiverange, then the missing pieces are replaced with zeroes.

• 1.2 - 2.3.4 := >=1.2.0 <=2.3.4

If a partial version is provided as the second version in theinclusive range, then all versions that start with the supplied partsof the tuple are accepted, but nothing that would be greater than theprovided tuple parts.

• 1.2.3 - 2.3 := >=1.2.3 <2.4.0
• 1.2.3 - 2 := >=1.2.3 <3.0.0

X-Ranges 1.2.x1.X1.2.**

Any of X, x, or * may be used to 'stand in' for one of thenumeric values in the [major, minor, patch] tuple.

• * := >=0.0.0 (Any version satisfies)
• 1.x := >=1.0.0 <2.0.0 (Matching major version)
• 1.2.x := >=1.2.0 <1.3.0 (Matching major and minor versions)

A partial version range is treated as an X-Range, so the specialcharacter is in fact optional.

• ' (empty string) := * := >=0.0.0
• 1 := 1.x.x := >=1.0.0 <2.0.0
• 1.2 := 1.2.x := >=1.2.0 <1.3.0

Tilde Ranges ~1.2.3~1.2~1

Allows patch-level changes if a minor version is specified on thecomparator. Allows minor-level changes if not.

• ~1.2.3 := >=1.2.3 <1.(2+1).0 := >=1.2.3 <1.3.0
• ~1.2 := >=1.2.0 <1.(2+1).0 := >=1.2.0 <1.3.0 (Same as 1.2.x)
• ~1 := >=1.0.0 <(1+1).0.0 := >=1.0.0 <2.0.0 (Same as 1.x)
• ~0.2.3 := >=0.2.3 <0.(2+1).0 := >=0.2.3 <0.3.0
• ~0.2 := >=0.2.0 <0.(2+1).0 := >=0.2.0 <0.3.0 (Same as 0.2.x)
• ~0 := >=0.0.0 <(0+1).0.0 := >=0.0.0 <1.0.0 (Same as 0.x)
• ~1.2.3-beta.2 := >=1.2.3-beta.2 <1.3.0 Note that prereleases inthe 1.2.3 version will be allowed, if they are greater than orequal to beta.2. So, 1.2.3-beta.4 would be allowed, but1.2.4-beta.2 would not, because it is a prerelease of adifferent [major, minor, patch] tuple.

Caret Ranges ^1.2.3^0.2.5^0.0.4

Allows changes that do not modify the left-most non-zero element in the[major, minor, patch] tuple. In other words, this allows patch andminor updates for versions 1.0.0 and above, patch updates forversions 0.X >=0.1.0, and no updates for versions 0.0.X.

Many authors treat a 0.x version as if the x were the major'breaking-change' indicator.

Caret ranges are ideal when an author may make breaking changesbetween 0.2.4 and 0.3.0 releases, which is a common practice.However, it presumes that there will not be breaking changes between0.2.4 and 0.2.5. It allows for changes that are presumed to beadditive (but non-breaking), according to commonly observed practices.

Npm

• ^1.2.3 := >=1.2.3 <2.0.0
• ^0.2.3 := >=0.2.3 <0.3.0
• ^0.0.3 := >=0.0.3 <0.0.4
• ^1.2.3-beta.2 := >=1.2.3-beta.2 <2.0.0 Note that prereleases inthe 1.2.3 version will be allowed, if they are greater than orequal to beta.2. So, 1.2.3-beta.4 would be allowed, but1.2.4-beta.2 would not, because it is a prerelease of adifferent [major, minor, patch] tuple.
• ^0.0.3-beta := >=0.0.3-beta <0.0.4 Note that prereleases in the0.0.3 version only will be allowed, if they are greater than orequal to beta. So, 0.0.3-pr.2 would be allowed.

When parsing caret ranges, a missing patch value desugars to thenumber 0, but will allow flexibility within that value, even if themajor and minor versions are both 0.

• ^1.2.x := >=1.2.0 <2.0.0
• ^0.0.x := >=0.0.0 <0.1.0
• ^0.0 := >=0.0.0 <0.1.0

A missing minor and patch values will desugar to zero, but alsoallow flexibility within those values, even if the major version iszero.

• ^1.x := >=1.0.0 <2.0.0
• ^0.x := >=0.0.0 <1.0.0

Range Grammar

Putting all this together, here is a Backus-Naur grammar for ranges,for the benefit of parser authors:

Functions

All methods and classes take a final options object argument. Alloptions in this object are false by default. The options supportedare:

• loose Be more forgiving about not-quite-valid semver strings.(Any resulting output will always be 100% strict compliant, ofcourse.) For backwards compatibility reasons, if the optionsargument is a boolean value instead of an object, it is interpretedto be the loose param.
• includePrerelease Set to suppress the defaultbehavior ofexcluding prerelease tagged versions from ranges unless they areexplicitly opted into.

Strict-mode Comparators and Ranges will be strict about the SemVerstrings that they parse.

• valid(v): Return the parsed version, or null if it's not valid.
• inc(v, release): Return the version incremented by the releasetype (major, premajor, minor, preminor, patch,prepatch, or prerelease), or null if it's not valid
  • premajor in one call will bump the version up to the next majorversion and down to a prerelease of that major version.preminor, and prepatch work the same way.
  • If called from a non-prerelease version, the prerelease will work thesame as prepatch. It increments the patch version, then makes aprerelease. If the input version is already a prerelease it simplyincrements it.
• prerelease(v): Returns an array of prerelease components, or nullif none exist. Example: prerelease('1.2.3-alpha.1') -> ['alpha', 1]
• major(v): Return the major version number.
• minor(v): Return the minor version number.
• patch(v): Return the patch version number.
• intersects(r1, r2, loose): Return true if the two supplied rangesor comparators intersect.
• parse(v): Attempt to parse a string as a semantic version, returning eithera SemVer object or null.

Comparison

• gt(v1, v2): v1 > v2
• gte(v1, v2): v1 >= v2
• lt(v1, v2): v1 < v2
• lte(v1, v2): v1 <= v2
• eq(v1, v2): v1 v2 This is true if they're logically equivalent,even if they're not the exact same string. You already know how tocompare strings.
• neq(v1, v2): v1 != v2 The opposite of eq.
• cmp(v1, comparator, v2): Pass in a comparison string, and it'll callthe corresponding function above. ' and '!' do simplestring comparison, but are included for completeness. Throws if aninvalid comparison string is provided.
• compare(v1, v2): Return 0 if v1 v2, or 1 if v1 is greater, or -1 ifv2 is greater. Sorts in ascending order if passed to Array.sort().
• rcompare(v1, v2): The reverse of compare. Sorts an array of versionsin descending order when passed to Array.sort().
• compareBuild(v1, v2): The same as compare but considers build when two versionsare equal. Sorts in ascending order if passed to Array.sort().v2 is greater. Sorts in ascending order if passed to Array.sort().
• diff(v1, v2): Returns difference between two versions by the release type(major, premajor, minor, preminor, patch, prepatch, or prerelease),or null if the versions are the same.

Comparators

• intersects(comparator): Return true if the comparators intersect

Ranges

• validRange(range): Return the valid range or null if it's not valid
• satisfies(version, range): Return true if the version satisfies therange.
• maxSatisfying(versions, range): Return the highest version in the listthat satisfies the range, or null if none of them do.
• minSatisfying(versions, range): Return the lowest version in the listthat satisfies the range, or null if none of them do.
• minVersion(range): Return the lowest version that can possibly matchthe given range.
• gtr(version, range): Return true if version is greater than all theversions possible in the range.
• ltr(version, range): Return true if version is less than all theversions possible in the range.
• outside(version, range, hilo): Return true if the version is outsidethe bounds of the range in either the high or low direction. Thehilo argument must be either the string '>' or '<'. (This isthe function called by gtr and ltr.)
• intersects(range): Return true if any of the ranges comparators intersect

Note that, since ranges may be non-contiguous, a version might not begreater than a range, less than a range, or satisfy a range! Forexample, the range 1.2 <1.2.9 || >2.0.0 would have a hole from 1.2.9until 2.0.0, so the version 1.2.10 would not be greater than therange (because 2.0.1 satisfies, which is higher), nor less than therange (since 1.2.8 satisfies, which is lower), and it also does notsatisfy the range.

If you want to know if a version satisfies or does not satisfy arange, use the satisfies(version, range) function.

Coercion

• coerce(version, options): Coerces a string to semver if possible

This aims to provide a very forgiving translation of a non-semver string tosemver. It looks for the first digit in a string, and consumes allremaining characters which satisfy at least a partial semver (e.g., 1,1.2, 1.2.3) up to the max permitted length (256 characters). Longerversions are simply truncated (4.6.3.9.2-alpha2 becomes 4.6.3). Allsurrounding text is simply ignored (v3.4 replaces v3.3.1 becomes3.4.0). Only text which lacks digits will fail coercion (version oneis not valid). The maximum length for any semver component considered forcoercion is 16 characters; longer components will be ignored(10000000000000000.4.7.4 becomes 4.7.4). The maximum value for anysemver component is Number.MAX_SAFE_INTEGER || (2**53 - 1); higher valuecomponents are invalid (9999999999999999.4.7.4 is likely invalid).

If the options.rtl flag is set, then coerce will return the right-mostcoercible tuple that does not share an ending index with a longer coercibletuple. For example, 1.2.3.4 will return 2.3.4 in rtl mode, not4.0.0. 1.2.3/4 will return 4.0.0, because the 4 is not a part ofany other overlapping SemVer tuple.

How To Install Npm

Clean

• clean(version): Clean a string to be a valid semver if possible

This will return a cleaned and trimmed semver version. If the provided version is not valid a null will be returned. This does not work for ranges.

ex.

• s.clean(' = v 2.1.5foo'): null
• s.clean(' = v 2.1.5foo', { loose: true }): '2.1.5-foo'
• s.clean(' = v 2.1.5-foo'): null
• s.clean(' = v 2.1.5-foo', { loose: true }): '2.1.5-foo'
• s.clean('=v2.1.5'): '2.1.5'
• s.clean(' =v2.1.5'): 2.1.5
• s.clean(' 2.1.5 '): '2.1.5'
• s.clean('~1.0.0'): null