elysia-autoload 1.5.2 → 1.7.0

package/README.md

@@ -41,6 +41,26 @@ const app = new Elysia().use(await autoload()).listen(3000);
 export type ElysiaApp = typeof app;
 ```
 
+### With custom options
+
+```ts
+import { Elysia } from "elysia";
+import { autoload } from "elysia-autoload";
+
+const app = new Elysia()
+    .use(
+        await autoload({
+            dir: "./routes",
+            prefix: "/api",
+            // Ignore test files and spec files
+            ignore: ["**/*.test.ts", "**/*.spec.ts"]
+        })
+    )
+    .listen(3000);
+
+export type ElysiaApp = typeof app;
+```
+
 > [!IMPORTANT]
 > We strictly recommend use `await` when registering plugin
 >
@@ -99,6 +119,7 @@ Guide how `elysia-autoload` match routes
 | prefix?  | string                                     |                                    | Prefix for routes                                                                   |
 | types?   | boolean \| [Types Options](#types-options) | false                              | Options to configure type code-generation. if boolean - enables/disables generation |
 | schema?  | Function                                   |                                    | Handler for providing routes guard schema                                           |
+| ignore?  | string \| string[]                         |                                    | Glob pattern(s) to ignore when discovering files                                    |
 
 ### Types Options
 

package/dist/index.d.ts

@@ -53,6 +53,15 @@ interface AutoloadOptions {
      * @default false
      */
     skipImportErrors?: boolean;
+    /**
+     * Glob pattern(s) to ignore when discovering files
+     */
+    ignore?: string | string[];
+    /**
+     * Path to tsconfig.json file for module resolution detection
+     * @default "tsconfig.json"
+     */
+    tsconfigPath?: string;
 }
 declare function autoload(options?: AutoloadOptions): Promise<Elysia$1<string, {
     decorator: {};

package/dist/index.js

@@ -30,7 +30,37 @@ const IS_BUN = typeof Bun !== "undefined";
 function globSync(globPattern, globOptions) {
   return IS_BUN ? Array.from(new Bun.Glob(globPattern).scanSync(globOptions)) : fs.globSync(globPattern, globOptions);
 }
+function matchesPattern(filePath, pattern) {
+  if (IS_BUN) {
+    const glob = new Bun.Glob(pattern);
+    return glob.match(filePath);
+  }
+  let regexPattern = pattern.replace(/[.+^${}()|[\]\\]/g, "\\$&").replace(/\\\*/g, "*").replace(/\\\?/g, "?");
+  regexPattern = regexPattern.replace(/\*\*/g, "\xA7\xA7\xA7").replace(/\*/g, "[^/]*").replace(/§§§/g, ".*").replace(/\?/g, ".").replace(/\{([^}]+)\}/g, (_, group) => {
+    const options = group.split(",").map((s) => s.trim());
+    return `(${options.join("|")})`;
+  });
+  const regex = new RegExp(`^${regexPattern}$`);
+  return regex.test(filePath);
+}
 
+async function shouldKeepTsExtension(tsconfigPath) {
+  try {
+    const configPath = tsconfigPath ? path.resolve(tsconfigPath) : path.join(process.cwd(), "tsconfig.json");
+    let fileContent;
+    if (typeof Bun === "undefined") {
+      fileContent = fs.readFileSync(configPath, "utf-8");
+    } else {
+      fileContent = await Bun.file(configPath).text();
+    }
+    const tsConfig = JSON.parse(fileContent);
+    const moduleOption = (tsConfig.compilerOptions?.module || "").toLowerCase();
+    const moduleResolutionOption = (tsConfig.compilerOptions?.moduleResolution || "").toLowerCase();
+    return moduleOption === "nodenext" || moduleOption === "node16" || moduleResolutionOption === "nodenext" || moduleResolutionOption === "node16";
+  } catch (error) {
+    return false;
+  }
+}
 const DIR_ROUTES_DEFAULT = "./routes";
 const TYPES_OUTPUT_DEFAULT = "./routes-types.ts";
 const TYPES_TYPENAME_DEFAULT = "Routes";
@@ -39,7 +69,7 @@ const TYPES_OBJECT_DEFAULT = {
   typeName: TYPES_TYPENAME_DEFAULT
 };
 async function autoload(options = {}) {
-  const { pattern, prefix, schema } = options;
+  const { pattern, prefix, schema, ignore, tsconfigPath } = options;
   const failGlob = options.failGlob ?? true;
   const getImportName = options?.import ?? "default";
   const dir = options.dir ?? DIR_ROUTES_DEFAULT;
@@ -61,12 +91,21 @@ async function autoload(options = {}) {
       pattern,
       dir,
       prefix,
-      types
+      types,
+      ignore
     }
   });
   const globPattern = pattern || "**/*.{ts,tsx,js,jsx,mjs,cjs}";
   const globOptions = { cwd: directoryPath };
-  const files = globSync(globPattern, globOptions);
+  let files = globSync(globPattern, globOptions);
+  if (ignore) {
+    const ignorePatterns = Array.isArray(ignore) ? ignore : [ignore];
+    files = files.filter((filePath) => {
+      return !ignorePatterns.some(
+        (pattern2) => matchesPattern(filePath, pattern2)
+      );
+    });
+  }
   if (failGlob && files.length === 0)
     throw new Error(
       `No matches found in ${directoryPath}. You can disable this error by setting the failGlob parameter to false in the options of autoload plugin`
@@ -92,16 +131,18 @@ async function autoload(options = {}) {
     if (types) paths.push([fullPath.replace(directoryPath, ""), importName]);
   }
   if (types) {
+    const needsExtension = await shouldKeepTsExtension(tsconfigPath);
     for await (const outputPath of types.output) {
       const outputAbsolutePath = getPath(outputPath);
-      const imports = paths.map(
-        ([x, exportName], index) => `import type ${exportName === "default" ? `Route${index}` : `{ ${exportName} as Route${index} }`} from "${addRelativeIfNotDot(
+      const imports = paths.map(([filePath, exportName], index) => {
+        const importPath = needsExtension ? filePath : filePath.replace(/\.(ts|tsx)$/, "");
+        return `import type ${exportName === "default" ? `Route${index}` : `{ ${exportName} as Route${index} }`} from "${addRelativeIfNotDot(
           path.relative(
             path.dirname(outputAbsolutePath),
-            directoryPath + x.replace(/\.(ts|tsx)$/, "")
+            path.join(directoryPath, importPath)
           ).replaceAll("\\", "/")
-        )}";`
-      );
+        )}";`;
+      });
       const input = [
         `import type { ElysiaWithBaseUrl } from "elysia-autoload";`,
         imports.join("\n"),

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "elysia-autoload",
-	"version": "1.5.2",
+	"version": "1.7.0",
 	"author": "kravetsone",
 	"type": "module",
 	"types": "./dist/index.d.ts",