Apidoc: Ability to ignore node_modules directory

[brandonhamilton]

Is there an easy way to ignore the node_modules directory in the application path? It would make sense to ignore this by default.

I am running apiDoc in the root of my project, and it crashes when parsing lodash within its own node_modules subdirectory:

apidoc: inspect file: ./node_modules/apidoc/node_modules/lodash/vendor/benchmark.js
apidoc: Error: EISDIR, illegal operation on a directory
at Object.fs.readSync (fs.js:476:19)
at Object.fs.readFileSync (fs.js:310:28)
at Parser.parseFile (node_modules/apidoc/lib/parser.js:57:16)
at main (node_modules/apidoc/lib/apidoc.js:282:28)
at Object. (node_modules/apidoc/bin/apidoc:126:25)
at Module._compile (module.js:456:26)
at Object.Module._extensions..js (module.js:474:10)
at Module.load (module.js:356:32)
at Function.Module._load (module.js:312:12)
at Function.Module.runMain (module.js:497:10)
apidoc: Error: EISDIR, illegal operation on a directory

[rottmann]

Added -e option to exclude Files and Directories in 0.1.10.
apidoc -e node_modules/

If you use grunt module grunt-apidoc you can add excludeFilters permanent to Gruntfile.js:

apidoc: {
  myapp: {
    src: "./",
    dest: "../apidoc/",
    options: {
      excludeFilters: [ "node_modules/" ]
    }
  }
} // apidoc

[deerawan]

It doesn't work for me if add "/" after folder name. I use apidoc 0.7.0 and want to exclude a folder to be executed

when I run command

apidoc -e vendor/

I still can see that apidoc read all files inside this folder. However, if I run this command

apidoc -e vendor

it works

[ORESoftware]

+1 this needs to be in README.md please

[chovy]

can i add ignore directories to the apidoc.json file somehow? I just read the .gitignore