How does exclude work ?

[ocombe]

Hello,
I use the command line: typedoc --options typedoc.json --exclude *.spec.ts src/app/

But it generates documentation for my file "src/app/app.spec.ts".
Shouldn't it be excluded ?

[enanox]

Hi, I'm on the same boat as @ocombe.
Is the --exclude pattern a RegExp, or a pattern similar those used in Grunt/Gulp, such as directory/**/*.ext?

[EMarginy]

Hi, got the same problem with exclude trying this: typedoc --media modules/ --exclude modules/**/tests/*

[dsebastien]

Same issue here. Also how to configure multiple exclusions?

[caseyhoward]

I'm having the exact same issue. I want to ignore spec files. "" is not helpful at all without an example of what a "pattern" is.

[caseyhoward]

@ocombe I think the following should work:

typedoc --options typedoc.json --exclude **/*.spec.ts src/app/

typedoc uses Minimatch for globs. I believe *.spec.ts will only look for files in the current directory.

[hverlin]

Hi, you can use for example: "exclude": "**/*+(e2e|spec|index).ts" if you want to have multiple exclusions.

The syntax seems to be +(pattern-list).

[blakeembrey]

Seen here (

typedoc/src/lib/application.ts

Line 253 in 53bb762

exclude = new Minimatch(this.exclude);

), the pattern is a standard minimatch (glob) pattern in Node.js. The existing comments by @caseyhoward should work for you (make sure you quote so it's not automatically expanded by your shell).

[daotoad]

Changing the docs to say that patterns are "standard" minimatch patterns would be very helpful.

[blakeembrey]

You are welcome to submit a PR improving the docs.