[maven-plugin] allow for ignore file override

[jimschubert]

PR checklist

• Read the contribution guildelines.
• Ran the shell/batch script under ./bin/ to update Petstore sample so that CIs can verify the change. (For instance, only need to run ./bin/{LANG}-petstore.sh and ./bin/security/{LANG}-petstore.sh if updating the {LANG} (e.g. php, ruby, python, etc) code generator or {LANG} client's mustache templates)
• Filed the PR against the correct branch: master for non-breaking changes and 2.3.0 branch for breaking (non-backward compatible) changes.

Description of the PR

see #4514

The .swagger-codegen-ignore file is beneficial for existing source
directories to provide pattern-based exclusion rules for existing source
to be ignored by swagger codegen. Until now, there's been no utility
other than skipOverwrite to modify the initial generation of code
(either via CLI or maven plugin).

This commit adds support for an ignoreFileOverride option to both the
CLI and the maven plugin.

Example CLI usage:

java -jar swagger-codegen.jar generate \
    -i swagger.json -l csharp \
    -o target --ignore-file-override /path/to/ignore-file

Example Maven Plugin configuration:

    <build>
        <plugins>
            <plugin>
                <groupId>io.swagger</groupId>
                <artifactId>swagger-codegen-maven-plugin</artifactId>
                <version>2.2.2-SNAPSHOT</version>
                <executions>
                    <execution>
                        <goals>
                            <goal>generate</goal>
                        </goals>
                        <configuration>
                            <inputSpec>${project.basedir}/src/main/resources/swagger.yaml</inputSpec>
                            <language>csharp</language>
                            <invokerPackage>io.swagger</invokerPackage>
                            <modelPackage>io.swagger.models</modelPackage>
                            <apiPackage>io.swagger.apis</apiPackage>
                            <ignoreFileOverride>/Users/jim/projects/swagger-codegen/.sample-ignore</ignoreFileOverride>
                            <configOptions>
                            </configOptions>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

To evaluate, you can publish the maven plugin locally:

mvn install -pl modules/swagger-codegen-maven-plugin -am -Dmaven.javadoc.skip=true

And reference 2.2.2-SNAPSHOT in your pom with the new option ignoreFileOverride.

NOTES:

I called this ignoreFileOverride because although it's intended for the initial generation, the option will act as an override for subsequent generations. There's no merge with the .swagger-codegen-ignore file from your target templated code.

I've updated the ignore processor to accept: directory, directory + filename, and File. This would allow us a future enhancement to allow modification of the .swagger-codegen-ignore filename.

[jimschubert]

This PR would likely also resolve #3042

[jfiala]

@jimschubert just checked the PR, works greatly, no more clutter in the target directory :).
@wing328 can you pls review this when you have time, it greatly improves the swagger-codegen-maven-plugin.

[jimschubert]

@wing328 looks like a bad merge, maybe, causing CI to fail. I think this is missing the closing semicolon.

[wing328]

Yup, just noticed it. I'm pushing a fix.

[wing328]

Sorry for the bad merge.

[jimschubert]

¯\_(ツ)_/¯ I only called it out because I know you're fairly busy and may not have seen it.

[wing328]

As always, thanks for catching the issue and make sure I'm aware 👍

[wing328]

Closed via #4597