Are cli options working?

I’m using react-docgen by cli. However, --ignore, --exclude and --resolver seem not working at all. It keeps parsing those unwanted files and output No suitable component definition found, which is really annoying since they’re not meant to be generated docs.

[kryten87]

The documentation for the exclude option says “Filename pattern to exclude” - I’m reading that to mean that it will match a pattern and exclude those files. But I can’t find a way to specify a pattern that works.

I can explicitly exclude files by specifying the full file name, but cannot exclude files by pattern. For example, I’m trying:

react-docgen src/components/ -o test.json -e *.spec.js

And getting a whole bunch of “No suitable component definition found” errors.

I’ve tried a number of different ways of specifying that pattern:

# try * wildcards?
react-docgen src/components/ -o test.json -e *.spec.js
react-docgen src/components/ -o test.json -e **/*.spec.js
react-docgen src/components/ -o test.json -e src/components/*.spec.js
react-docgen src/components/ -o test.json -e src/components/**/*.spec.js

# maybe a regex?
react-docgen src/components/ -o test.json -e '/.*.spec.js/'
react-docgen src/components/ -o test.json -e '.*.spec.js'
react-docgen src/components/ -o test.json -e .*.spec.js

EDIT

A little more digging reveals that the problem is with the node-dir package. In short, this package always assumes you want to build an array of “excludes” and passes that to node-dir. However, node-dir either accepts a regular expression or an array of strings, but not both.

Ideally, I think the fix should be with node-dir - it should probably be a little more “open minded” about the list of exclusions it receives and be able to handle an array of regular expressions and strings.

[fkling]

Only parse files that define components.

Well, we have to parse the file in order to know whether it defines components or not. However, maybe we should create a friendlier output that simply lists in which files it didn’t find component definitions (and provide a CLI option to suppress that information).