Code Monkey home page Code Monkey logo

svn-polling's Introduction

svn-polling

npm npm

๐Ÿ•“ A SVN Log Polling mechanism for NodeJS.

Install

$ npm install --save svn-polling

or

$ yarn add svn-polling

Requirements

You need to have the svn command installed.

Usage

const SvnPolling = require('svn-polling');

const polling = new SvnPolling({
	remoteUrl: 'svn://your-svn-project-url.com/code/trunk'
});

// Will be called as soon as new changes are commited into the repository
polling.on('data', (data) => {
	console.log(data);
});

// Start polling from svn log history
polling.start();

Result:

{
  "revision": 2,
  "logs": [
    {
      "revision": "1",
      "author": "marcobarcelos",
      "date": "2017-01-05T03:29:42.036677Z",
      "msg": "Add index.js",
      "changes": [
        {
          "action": "A",
          "path": "/index.js"
        }
      ]
    },
    {
      "revision": "2",
      "author": "marcobarcelos",
      "date": "2017-01-05T03:30:20.881618Z",
      "msg": "Add readme.md",
      "changes": [
        {
          "action": "A",
          "path": "/readme.md"
        }
      ]
    }
  ]
}

Config

You can configure some options by passing it into the constructor:

const options = {
	remoteUrl: 'svn://your-svn-project-url.com/code/trunk',
	pollInterval: 1000,
	logsLimit: 10,
	username: 'marcobarcelos',
	password: 'ultrasecret'
};

const polling = new SvnPolling(options);

remoteUrl

Type: string

The remote repository's url.

pollInterval

Type: number
Default: 15000

The interval between a svn log history fetch and another.

logsLimit

Type: number
Default: 5

How many logs/commits to retrieve by the first time.

username

Type: string
Optional (in case authentication is not required or is already saved)

The svn user's username.

password

Type: string
Optional (in case authentication is not required or is already saved)

The svn user's password.

License

MIT ยฉ Marco Barcelos

svn-polling's People

Contributors

marcobarcelos avatar

Stargazers

 avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.