Allow programmatic usage

[lo1tuma]

Hi,

I would like to use jscpd programmatically where I can provide the file content instead of letting jscpd reading the file from the file-system.

Background of this is, that I want to check files retrieved via the github API.

---

The API could look like this:

var Detector = require('jscpd').Detector;

var detector = new Detector();

detector.addFile('foo.js', 'console.log("hello world")');
detector.addFile('bar.js', 'console.log("hello world")');

var result = detector.run();

[kucherenko]

for now you can use program interface, but it is little bit poor, will add this request to plans

[c089]

The second argument in the addFile method be the contents of the file, right? Then maybe rename it to something more generic to make it clear this is not reading a file, but expecting a string? If it should work on large codebases, maybe instead of strings also consider a stream interface that could then either have files or any other source. Otherwise 👍 on this.

[lo1tuma]

It would be also nice to be able to remove files, so you can compare the duplication results of two different versions of your code files.

Example:

var Detector = require('jscpd').Detector;

var detector = new Detector();

// add files of version 1
detector.addFile('foo.js', 'console.log("hello world")');
detector.addFile('bar.js', 'console.log("hello world")');
detector.addFile('baz.js', 'console.log("hello world")');

var resultOfVersion1 = detector.run();

// apply changes for version 2
detector.addFile('bar.js', 'console.log("changed file")');
detector.removeFile('baz.js');
// don’t add 'foo.js' because it didn’t change

var resultOfVersion2 = detector.run();

console.log('Your code duplication increased/decreased by:', compareResults(resultOfVersion1, resultOfVersion2), 'percent');

[kucherenko]

https://github.com/kucherenko/jscpd/blob/master/docs/api.md

New version of jscpd released and powerful API there