An open API service indexing awesome lists of open source software.

https://github.com/nuintun/files-extractor

Extract files that have changed between the specified date
https://github.com/nuintun/files-extractor

Last synced: about 1 year ago
JSON representation

Extract files that have changed between the specified date

Awesome Lists containing this project

README

          

# files-extractor

> Extract files that have changed between the specified date.
>
> [![NPM Version][npm-image]][npm-url]
> [![Download Status][download-image]][npm-url]
> ![Node Version][node-image]
> [![Dependencies][david-image]][david-url]

### Install

[![NPM](https://nodei.co/npm/files-extractor.png)](https://nodei.co/npm/files-extractor/)

> Notice: if want use command line must install with `npm i -g files-extractor`

### Introduction

##### command line

```
>fextract -h

Usage: fextract [options]

Extract files that have changed between the specified date.

Options:

-V, --version output the version number
-d, --dot extract dot files
-f, --files set the files of extract
-o, --output set the output dir of extract
-s, --start set the start date of extract
-e, --end set the end date of extract
-t, --types set the filter types[mtime, ctime, atime, birthtime] of extract
-h, --help output usage information

Documentation can be found at https://github.com/nuintun/files-extractor#readme.
```

##### fextract.yml

```yml
files: # pattern to search for files (see: node-glob)
**/*
output: # output dir of extract
.extract
start: # filter start date of extract
2017/9/19
end: # filter end date of extract
2017/9/20
type: # filter type of extract, one or more of [mtime, ctime, atime, birthtime]
mtime
dot: # include dot files (see: node-glob)
false
ignore: # pattern for exclude search (see: node-glob)
- node_modules/**/*
```

### API

```js
'use strict';

const extractor = require('files-extractor');
const STATUS = extractor.STATUS;

// Returned a child process
const worker = extractor(options);

// Listen message event
worker.on('message', function (message) {
switch (message.status) {
case STATUS.BOOTSTRAP:
// Bootstrap
break;
case STATUS.SEARCHING:
// Searching
break;
case STATUS.SEARCHED:
// Searched
break;
case STATUS.FILTERING:
// Filtering
break;
case STATUS.FILTERED:
// Filtered
break;
case STATUS.EXTRACTING:
// Extracting
break;
case STATUS.EXTRACTED:
// Extracted
break;
case STATUS.WARNING:
// Warning
break;
case STATUS.FAILED:
// Failed (child process will automatic exit)
break;
}
});
```

[david-image]: http://img.shields.io/david/nuintun/files-extractor.svg?style=flat-square
[david-url]: https://david-dm.org/nuintun/files-extractor
[node-image]: http://img.shields.io/node/v/files-extractor.svg?style=flat-square
[npm-image]: http://img.shields.io/npm/v/files-extractor.svg?style=flat-square
[npm-url]: https://www.npmjs.org/package/files-extractor
[download-image]: http://img.shields.io/npm/dm/files-extractor.svg?style=flat-square