https://github.com/ddliu/node-svn-spawn
Easy way to access svn repository with node.js.
https://github.com/ddliu/node-svn-spawn
nodejs subversion svn
Last synced: 11 months ago
JSON representation
Easy way to access svn repository with node.js.
- Host: GitHub
- URL: https://github.com/ddliu/node-svn-spawn
- Owner: ddliu
- License: mit
- Created: 2013-05-21T04:15:53.000Z (about 13 years ago)
- Default Branch: master
- Last Pushed: 2019-07-01T01:52:23.000Z (almost 7 years ago)
- Last Synced: 2025-06-30T02:48:39.547Z (12 months ago)
- Topics: nodejs, subversion, svn
- Language: JavaScript
- Homepage:
- Size: 18.6 KB
- Stars: 86
- Watchers: 6
- Forks: 17
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# svn-spawn
[](https://www.npmjs.com/package/svn-spawn)
[](https://www.npmjs.com/package/svn-spawn)
[](https://travis-ci.org/ddliu/node-svn-spawn)
Easy way to access svn repository with node.js.
## Features
- Easy to use
- Fast way to add local changes
- Query svn infomation as array or object
- Common svn commands are all supported
## Usage
Create a svn client instance
```js
var Client = require('svn-spawn');
var client = new Client({
cwd: '/path to your svn working directory',
username: 'username', // optional if authentication not required or is already saved
password: 'password', // optional if authentication not required or is already saved
noAuthCache: true, // optional, if true, username does not become the logged in user on the machine
});
```
`svn update`
```js
client.update(function(err, data) {
console.log('updated');
});
```
`svn info`
```js
client.getInfo(function(err, data) {
console.log('Repository url is %s', data.url);
});
```
Make some changes and commit all
```js
client.addLocal(function(err, data) {
console.log('all local changes has been added for commit');
client.commit('commit message here', function(err, data) {
console.log('local changes has been committed!');
});
});
```
Single file
```js
client.add('relative/path/to/file', function(err, data) {
client.commit(['commit message here', 'relative/path/to/file'], function(err, data) {
console.log('committed one file!');
});
});
```
Run any svn command
```js
client.cmd(['subcommand', '--option1=xx', '--option2=xx', 'arg1', 'arg2'], function(err, data) {
console.log('subcommand done');
});
```
## Result Object
`getXXX` methods will return parsed data as object.
`getInfo` result example:
```json
{
"$": {
"path": ".",
"revision": "1",
"kind": "dir"
},
"url": "file:///home/dong/projects/node-packages/node-svn-spawn/test/tmp/repo",
"repository": {
"root": "file:///home/dong/projects/node-packages/node-svn-spawn/test/tmp/repo",
"uuid": "302eb8ee-a81a-4432-8477-1ad8fe3a9a1e"
},
"wc-info": {
"wcroot-abspath": "/home/dong/projects/node-packages/node-svn-spawn/test/tmp/copy",
"schedule": "normal",
"depth": "infinity"
},
"commit": {
"$": {
"revision": "1"
},
"author": "dong",
"date": "2013-11-08T02:07:25.884985Z"
}
}
```
`getLog` result example:
```json
[
{
"$": {
"revision": "1"
},
"author": "dong",
"date": "2013-11-08T02:10:37.656902Z",
"msg": "init repo"
},
...
]
```
`getStatus` result example:
```json
[
{
"$": {
"path": "a.txt"
},
"wc-status": {
"$": {
"props": "none",
"item": "modified",
"revision": "1"
},
"commit": {
"$": {
"revision": "1"
},
"author": "dong",
"date": "2013-11-08T02:17:20.390152Z"
}
}
}
]
```
## Requirements
You need to have the `svn` command installed.
## Installation
```bash
npm install svn-spawn
```