add include/exclude options to generateOpenApiSpec

Author: omermecitoglu

src/core/dir.test.ts

@@ -0,0 +1,46 @@
+import { describe, expect, it } from "@jest/globals";
+import { filterDirectoryItems } from "./dir";
+
+describe("filterDirectoryItems", () => {
+  const rootPath = "/projects/app/src/app";
+  it("should filter out items correctly", () => {
+    const items = [
+      "/projects/app/src/app/users/route.ts",
+    ];
+    const result = filterDirectoryItems(rootPath, items, [], []);
+    expect(result).toStrictEqual([
+      "/projects/app/src/app/users/route.ts",
+    ]);
+  });
+  it("should handle wildcards correctly with include list", () => {
+    const items = [
+      "/projects/app/src/app/a/b/c/d/route.ts",
+      "/projects/app/src/app/a/b/b/d/route.ts",
+    ];
+    const include = [
+      "a/*/c/d/route.ts",
+    ];
+    const result = filterDirectoryItems(rootPath, items, include, []);
+    expect(result).toStrictEqual([
+      "/projects/app/src/app/a/b/c/d/route.ts",
+    ]);
+  });
+  it("should handle wildcards correctly with exclude list", () => {
+    const items = [
+      "/projects/app/src/app/users/route.ts",
+      "/projects/app/src/app/a/b/c/d/route.ts",
+      "/projects/app/src/app/messages/route.ts",
+    ];
+    const include = [
+      "**/route.ts",
+    ];
+    const exclude = [
+      "messages/route.ts",
+      "a/**/d/route.ts",
+    ];
+    const result = filterDirectoryItems(rootPath, items, include, exclude);
+    expect(result).toStrictEqual([
+      "/projects/app/src/app/users/route.ts",
+    ]);
+  });
+});

src/core/dir.ts

@@ -1,6 +1,7 @@
 import { constants } from "fs";
 import fs from "fs/promises";
 import path from "node:path";
+import { Minimatch } from "minimatch";
 
 export async function directoryExists(dirPath: string) {
   try {
@@ -26,3 +27,15 @@ export async function getDirectoryItems(dirPath: string, targetFileName: string)
   }
   return collection;
 }
+
+export function filterDirectoryItems(rootPath: string, items: string[], include: string[], exclude: string[]) {
+  const includedPatterns = include.map(pattern => new Minimatch(pattern));
+  const excludedPatterns = exclude.map(pattern => new Minimatch(pattern));
+
+  return items.filter(item => {
+    const relativePath = path.relative(rootPath, item);
+    const isIncluded = includedPatterns.some(pattern => pattern.match(relativePath));
+    const isExcluded = excludedPatterns.some(pattern => pattern.match(relativePath));
+    return (isIncluded || !include.length) && !isExcluded;
+  });
+}

src/core/options.test.ts

@@ -0,0 +1,24 @@
+import { describe, expect, it } from "@jest/globals";
+import { verifyOptions } from "./options";
+
+describe("verifyOptions", () => {
+  it("should filter out invalid route handler paths", () => {
+    const { include, exclude } = verifyOptions([
+      "another_file.ts",
+      "folder_name/route.ts",
+      "**/route.ts",
+    ], [
+      "another_file.ts",
+      "folder_name/route.ts",
+      "**/route.ts",
+    ]);
+    expect(include).toStrictEqual([
+      "folder_name/route.ts",
+      "**/route.ts",
+    ]);
+    expect(exclude).toStrictEqual([
+      "folder_name/route.ts",
+      "**/route.ts",
+    ]);
+  });
+});

src/core/options.ts

@@ -0,0 +1,20 @@
+/* eslint-disable no-console */
+
+export function verifyOptions(include: string[] = [], exclude: string[] = []) {
+  if (process.env.NODE_ENV === "development") {
+    for (const item of include) {
+      if (!item.endsWith("/route.ts")) {
+        console.log(`${item} is not a valid route handler path`);
+      }
+    }
+    for (const item of exclude) {
+      if (!item.endsWith("/route.ts")) {
+        console.log(`${item} is not a valid route handler path`);
+      }
+    }
+  }
+  return {
+    include: include.filter(item => item.endsWith("/route.ts")),
+    exclude: exclude.filter(item => item.endsWith("/route.ts")),
+  };
+}

src/index.ts

@@ -1,17 +1,25 @@
 import getPackageMetadata from "@omer-x/package-metadata";
-import { getDirectoryItems } from "./core/dir";
+import { filterDirectoryItems, getDirectoryItems } from "./core/dir";
 import { findAppFolderPath, getRouteExports } from "./core/next";
+import { verifyOptions } from "./core/options";
 import { type RouteRecord, bundlePaths, createRouteRecord } from "./core/route";
 import { bundleSchemas } from "./core/schema";
 import type { OpenApiDocument } from "@omer-x/openapi-types";
 import type { ZodType } from "zod";
 
-export default async function generateOpenApiSpec(schemas: Record<string, ZodType>) {
+type GeneratorOptions = {
+  include?: string[],
+  exclude?: string[],
+};
+
+export default async function generateOpenApiSpec(schemas: Record<string, ZodType>, options?: GeneratorOptions) {
+  const verifiedOptions = verifyOptions(options?.include, options?.exclude);
   const appFolderPath = await findAppFolderPath();
   if (!appFolderPath) throw new Error("This is not a Next.js application!");
   const routes = await getDirectoryItems(appFolderPath, "route.ts");
+  const verifiedRoutes = filterDirectoryItems(appFolderPath, routes, verifiedOptions.include, verifiedOptions.exclude);
   const validRoutes: RouteRecord[] = [];
-  for (const route of routes) {
+  for (const route of verifiedRoutes) {
     const exportedRouteHandlers = await getRouteExports(route, schemas);
     for (const [method, routeHandler] of Object.entries(exportedRouteHandlers)) {
       if (!routeHandler || !routeHandler.apiData) continue;