# svn-spawn

> SVN access based on svn cli command

Latest version **0.1.6** (published 2019-07-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install svn-spawn
pnpm add svn-spawn
yarn add svn-spawn
bun add svn-spawn
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.6 |
| Published | 2019-07-01 |
| First published | 2013-05-31 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 16.6 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 85 |
| Author | dong |
| Maintainers | dong |
| Keywords | svn, subversion |

## Links

- npm: https://www.npmjs.com/package/svn-spawn
- Repository: https://github.com/ddliu/node-svn-spawn
- Homepage: https://github.com/ddliu/node-svn-spawn#readme
- Issues: https://github.com/ddliu/node-svn-spawn/issues
- npm.io page: https://npm.io/package/svn-spawn

## Dependencies (3)

- [async](https://npm.io/package/async.md) ~0.2.9
- [xml2js](https://npm.io/package/xml2js.md) ~0.2.7
- [easy-spawn](https://npm.io/package/easy-spawn.md) 0.0.2

## Recent versions

- 0.1.6 (latest) — 2019-07-01
- 0.1.5 — 2016-02-12
- 0.1.4 — 2013-12-12
- 0.1.3 — 2013-11-08
- 0.1.2 — 2013-10-08
- 0.1.1 — 2013-06-07
- 0.1.0 — 2013-06-07
- 0.0.1 — 2013-05-31

## README

# svn-spawn

[![npm](https://img.shields.io/npm/v/svn-spawn.svg?style=flat-square)](https://www.npmjs.com/package/svn-spawn)
[![npm](https://img.shields.io/npm/dm/svn-spawn.svg?style=flat-square)](https://www.npmjs.com/package/svn-spawn)
[![Travis](https://img.shields.io/travis/ddliu/node-svn-spawn.svg?style=flat-square)](https://travis-ci.org/ddliu/node-svn-spawn)
![npm](https://img.shields.io/npm/l/svn-spawn.svg?style=flat-square)

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
```

---
_Source: https://npm.io/package/svn-spawn · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._