modifiled v0.1.2

modifiled

Gets a list of files changed from parent branch

Install

npm install modifiled

Example Usage

JavaScript

const modifiled = require('modifiled');

const config = { 
    vcs: 'Mercurial', 
    ext: ['ts'],
    suppressOutput: false 
};
const files = modifiled('/Users/brady/mercurial-dir', config);

TypeScript

import { modifiled, Config } from 'modifiled';

const config: Config = {
     vcs: 'Mercurial', 
     ext: ['ts'],
     suppressOutput: false  
 };
const files = modifiled('/Users/brady/mercurial-dir', config);

Api

modifiled(directory, config);

directory

Specify the absolute path (as a string) of the directory to be analysed

config

Modifiled can take in an optional config object

Default config

const defaultConfig: Config = {
    vcs: 'Unknown',
    ext: [],
    suppressOutput: false 
};

vcs: 'Mercurial', 'Git' or 'Unknown'

ext: file extension such as 'ts' or 'js'

suppressOutput: if the execution will printout information to console.log