feat(reporter): Add threshold reporter

README.md

@@ -1,3 +1,5 @@
+# ![AVA](logo.svg)
+
 
 # Copy/paste detector (ALPHA VERSION).
 

src/cli.ts

@@ -63,7 +63,7 @@ cli.parse(process.argv);
 const options: IOptions = prepareOptions(cli);
 
 if (cli.list) {
-  console.log(bold(white("Supported formats: ")));
+  console.log(bold(white('Supported formats: ')));
   console.log(getSupportedFormats().join(', '));
 } else {
   const cpd: JSCPD = new JSCPD({
@@ -74,4 +74,3 @@ if (cli.list) {
   });
   cpd.detectInFiles(options.path);
 }
-

src/detector.ts

@@ -163,7 +163,7 @@ export class Detector {
     const source: ISource = sourcesStore.get(sourceId);
     if (source && source.hashes) {
       source.hashes[format] = source.hashes.hasOwnProperty(format)
-        ? source.hashes[format].concat(hash)
+        ? [... new Set(source.hashes[format].concat(hash))]
         : [hash];
       sourcesStore.set(sourceId, source);
     }

src/reporters/index.ts

@@ -3,10 +3,11 @@ import { IReporter } from '../interfaces/reporter.interface';
 import { ConsoleReporter } from './console';
 import { ConsoleFullReporter } from './consoleFull';
 import { JsonReporter } from './json';
+import { SilentReporter } from './silent';
 import { StatisticReporter } from './statistic';
 import { TimeReporter } from './time';
-import { SilentReporter } from './silent';
 import { XmlReporter } from './xml';
+import { ThresholdReporter } from './threshold';
 
 const REPORTERS: { [key: string]: IReporter } = {};
 
@@ -47,4 +48,7 @@ export function registerReportersByName(options: IOptions) {
   if (reporter.includes('silent')) {
     registerReporter('silent', new SilentReporter(options));
   }
+  if (reporter.includes('threshold')) {
+    registerReporter('threshold', new ThresholdReporter(options));
+  }
 }

src/reporters/silent.ts

@@ -6,8 +6,7 @@ import { STATISTIC_DB } from '../stores/models';
 import { StoresManager } from '../stores/stores-manager';
 
 export class SilentReporter implements IReporter {
-  constructor(private options: IOptions) {
-  }
+  constructor(private options: IOptions) {}
 
   public attach(): void {
     Events.on(END_EVENT, this.finish.bind(this));
@@ -19,10 +18,12 @@ export class SilentReporter implements IReporter {
     );
     if (statistic) {
       console.log(
-        `Duplications detection: Found ${bold(statistic.all.clones)} `+
-        `exact clones with ${bold(statistic.all.duplicatedLines)}(${statistic.all.percentage}%) `+
-        `duplicated lines in ${bold(statistic.all.sources)} ` +
-        `(${Object.keys(statistic.formats).length} formats) files.`
+        `Duplications detection: Found ${bold(statistic.all.clones)} ` +
+          `exact clones with ${bold(statistic.all.duplicatedLines)}(${
+            statistic.all.percentage
+          }%) ` +
+          `duplicated lines in ${bold(statistic.all.sources)} ` +
+          `(${Object.keys(statistic.formats).length} formats) files.`
       );
     }
   }

src/reporters/threshold.ts

@@ -0,0 +1,27 @@
+import { red } from 'colors/safe';
+import { END_PROCESS_EVENT, Events } from '../events';
+import { IOptions } from '../interfaces/options.interface';
+import { IReporter } from '../interfaces/reporter.interface';
+import { STATISTIC_DB } from '../stores/models';
+import { StoresManager } from '../stores/stores-manager';
+
+export class ThresholdReporter implements IReporter {
+  constructor(private options: IOptions) {
+  }
+
+  public attach(): void {
+    Events.on(END_PROCESS_EVENT, this.finish.bind(this));
+  }
+
+  private finish() {
+    const statistic = StoresManager.getStore(STATISTIC_DB).get(
+      this.options.executionId
+    );
+    if (statistic) {
+      if (this.options.threshold && this.options.threshold < statistic.all.percentage) {
+        console.error(red('ERROR: jscpd found too many duplicates over threshold'));
+        process.exit(1);
+      }
+    }
+  }
+}

src/reporters/xml.ts

@@ -1,15 +1,13 @@
 import { writeFileSync } from 'fs';
 import { ensureDirSync } from 'fs-extra';
+import { StoresManager } from '..';
 import { Events } from '../events';
 import { IClone } from '../interfaces/clone.interface';
 import { IOptions } from '../interfaces/options.interface';
 import { IReporter } from '../interfaces/reporter.interface';
 import { SOURCES_DB } from '../stores/models';
-import { StoresManager } from '..';
-
 
 export class XmlReporter implements IReporter {
-
   constructor(private options: IOptions) {}
 
   public attach(): void {
@@ -19,24 +17,35 @@ export class XmlReporter implements IReporter {
   private saveReport(clones: IClone[]) {
     let xmlDoc: string = '<?xml version="1.0" encoding="UTF-8" ?>';
 
-    xmlDoc = this.options.xslHref ? xmlDoc + '<?xml-stylesheet type="text/xsl" href="' + this.options.xslHref + '"?>' : xmlDoc;
+    xmlDoc = this.options.xslHref
+      ? xmlDoc +
+        '<?xml-stylesheet type="text/xsl" href="' +
+        this.options.xslHref +
+        '"?>'
+      : xmlDoc;
     xmlDoc += '<pmd-cpd>';
 
     clones.forEach((clone: IClone) => {
       xmlDoc = `${xmlDoc}
-      <duplication lines="${clone.duplicationA.end.loc.end.line - clone.duplicationA.start.loc.start.line}">
-            <file path="${StoresManager.getStore(SOURCES_DB).get(clone.duplicationA.sourceId).id}" line="${clone.duplicationA.start.loc.start.line}" />
-            <file path="${StoresManager.getStore(SOURCES_DB).get(clone.duplicationB.sourceId).id}" line="${clone.duplicationB.start.loc.start.line}" />
+      <duplication lines="${clone.duplicationA.end.loc.end.line -
+        clone.duplicationA.start.loc.start.line}">
+            <file path="${
+              StoresManager.getStore(SOURCES_DB).get(
+                clone.duplicationA.sourceId
+              ).id
+            }" line="${clone.duplicationA.start.loc.start.line}" />
+            <file path="${
+              StoresManager.getStore(SOURCES_DB).get(
+                clone.duplicationB.sourceId
+              ).id
+            }" line="${clone.duplicationB.start.loc.start.line}" />
             <codefragment><![CDATA[${clone.fragment}]]></codefragment>
         </duplication>
-      `
+      `;
     });
     xmlDoc += '</pmd-cpd>';
 
     ensureDirSync(this.options.output);
-    writeFileSync(
-      this.options.output + '/jscpd-report.xml',
-      xmlDoc
-    );
+    writeFileSync(this.options.output + '/jscpd-report.xml', xmlDoc);
   }
 }

src/stores/files.ts

@@ -62,6 +62,5 @@ export class FilesStore<TValue extends IStoreValue> implements IStore<TValue> {
 
   public close(): void {
     writeJSONSync(this.pathToFile, this.values);
-    this.values = {};
   }
 }

src/stores/memory.ts

@@ -49,6 +49,6 @@ export class MemoryStore<TValue extends IStoreValue> implements IStore<TValue> {
   }
 
   public close(): void {
-    this.values = {};
-  }
+    Object.freeze(this.values);
+  };
 }

src/utils/index.ts

@@ -73,10 +73,12 @@ export function prepareOptions(cli: Command): IOptions {
     ...storedConfig,
     ...argsConfig
   };
-
   if (result.silent) {
     result.reporter = ['silent'];
   }
+  if (result.threshold) {
+    result.reporter = [...(result.reporter || []), 'threshold'];
+  }
   result.reporter = ['stat', ...(result.reporter || []), 'time'];
   result.reporter = [...new Set(result.reporter)];
   return result;