Support multiple --exclude arguments

[balupton]

Via the API, exclude supports an array #170 (comment)

However, via the CLI, it only supports a single usage instead of multiple. It would be nice if the CLI concatenated multiple --exclude values into an array, so we can do:

typedoc --exclude '**/*test*' --exclude '**/node_modules/** --exclude '**/test/**

as unfortunately, this workaround does not work for the above:

typedoc --exclude '**/{*test*,{node_modules|test}/**}'

[aciccarello]

Thanks for the suggestion! I agree this would be a helpful. If anyone would like to implement this, please reach out for discussion!

[balupton]

I took a look to try and find where this is defined, but seems more complicated than a first glance offers.

Perhaps it would make sense to use https://github.com/cacjs/cac (personal favourite in that space) instead of what appears to be a custom built solution.

cac already supports the --exclude foo --exclude bar use case: cacjs/cac#24

[aciccarello]

@balupton For your use case, wouldn't the following work? Essentially you are passing a list of globs wrapped in curly brackets.

typedoc --exclude '{**/*test*,**/node_modules/**,**/test/**}'

[9oelM]

Perhaps we need to set up a simple test against that to verify.

[aciccarello]

Yeah, we should test that. I seem to recall bracket syntax didn't work well.

[9oelM]

May be relevant. Just taking notes for reference

typedoc/src/lib/application.ts

Lines 252 to 282 in dbdbfca

	const exclude = this.exclude
	? createMinimatch(this.exclude)
	: [];
	function isExcluded(fileName: string): boolean {
	return exclude.some(mm => mm.match(fileName));
	}
	function add(dirname: string) {
	FS.readdirSync(dirname).forEach((file) => {
	const realpath = Path.join(dirname, file);
	if (FS.statSync(realpath).isDirectory()) {
	add(realpath);
	} else if (/\.tsx?$/.test(realpath)) {
	if (isExcluded(realpath.replace(/\\/g, '/'))) {
	return;
	}
	files.push(realpath);
	}
	});
	}
	inputFiles.forEach((file) => {
	file = Path.resolve(file);
	if (FS.statSync(file).isDirectory()) {
	add(file);
	} else if (!isExcluded(file)) {
	files.push(file);
	}
	});

typedoc/src/lib/converter/converter.ts

Lines 385 to 397 in 1c4c515

	private compile(context: Context): ReadonlyArray<ts.Diagnostic> {
	const program = context.program;
	const exclude = createMinimatch(this.application.exclude || []);
	const isExcluded = (file: ts.SourceFile) => exclude.some(mm => mm.match(file.fileName));
	const includedSourceFiles = program.getSourceFiles()
	.filter(file => !isExcluded(file));
	const isRelevantError = ({ file }: ts.Diagnostic) => !file || includedSourceFiles.includes(file);
	includedSourceFiles.forEach((sourceFile) => {
	this.convertNode(context, sourceFile);
	});

typedoc/src/lib/utils/paths.ts

Lines 6 to 28 in e650aa7

	/**
	* Convert array of glob patterns to array of minimatch instances.
	*
	* Handle a few Windows-Unix path gotchas.
	*/
	export function createMinimatch(patterns: string[]): IMinimatch[] {
	return patterns.map((pattern: string): IMinimatch => {
	// Ensure correct pathing on unix, by transforming `\` to `/` and removing any `X:/` from the path
	if (unix) { pattern = pattern.replace(/[\\]/g, '/').replace(/^\w:/, ''); }
	// pattern paths not starting with '**' are resolved even if it is an
	// absolute path, to ensure correct format for the current OS
	if (pattern.substr(0, 2) !== '**') {
	pattern = Path.resolve(pattern);
	}
	// On Windows we transform `\` to `/` to unify the way paths are intepreted
	if (!unix) { pattern = pattern.replace(/[\\]/g, '/'); }
	// Unify the path slashes before creating the minimatch, for more reliable matching
	return new Minimatch(pattern, { dot: true });
	});
	}

[Downchuck]

@aciccarello That glob syntax has strange semantics -- I can't tell what it's actually doing -- if I remove the first test clause, it no longer filters node_modules. If I change test to spec, it's not actually filtering out spec files.

[Gerrit0]

@Downchuck that's because TypeDoc currently splits the glob on , before matching it (I know, I know...) once resolved, it should behave as expected.

[Downchuck]

@Gerrit0 No idea how to math that in my brain pan - but this is working '{**/*spec*,**/*.spec.ts,**/node_modules/**,**/*spec.ts}' though no idea why. As you said, something to do with the comma - as when I take out the first or last item my spec or node_modules are no longer filtered.

[Gerrit0]

As of 0.16, this is supported.