Support Folder and File Exclusions

[JoeRobich]

Ability to list folder or files that should be excluded from formatting.

@JoeRobich Mind if I take a crack at this?

[JoeRobich]

@jpshrader That would be great. Start by posting your proposed design here and we can talk through it.

@JoeRobich I was thinking it might look something like:

1. Accept a comma-separated list of file/folder paths (--exclude <stuff>), which like the --report option, is passed along to CodeFormatter.cs via the FormatOptions object.

2. Add a similar if block to the GetDocumentAndOptions method in CodeFormatter, which excludes files if they fall under any of the excluded files/folders.

That logic could also go a layer up in in the DetermineFormattableFiles, but I think the above approach is cleaner.

Edit: Something like this

[sandyarmstrong]

Personally, I would find it very useful to be able to specify exclusions in some sort of configuration file, so that using the tool locally or via CI would yield the same results without having to make a tedious list of arguments.

I do think an --exclude <stuff> approach is great. But I hope it's a step on the road to configuration-based formatting.

BTW how evil would it be to put this kind of configuration data in global.json? :)

[JoeRobich]

I would find it very useful to be able to specify exclusions in some sort of configuration file

@sandyarmstrong I opened #520 to track the configuration file proposal. Feel free to make suggestions.

Reading through comments in #520, to @sandyarmstrong's point:

... to capture files that aren't part of the main solution, but then need to be able to avoid files (for example, template files, or certain other shared/copied files) that are not really "ours" to format.

It might be valuable to allow consumers to use wildcards in their paths to account for these types of situations (*.template.cs, for instance). I don't think the other options for folder/files support this, so apologies if this idea has been swatted down in the past.

[JoeRobich]

@jpshrader The proposal looks good. I feel like we'll have to add an include alias for the files option. =)
Let's start with your initial proposal and we can look into file globs as a later enhancement.

[jmarolf]

It might be valuable to allow consumers to use wildcards in their paths to account for these types of situations (*.template.cs, for instance). I don't think the other options for folder/files support this, so apologies if this idea has been swatted down in the past.

Wildcard filtering is already supported in .editorconfig files today. I continue to be concerned that we are inventing yet-another-editorconfig file type

Wildcard filtering is already supported in .editorconfig files today. I continue to be concerned that we are inventing yet-another-editorconfig file type

Also true, good point.

[JoeRobich]

@jpshrader Thanks again. Closing this issue.