Add include option as alternative to ignore

Author: technicallyjosh

README.md

@@ -34,6 +34,7 @@ go install github.com/technicallyjosh/protoc-gen-openapi@latest
 | `version`          | The version of the API.                                                           | 0.0.1            |
 | `title`            | The title of the API.                                                             |                  |
 | `description`      | A description of the API.                                                         |                  |
+| `include`          | A list of proto package names to include only. `ignore` is ran after this         |                  |
 | `ignore`           | A list of proto package names to ignore delimited by pipes.                       |                  |
 | `default_response` | The default response to be used.<sup>1</sup>                                      |                  |
 | `content_type`     | The content type to be associated with all operations.<sup>1</sup>                | application/json |

internal/generator/generator.go

@@ -23,6 +23,7 @@ type Config struct {
 	Filename        *string
 	Host            *string
 	Ignore          *string
+	Include         *string
 	JSONOutput      *bool
 	Title           *string
 	UseJSONNames    *bool
@@ -246,8 +247,22 @@ func (g *Generator) buildDocument() (*openapi3.T, error) {
 		Tags:     make(openapi3.Tags, 0),
 	}
 
+	included := strings.Split(*g.config.Include, "|")
 	ignored := strings.Split(*g.config.Ignore, "|")
-	files := filterFiles(g.plugin.Files, ignored)
+
+	files := make([]*protogen.File, 0)
+
+	if len(included) > 0 {
+		files = filterIncludedFiles(g.plugin.Files, included)
+	}
+
+	if len(ignored) > 0 {
+		if len(files) == 0 {
+			files = g.plugin.Files
+		}
+
+		files = filterIgnoredFiles(files, ignored)
+	}
 
 	for _, file := range files {
 		g.buildMessageMap(file.Messages)
@@ -353,7 +368,7 @@ func addFileSecurityToDoc(doc *openapi3.T, file *protogen.File) error {
 	return nil
 }
 
-func filterFiles(allFiles []*protogen.File, ignored []string) []*protogen.File {
+func filterIgnoredFiles(allFiles []*protogen.File, ignored []string) []*protogen.File {
 	files := make([]*protogen.File, 0)
 
 Files:
@@ -373,3 +388,24 @@ Files:
 
 	return files
 }
+
+func filterIncludedFiles(allFiles []*protogen.File, included []string) []*protogen.File {
+	files := make([]*protogen.File, 0)
+
+Files:
+	for _, file := range allFiles {
+		if !file.Generate {
+			continue
+		}
+
+		for _, ignoredPackage := range included {
+			if file.Proto.GetPackage() != ignoredPackage {
+				continue Files
+			}
+		}
+
+		files = append(files, file)
+	}
+
+	return files
+}

main.go

@@ -17,6 +17,7 @@ func main() {
 		Filename:        flags.String("filename", "openapi", "Name of the file generated without the extension."),
 		Host:            flags.String("host", "", "Host to be used for all routes."),
 		Ignore:          flags.String("ignore", "", "Packages to ignore."),
+		Include:         flags.String("include", "", "Packages to include. Ignore overrides this."),
 		JSONOutput:      flags.Bool("json_out", false, "Generate a JSON file instead of YAML."),
 		Title:           flags.String("title", "", "Title of the API"),
 		UseJSONNames:    flags.Bool("json_names", false, "Use JSON names instead of the proto names of fields."),

main_test.go

@@ -17,6 +17,8 @@ type TestOptions struct {
 	testProto       string
 	title           string
 	version         string
+	include         string
+	ignore          string
 }
 
 type TestSuite struct {
@@ -105,6 +107,8 @@ func (s *TestSuite) BeforeTest(suite, name string) {
 		"--openapi_opt=title="+s.options.title,
 		"--openapi_opt=description="+s.options.description,
 		"--openapi_opt=default_response="+s.options.defaultResponse,
+		"--openapi_opt=include="+s.options.include,
+		"--openapi_opt=ignore="+s.options.ignore,
 		"test/"+filename,
 	).CombinedOutput()
 	if err != nil {