# read-file-path

> Read all child directory and file path by given path.

Latest version **1.0.5** (published 2018-07-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install read-file-path
pnpm add read-file-path
yarn add read-file-path
bun add read-file-path
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.5 |
| Published | 2018-07-25 |
| First published | 2018-07-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 19.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Liu JiaLi |
| Maintainers | waisink |
| Keywords | node, file, path |

## Links

- npm: https://www.npmjs.com/package/read-file-path
- npm.io page: https://npm.io/package/read-file-path

## Dependencies (1)

- [minimatch](https://npm.io/package/minimatch.md) ^3.0.4

## Alternatives

- [base64url](https://npm.io/package/base64url.md) — 6.1M weekly downloads
- [get-installed-path](https://npm.io/package/get-installed-path.md) — 502.9K weekly downloads
- [@uppy/url](https://npm.io/package/@uppy/url.md) — 185.8K weekly downloads
- [@d3fc/d3fc-shape](https://npm.io/package/@d3fc/d3fc-shape.md) — 16.2K weekly downloads
- [localizer](https://npm.io/package/localizer.md) — 226 weekly downloads

## Recent versions

- 1.0.5 (latest) — 2018-07-25
- 1.0.4 — 2018-07-23
- 1.0.3 — 2018-07-23
- 1.0.2 — 2018-07-23
- 1.0.1 — 2018-07-22
- 1.0.0 — 2018-07-19

## README

# read-file-path
read-file-path is an utility module that help to get all child file path by given path. 

[![node](https://img.shields.io/badge/node-v9.3.0-blue.svg)](https://nodejs.org/en/)
[![npm](https://img.shields.io/badge/npm-v5.5.1-blue.svg)](https://www.npmjs.com/package/read-file-path)

# Installation
```js
npm install read-file-path
```

# Usage

```js
import readFilepath from 'read-file-path';
let fileList = readFilepath.readFilePathSync(path, options)
```
For Example:  

|---src  
|　　|---common  
|　　|---component  
|　　|　　|---componentA.js  
|　　|---theme  
|　　|　　|---themeA.style  
|　　|---main.js  
|---lib  
|　　|---vendor.js  
|---package.json  
  
```js
import readFilepath from 'read-file-path';

let fileList = readFilepath.readFilePathSync('src/')
// ['X/src/component/componentA.js', 'X/src/theme/themeA.style', 'X/src/main.js'] 

let fileList = readFilepath.readFilePathSync('src/', {type: 'All', include: ['component*']})
// ['X/src/component', 'X/src/component/componentA.js'] 

let fileList = readFilepath.readFilePathSync('src/', {type: 'Dir', include: ['component*']})
// ['X/src/component'] 
```
X represent the part of absolute path.The return value of the list is always absolute path.  
It is recommended that the `path` parameter be an absolute path.If the `path` is relative path, `process.cwd()` will be used as base path.

# Function
## readFilePathSync(path, options)
#### path: The search path.  
#### options: 
* type　`Default: 'File'`  
Read file type:  
　'All' : Return directory and file.  
　'File': Retur file only.  
　'Dir' : Return directory only.
 
* include　`Default: []`  
List of match regexp.  
For example, ['\*_test'] will match directory 'read_test' and file 'read_test.js'.
* includeFile　`Default: []`  
List of directory match regexp.  
If 'include' is passed, will first match 'include' regexp and then match the 'includeDir' regexp.
* includeDir　`Default: []`  
List of directory match regexp.  
If 'include' is passed, will first match 'include' regexp and then match the 'includeDir' regexp.
* exclude　`Default: []`  
List of exclude regexp.  
For example, '*_test' or ['*_test'] will ignore directory 'read_test' and file 'read_test.js'.
* excludeFile　`Default: []`  
List of file ignore regexp.  
If 'exclude' is passed, will first ignore 'include' regexp and then ingore the 'excludeFile' regexp.
* excludeDir　`Default: []`  
List of directory ignore regexp.  
If 'exclude' is passed, will first ignore 'exclude' regexp and then ignore the 'excludeDir' regexp.

---
_Source: https://npm.io/package/read-file-path · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._