finder

@jscpd/finder

File discovery and in-files detection package for jscpd — walks the filesystem to collect source files, runs the duplicate detector across them, and provides built-in reporters, subscribers, validators, and hooks.

Key exports:

• getFilesToDetect(options) — resolves the file list from paths, globs, and ignore patterns
• InFilesDetector — orchestrates tokenization, store lookup, and clone collection across a file list
• Reporters — console, consoleFull, json, xml, csv, markdown, xcode, ai, silent, threshold
• Subscribers — verbose, progress
• Validators — skipLocal
• Hooks — blamer, fragment

Installation

npm install @jscpd/finder --save

Usage

import { Tokenizer } from '@jscpd/tokenizer';
import {
  MemoryStore,
  IOptions,
  IClone,
  IStore,
  ITokenizer,
} from '@jscpd/core';
import { EntryWithContent, getFilesToDetect, InFilesDetector } from '@jscpd/finder';

const options: IOptions = {
  minLines: 5,
  maxLines: 500,
  path: ['list of folders and files to analyse for clones'],
};

const tokenizer: ITokenizer = new Tokenizer();
// any store implementing IStore works here
const store: IStore = new MemoryStore();

const files: EntryWithContent[] = getFilesToDetect(options);
const detector = new InFilesDetector(tokenizer, store, options);

(async () => {
  const clones: IClone[] = await detector.detect(files);
})();

License

MIT © Andrey Kucherenko