https://github.com/diegohaz/list-react-files

List React component files inside a directory
https://github.com/diegohaz/list-react-files

react react-components readdir

Last synced: 29 days ago
JSON representation

List React component files inside a directory

• Host: GitHub
• URL: https://github.com/diegohaz/list-react-files
• Owner: diegohaz
• License: mit
• Created: 2017-05-25T05:54:03.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2023-07-27T21:40:41.000Z (almost 2 years ago)
• Last Synced: 2025-06-13T18:02:14.169Z (29 days ago)
• Topics: react, react-components, readdir
• Language: JavaScript
• Homepage:
• Size: 55.7 KB
• Stars: 26
• Watchers: 2
• Forks: 4
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# list-react-files

[![Generated with nod](https://img.shields.io/badge/generator-nod-2196F3.svg?style=flat-square)](https://github.com/diegohaz/nod)

[![NPM version](https://img.shields.io/npm/v/list-react-files.svg?style=flat-square)](https://npmjs.org/package/list-react-files)

[![Build Status](https://img.shields.io/travis/diegohaz/list-react-files/master.svg?style=flat-square)](https://travis-ci.org/diegohaz/list-react-files) [![Coverage Status](https://img.shields.io/codecov/c/github/diegohaz/list-react-files/master.svg?style=flat-square)](https://codecov.io/gh/diegohaz/list-react-files/branch/master)

List React component files inside a directory

## Install

    $ npm install --save list-react-files

## Usage

Example with [ARc](https://github.com/diegohaz/arc) codebase:

```js

import listReactFiles from 'list-react-files'

listReactFiles(__dirname).then(files => console.log(files))

/* 

[ 

  'src-example/components/App.js',

  'src-example/components/atoms/Atom/index.js',

  'src-example/components/atoms/Badge/index.js',

  'src-example/components/atoms/Block/index.js',

  'src-example/components/atoms/Button/index.js',

  'src-example/components/atoms/Caption/index.js',

  'src-example/components/atoms/Heading/index.js',

  'src-example/components/atoms/HorizontalRule/index.js',

  'src-example/components/atoms/Icon/index.js',

  'src-example/components/atoms/Input/index.js',

  'src-example/components/atoms/Label/index.js',

  'src-example/components/atoms/Link/index.js',

  'src-example/components/atoms/List/index.js',

  'src-example/components/atoms/LogoImage/index.js',

  'src-example/components/atoms/Paragraph/index.js',

  'src-example/components/atoms/PreformattedText/index.js',

  'src-example/components/atoms/Spinner/index.js',

  'src-example/components/atoms/TableCell/index.js',

  'src-example/components/atoms/TableRow/index.js',

  'src-example/components/atoms/Tooltip/index.js',

  'src-example/components/molecules/Blockquote/index.js',

  'src-example/components/molecules/Feature/index.js',

  'src-example/components/molecules/Field/index.js',

  'src-example/components/molecules/IconButton/index.js',

  'src-example/components/molecules/IconLink/index.js',

  'src-example/components/molecules/Modal/index.js',

  'src-example/components/molecules/Molecule/index.js',

  'src-example/components/molecules/PrimaryNavigation/index.js',

  'src-example/components/molecules/Slider/index.js',

  'src-example/components/molecules/Table/index.js',

  'src-example/components/organisms/FeatureList/index.js',

  'src-example/components/organisms/Footer/index.js',

  'src-example/components/organisms/Header/index.js',

  'src-example/components/organisms/Hero/index.js',

  'src-example/components/organisms/Organism/index.js',

  'src-example/components/pages/GenericPage/index.js',

  'src-example/components/pages/HomePage/index.js',

  'src-example/components/pages/NotFoundPage/index.js',

  'src-example/components/pages/SamplePage/index.js',

  'src-example/components/templates/GenericTemplate/index.js',

  'src-example/components/templates/PageTemplate/index.js',

  'src/components/App.js',

  'src/components/pages/HomePage/index.js'

 ] 

 */

```

## API

### listReactFiles

List react component files inside a directory

**Parameters**

-   `cwd` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** 

Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)>>** 

## License

MIT © [Diego Haz](https://github.com/diegohaz)