Add openapiGeneratorIgnoreList option to pre-populate .openapi-genera…

…tor-ignore (#17164)

* add openapiGeneratorIgnoreList option to pre-populate .openapi-generator-ignore

* minor fix

* better code format

* add tests

docs/customization.md

@@ -266,6 +266,11 @@ Upon first code generation, you may also pass the CLI option `--ignore-file-over
 
 Editor support for `.openapi-generator-ignore` files is available in IntelliJ via the [.ignore plugin](https://plugins.jetbrains.com/plugin/7495--ignore).
 
+One may want to pre-populate `.openapi-generator-ignore` with a list of entries during the code generation process and the global/general option `openapiGeneatorIgnoreList` (e.g. --openapi-generator-ignore-list in CLI) can do exactly that. For example,
+```
+java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g spring -i modules/openapi-generator/src/test/resources/3_0/petstore.yaml -o /tmp/spring --additional-properties useTags=true --openapi-generator-ignore-list "README.md,pom.xml,docs/*.md,src/main/java/org/openapitools/model/*"
+```
+
 ## Customizing the generator
 
 There are different aspects of customizing the code generator beyond just creating or modifying templates.  Each language has a supporting configuration file to handle different type mappings, etc:

modules/openapi-generator-cli/src/main/java/org/openapitools/codegen/cmd/ConfigHelp.java

@@ -101,6 +101,9 @@ public class ConfigHelp extends OpenApiGeneratorCommand {
     @Option(name = {"--language-specific-primitive"}, title = "language specific primitives", description = "displays the language specific primitives (types which require no additional imports, or which may conflict with user defined model names)")
     private Boolean languageSpecificPrimitives;
 
+    @Option(name = {"--openapi-generator-ignore-list"}, title = "openapi generator ignore list", description = "displays the openapi generator ignore list")
+    private Boolean openapiGeneratorIgnoreList;
+
     @Option(name = {"--reserved-words"}, title = "language specific reserved words", description = "displays the reserved words which may result in renamed model or property names")
     private Boolean reservedWords;
 
@@ -588,6 +591,13 @@ private void generatePlainTextHelp(StringBuilder sb, CodegenConfig config) {
             sb.append(newline);
         }
 
+        if (Boolean.TRUE.equals(openapiGeneratorIgnoreList)) {
+            sb.append(newline).append("OPENAPI GENERATOR IGNORE LIST").append(newline).append(newline);
+            String[] arr = config.openapiGeneratorIgnoreList().stream().sorted().toArray(String[]::new);
+            writePlainTextFromArray(sb, arr, optIndent);
+            sb.append(newline);
+        }
+
         if (Boolean.TRUE.equals(reservedWords)) {
             sb.append(newline).append("RESERVED WORDS").append(newline).append(newline);
             String[] arr = config.reservedWords().stream().sorted().toArray(String[]::new);

modules/openapi-generator-cli/src/main/java/org/openapitools/codegen/cmd/Generate.java

@@ -160,6 +160,13 @@ public class Generate extends OpenApiGeneratorCommand {
                     + " You can also have multiple occurrences of this option.")
     private List<String> languageSpecificPrimitives = new ArrayList<>();
 
+    @Option(
+            name = {"--openapi-generator-ignore-list"},
+            title = ".openapi-generaotr-ignore list",
+            description = "specifies entries in the .openapi-generator-ignore file relative/path/to/file1,relative/path/to/file2. For example: README.md,pom.xml"
+                    + " You can also have multiple occurrences of this option.")
+    private List<String> openapiGeneratorIgnoreList = new ArrayList<>();
+
     @Option(
             name = {"--import-mappings"},
             title = "import mappings",
@@ -504,6 +511,7 @@ public void execute() {
         applyTypeMappingsKvpList(typeMappings, configurator);
         applyAdditionalPropertiesKvpList(additionalProperties, configurator);
         applyLanguageSpecificPrimitivesCsvList(languageSpecificPrimitives, configurator);
+        applyOpenAPIGeneratorIgnoreListCsvList(openapiGeneratorIgnoreList, configurator);
         applyReservedWordsMappingsKvpList(reservedWordsMappings, configurator);
         applyServerVariablesKvpList(serverVariableOverrides, configurator);
 

modules/openapi-generator-core/src/main/java/org/openapitools/codegen/config/GeneratorSettings.java

@@ -59,6 +59,7 @@ public final class GeneratorSettings implements Serializable {
     private final Map<String, String> enumNameMappings;
     private final Map<String, String> openapiNormalizer;
     private final Set<String> languageSpecificPrimitives;
+    private final Set<String> openapiGeneratorIgnoreList;
     private final Map<String, String> reservedWordsMappings;
     private final Map<String, String> serverVariables;
 
@@ -330,6 +331,15 @@ public Set<String> getLanguageSpecificPrimitives() {
         return languageSpecificPrimitives;
     }
 
+    /**
+     * Gets openapi generator ignore list.
+     *
+     * @return the openapi generator ignore list
+     */
+    public Set<String> getOpenAPIGeneratorIgnoreList() {
+        return openapiGeneratorIgnoreList;
+    }
+
     /**
      * Gets reserved word mappings. Values defined here define how a reserved word should be escaped.
      * <p>
@@ -438,6 +448,7 @@ private GeneratorSettings(Builder builder) {
         enumNameMappings = Collections.unmodifiableMap(builder.enumNameMappings);
         openapiNormalizer = Collections.unmodifiableMap(builder.openapiNormalizer);
         languageSpecificPrimitives = Collections.unmodifiableSet(builder.languageSpecificPrimitives);
+        openapiGeneratorIgnoreList = Collections.unmodifiableSet(builder.openapiGeneratorIgnoreList);
         reservedWordsMappings = Collections.unmodifiableMap(builder.reservedWordsMappings);
         serverVariables = Collections.unmodifiableMap(builder.serverVariables);
         gitHost = builder.gitHost;
@@ -516,6 +527,7 @@ public GeneratorSettings() {
         enumNameMappings = Collections.unmodifiableMap(new HashMap<>(0));
         openapiNormalizer = Collections.unmodifiableMap(new HashMap<>(0));
         languageSpecificPrimitives = Collections.unmodifiableSet(new HashSet<>(0));
+        openapiGeneratorIgnoreList = Collections.unmodifiableSet(new HashSet<>(0));
         reservedWordsMappings = Collections.unmodifiableMap(new HashMap<>(0));
         serverVariables = Collections.unmodifiableMap(new HashMap<>(0));
     }
@@ -593,6 +605,9 @@ public static Builder newBuilder(GeneratorSettings copy) {
         if (copy.getLanguageSpecificPrimitives() != null) {
             builder.languageSpecificPrimitives.addAll(copy.getLanguageSpecificPrimitives());
         }
+        if (copy.getOpenAPIGeneratorIgnoreList() != null) {
+            builder.openapiGeneratorIgnoreList.addAll(copy.getOpenAPIGeneratorIgnoreList());
+        }
         if (copy.getReservedWordsMappings() != null) {
             builder.reservedWordsMappings.putAll(copy.getReservedWordsMappings());
         }
@@ -638,6 +653,7 @@ public static final class Builder {
         private Map<String, String> enumNameMappings;
         private Map<String, String> openapiNormalizer;
         private Set<String> languageSpecificPrimitives;
+        private Set<String> openapiGeneratorIgnoreList;
         private Map<String, String> reservedWordsMappings;
         private Map<String, String> serverVariables;
         private String gitHost;
@@ -663,6 +679,7 @@ public Builder() {
             enumNameMappings = new HashMap<>();
             openapiNormalizer = new HashMap<>();
             languageSpecificPrimitives = new HashSet<>();
+            openapiGeneratorIgnoreList = new HashSet<>();
             reservedWordsMappings = new HashMap<>();
             serverVariables = new HashMap<>();
 
@@ -1137,6 +1154,31 @@ public Builder withLanguageSpecificPrimitive(String value) {
             return this;
         }
 
+        /**
+         * Sets the {@code openapiGeneratorIgnoreList} and returns a reference to this Builder so that the methods can be chained together.
+         *
+         * @param openapiGeneratorIgnoreList the {@code openapiGeneratorIgnoreList} to set
+         * @return a reference to this Builder
+         */
+        public Builder withOpenAPIGeneratorIgnoreList(Set<String> openapiGeneratorIgnoreList) {
+            this.openapiGeneratorIgnoreList = openapiGeneratorIgnoreList;
+            return this;
+        }
+
+        /**
+         * Sets a single {@code openapiGeneratorIgnoreList} and returns a reference to this Builder so that the methods can be chained together.
+         *
+         * @param value The value of entry to set
+         * @return a reference to this Builder
+         */
+        public Builder withOpenAPIGeneratorIgnoreList(String value) {
+            if (this.openapiGeneratorIgnoreList == null) {
+                this.openapiGeneratorIgnoreList = new HashSet<>();
+            }
+            this.openapiGeneratorIgnoreList.add(value);
+            return this;
+        }
+
         /**
          * Sets the {@code reservedWordsMappings} and returns a reference to this Builder so that the methods can be chained together.
          *
@@ -1266,6 +1308,7 @@ public String toString() {
                 ", additionalProperties=" + additionalProperties +
                 ", importMappings=" + importMappings +
                 ", languageSpecificPrimitives=" + languageSpecificPrimitives +
+                ", openapiGeneratorIgnoreList=" + openapiGeneratorIgnoreList +
                 ", reservedWordsMappings=" + reservedWordsMappings +
                 ", gitHost='" + gitHost + '\'' +
                 ", gitUserId='" + gitUserId + '\'' +
@@ -1305,6 +1348,7 @@ public boolean equals(Object o) {
                 Objects.equals(getEnumNameMappings(), that.getEnumNameMappings()) &&
                 Objects.equals(getOpenAPINormalizer(), that.getOpenAPINormalizer()) &&
                 Objects.equals(getLanguageSpecificPrimitives(), that.getLanguageSpecificPrimitives()) &&
+                Objects.equals(getOpenAPIGeneratorIgnoreList(), that.getOpenAPIGeneratorIgnoreList()) &&
                 Objects.equals(getReservedWordsMappings(), that.getReservedWordsMappings()) &&
                 Objects.equals(getGitHost(), that.getGitHost()) &&
                 Objects.equals(getGitUserId(), that.getGitUserId()) &&
@@ -1341,6 +1385,7 @@ public int hashCode() {
                 getEnumNameMappings(),
                 getOpenAPINormalizer(),
                 getLanguageSpecificPrimitives(),
+                getOpenAPIGeneratorIgnoreList(),
                 getReservedWordsMappings(),
                 getGitHost(),
                 getGitUserId(),

modules/openapi-generator-gradle-plugin/src/main/kotlin/org/openapitools/generator/gradle/plugin/extensions/OpenApiGeneratorGenerateExtension.kt

@@ -147,6 +147,11 @@ open class OpenApiGeneratorGenerateExtension(project: Project) {
      */
     val languageSpecificPrimitives = project.objects.listProperty<String>()
 
+    /**
+     * Specifies .openapi-generator-ignore list in the form of relative/path/to/file1,relative/path/to/file2. For example: README.md,pom.xml. 
+     */
+    val openapiGeneratorIgnoreList = project.objects.listProperty<String>()
+
     /**
      * Specifies mappings between a given class and the import that should be used for that class.
      */

modules/openapi-generator-gradle-plugin/src/main/kotlin/org/openapitools/generator/gradle/plugin/tasks/GenerateTask.kt

@@ -244,6 +244,13 @@ open class GenerateTask @Inject constructor(private val objectFactory: ObjectFac
     @Input
     val languageSpecificPrimitives = project.objects.listProperty<String>()
 
+    /**
+     * Specifies .openapi-generator-ignore list in the form of relative/path/to/file1,relative/path/to/file2. For example: README.md,pom.xml.
+     */
+    @Optional
+    @Input
+    val openapiGeneratorIgnoreList = project.objects.listProperty<String>()
+
     /**
      * Specifies mappings between a given class and the import that should be used for that class.
      */
@@ -895,6 +902,12 @@ open class GenerateTask @Inject constructor(private val objectFactory: ObjectFac
                 }
             }
 
+            if (openapiGeneratorIgnoreList.isPresent) {
+                openapiGeneratorIgnoreList.get().forEach {
+                    configurator.addOpenAPIGeneratorIgnoreList(it)
+                }
+            }
+
             if (reservedWordsMappings.isPresent) {
                 reservedWordsMappings.get().forEach { entry ->
                     configurator.addAdditionalReservedWordMapping(entry.key, entry.value)

modules/openapi-generator-maven-plugin/src/main/java/org/openapitools/codegen/plugin/CodeGenMojo.java

@@ -374,6 +374,12 @@ public class CodeGenMojo extends AbstractMojo {
     @Parameter(name = "languageSpecificPrimitives", property = "openapi.generator.maven.plugin.languageSpecificPrimitives")
     private List<String> languageSpecificPrimitives;
 
+    /**
+     * A list of openapi-generator-ignore entries
+     */
+    @Parameter(name = "openapiGeneratorIgnoreList", property = "openapi.generator.maven.plugin.openapiGeneratorIgnoreList")
+    private List<String> openapiGeneratorIgnoreList;
+
     /**
      * A map of additional properties that can be referenced by the mustache templates
      */
@@ -783,6 +789,12 @@ public void execute() throws MojoExecutionException {
                             .get("language-specific-primitives").toString(), configurator);
                 }
 
+                // Retained for backwards-compatibility with configOptions -> openapi-generator-ignore-list
+                if (openapiGeneratorIgnoreList == null && configOptions.containsKey("openapi-generator-ignore-list")) {
+                    applyOpenAPIGeneratorIgnoreListCsv(configOptions
+                            .get("openapi-generator-ignore-list").toString(), configurator);
+                }
+
                 // Retained for backwards-compatibility with configOptions -> additional-properties
                 if (additionalProperties == null && configOptions.containsKey("additional-properties")) {
                     applyAdditionalPropertiesKvp(configOptions.get("additional-properties").toString(),
@@ -861,6 +873,12 @@ public void execute() throws MojoExecutionException {
                 applyLanguageSpecificPrimitivesCsvList(languageSpecificPrimitives, configurator);
             }
 
+            // Apply Language Specific Primitives
+            if (openapiGeneratorIgnoreList != null
+                    && (configOptions == null || !configOptions.containsKey("openapi-generator-ignore-list"))) {
+                applyOpenAPIGeneratorIgnoreListCsvList(openapiGeneratorIgnoreList, configurator);
+            }
+
             // Apply Additional Properties
             if (additionalProperties != null && (configOptions == null || !configOptions.containsKey("additional-properties"))) {
                 applyAdditionalPropertiesKvpList(additionalProperties, configurator);

modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenConfig.java

@@ -173,6 +173,8 @@ public interface CodegenConfig {
 
     Set<String> languageSpecificPrimitives();
 
+    Set<String> openapiGeneratorIgnoreList();
+
     Map<String, String> reservedWordsMappings();
 
     void preprocessOpenAPI(OpenAPI openAPI);
@@ -349,4 +351,6 @@ public interface CodegenConfig {
 
     boolean getUseOpenAPINormalizer();
 
+    Set<String> getOpenAPIGeneratorIgnoreList();
+
 }

modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java

@@ -160,6 +160,7 @@ public class DefaultCodegen implements CodegenConfig {
     protected Map<String, String> instantiationTypes;
     protected Set<String> reservedWords;
     protected Set<String> languageSpecificPrimitives = new HashSet<>();
+    protected Set<String> openapiGeneratorIgnoreList = new HashSet<>();
     protected Map<String, String> importMapping = new HashMap<>();
     // a map to store the mapping between a schema and the new one
     protected Map<String, String> schemaMapping = new HashMap<>();
@@ -1211,6 +1212,11 @@ public Set<String> languageSpecificPrimitives() {
         return languageSpecificPrimitives;
     }
 
+    @Override
+    public Set<String> openapiGeneratorIgnoreList() {
+        return openapiGeneratorIgnoreList;
+    }
+
     @Override
     public Map<String, String> importMapping() {
         return importMapping;
@@ -8317,6 +8323,11 @@ public List<VendorExtension> getSupportedVendorExtensions() {
     @Override
     public boolean getUseOpenAPINormalizer() { return true; }
 
+    @Override
+    public Set<String> getOpenAPIGeneratorIgnoreList() {
+        return openapiGeneratorIgnoreList;
+    }
+
     /*
     A function to convert yaml or json ingested strings like property names
     And convert special characters like newline, tab, carriage return