Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

excludePaths works like excludeNames #57

Merged
merged 2 commits into from
Jan 8, 2018
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
excludePaths option works identically to excludeNames: string | regex
  • Loading branch information
Gilad Gray committed Jan 8, 2018
commit 31369d1318eb778ac0804785d9000bac4c1b9e64
16 changes: 11 additions & 5 deletions src/plugins/typescript/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,20 @@ export { ITypescriptPluginData };

export interface ITypescriptPluginOptions {
/**
* Array of glob strings to exclude entire files. Files in `node_modules/` are always excluded.
* Note that when matching directories you'll need to capture the entire path using `**`s on either end.
* Array of patterns (string or RegExp) to exclude members by name.
* Strings will be converted to regular expressions through `string.match(pattern)`.
*
* Note that excluded members will still be parsed by the compiler, so they can be referenced
* by other symbols, but they will not appear in the output data.
*/
excludePaths?: string[];

/** Array of patterns (string or RegExp) to exclude named members. */
excludeNames?: Array<string | RegExp>;

/**
* Array of patterns (string or RegExp) to exclude members based on file path.
* See `excludeNames` above for usage notes.
*/
excludePaths?: Array<string | RegExp>;

/**
* Enable parsing of `.d.ts` files.
* @default false
Expand Down