https://github.com/boneskull/node-hg
Git mirror of project node-hg, a command server client for Mercurial.
https://github.com/boneskull/node-hg
Last synced: 6 months ago
JSON representation
Git mirror of project node-hg, a command server client for Mercurial.
- Host: GitHub
- URL: https://github.com/boneskull/node-hg
- Owner: boneskull
- Created: 2014-03-16T04:11:45.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2014-04-13T22:58:23.000Z (almost 12 years ago)
- Last Synced: 2024-10-29T22:37:13.490Z (over 1 year ago)
- Language: CoffeeScript
- Homepage: https://bitbucket.org/jacob4u2/node-hg
- Size: 141 KB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Node-hg
=======
A node js [command server](http://mercurial.selenic.com/wiki/CommandServer) client for [Mercurial](http://mercurial.selenic.com).
### Installation
npm install hg
### Example
```javascript
var path = require("path");
var hg = require("hg");
// Clone into "../example-node-hg"
var destPath = path.resolve(path.join(process.cwd(), "..", "my-node-hg"));
hg.clone("http://bitbucket.org/jgable/node-hg", destPath, function(err, output) {
if(err) {
throw err;
}
output.forEach(function(line) {
console.log(line.body);
});
// Add some files to the repo with fs.writeFile, omitted for brevity
hg.add(destPath, ["someFile1.txt", "someFile2.txt"], function(err, output) {
if(err) {
throw err;
}
output.forEach(function(line) {
console.log(line.body);
});
var commitOpts = {
"-m": "Doing the needful"
};
// Commit our new files
hg.commit(destPath, commitOpts, function(err, output) {
if(err) {
throw err;
}
output.forEach(function(line) {
console.log(line.body);
});
});
});
});
```
### Exposed Base Classes
#### HGRepo
The base class for Mercurial Repo interaction. The exposed API is just wrappers around the functions available in `HGRepo`.
```javascript
var hg = require("hg"),
HGRepo = hg.HGRepo;
var repo = new HGRepo("/some/path/to/repo");
repo.summary(function(err, output) {
if (err) {
throw err;
}
output.forEach(function(line) {
console.log(line.body);
});
});
repo.add(["."], function(err, output) {
if (err) {
throw err;
}
output.forEach(function(line) {
console.log(line.body);
});
});
// And so on...
```
#### HGCommandServer
The base class responsible for instantiating and communicating with a Mercurial command server. Must be instantiated in an existing Mercurial repository (check out `HGRepo.MakeTempRepo` to quickly get a temporary repo up)
```javascript
var hg = require("hg"),
HGCommandServer = hg.HGCommandServer;
var serv = new HGCommandServer();
serv.start("/some/path/to/repo", function(err) {
if (err) {
throw err;
}
console.log("Command Server Started", serv.capabilities, serv.encoding);
serv.on("output", function(err, lines) {
lines.forEach(function(line) {
console.log(line.body);
});
});
serv.runcommand("summary");
});
```
LICENSE
=======
[MIT](http://opensource.org/licenses/MIT), No Attribution Required, Copyright 2013 [Jacob Gable](http://jacobgable.com)