diegohaz / list-react-files Goto Github PK

View Code? Open in Web Editor NEW

25.0 3.0 4.0 57 KB

List React component files inside a directory

License: MIT License

JavaScript 100.00%

react readdir react-components

list-react-files's Introduction

list-react-files

List React component files inside a directory

Install

$ npm install --save list-react-files

Usage

Example with ARc codebase:

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

Returns Promise<Array<string>>

License

MIT © Diego Haz

list-react-files's People

Contributors

Stargazers

Watchers

Forkers

zakol experius richysandoval

list-react-files's Issues

Replace camelCase for pascalCase

https://github.com/diegohaz/list-react-files/blob/master/src/index.js#L5-L6

Just change the keys. It's not camelCase, but PascalCase.

Unhandled Rejection (TypeError): fs.readdir is not a function

Not Working in create-react-app environment, client side.
Might be obvious for advanced react developers, as Node fs module is already not supported in create-react-app. But seeing your package, i hoped that was a way to get through this missing functionality.

https://stackoverflow.com/questions/35003961/react-js-require-fs
facebook/create-react-app#3074

Uncaught Error: Cannot find module 'fs'

Console error msg: https://gyazo.com/781a53b728681d082f3b49d4e9988681

My application had no errors before I ran the following:

import listReactFiles from 'list-react-files'

Any idea on how to fix this?

"list-react-files": "^0.2.0",

Ignore .stories

https://github.com/diegohaz/list-react-files/blob/master/src/index.js#L19

bug? returns an empty list despite the directory being nonempty

https://gyazo.com/9e1e5c6f282fbac383bea0ec8e9a48ce

Notice the test.txt file I put in the same directory as the file I called the function from.

I have retried rerunning and recompilling it again and again with the same result each time.

Could not find a declaration file for module 'list-react-files'

Good afternoon

Hello my friend

I tried to use your library in react project and the error is being returned

Could not find a declaration file for module 'list-react-files'

See the project at

https://brown-marlin-dwpxtu5z.ws-us10.gitpod.io/

Consider files/folders inside /components

Folders inside components with an index.js file or folder name.

https://github.com/start-react/native-starter-kit

Failed in Gatsby

How to reproduce:

gatsby new blog https://github.com/gatsbyjs/gatsby-starter-blog
then
npm install --save list-react-files
and add to any component
import listReactFiles from 'list-react-files'

After than I got this output:

ERROR  Failed to compile with 4 errors 
This dependency was not found:
* fs in ./~/glob/glob.js, ./~/fs.realpath/index.js and 2 others
To install it, you can run: npm install --save fs

Installing fs not helping. Probably this is Gatsby problem?