feat(dev): ignoredRouteFiles config option (remix-run#989)

Added default setting in all template configs to ignore dotfiles
kanermichael · Dec 15, 2021 · 45df222 · 45df222
1 parent d4860a0
commit 45df222
Show file tree

Hide file tree

Showing 19 changed files with 52 additions and 21 deletions.
diff --git a/examples/basic/remix.config.js b/examples/basic/remix.config.js
@@ -6,5 +6,6 @@ module.exports = {
   assetsBuildDirectory: "public/build",
   publicPath: "/build/",
   serverBuildDirectory: "build",
-  devServerPort: 8002
+  devServerPort: 8002,
+  ignoredRouteFiles: [".*"]
 };
diff --git a/examples/blog-tutorial/remix.config.js b/examples/blog-tutorial/remix.config.js
@@ -6,5 +6,6 @@ module.exports = {
   assetsBuildDirectory: "public/build",
   publicPath: "/build/",
   serverBuildDirectory: "build",
-  devServerPort: 8002
+  devServerPort: 8002,
+  ignoredRouteFiles: [".*"]
 };
diff --git a/examples/jokes/remix.config.js b/examples/jokes/remix.config.js
@@ -7,4 +7,5 @@ module.exports = {
   publicPath: "/build/",
   serverBuildDirectory: "build",
   devServerPort: 8003,
+  ignoredRouteFiles: [".*"],
 };
diff --git a/fixtures/gists-app/app/routes/.blargh b/fixtures/gists-app/app/routes/.blargh
@@ -1,2 +1 @@
-Remix ignores dotfiles in the routes directory. This file only exists to ensure
-that the app continues to build and run as if the file didn't exist.
+this file should be ignored by Remix
diff --git a/fixtures/gists-app/app/routes/blargh.ts b/fixtures/gists-app/app/routes/blargh.ts
@@ -0,0 +1,2 @@
+// this file should be ignored by Remix
+export default {};
diff --git a/fixtures/gists-app/remix.config.js b/fixtures/gists-app/remix.config.js
@@ -10,6 +10,7 @@ module.exports = {
   publicPath: "/build/",
   serverBuildDirectory: "./build",
   devServerPort: 8002,
+  ignoredRouteFiles: [".*", "blargh.ts"],
 
   mdx: async filename => {
     const [rehypeHighlight, remarkToc] = await Promise.all([

diff --git a/fixtures/tutorial/remix.config.js b/fixtures/tutorial/remix.config.js
@@ -4,6 +4,7 @@ module.exports = {
   publicPath: "/build/",
   serverBuildDirectory: "build",
   devServerPort: 8002,
+  ignoredRouteFiles: [".*"],
   routes(defineRoutes) {
     return defineRoutes(route => {
       route("*", "catchall.tsx");

diff --git a/packages/create-remix/templates/_shared_js/remix.config.js b/packages/create-remix/templates/_shared_js/remix.config.js
@@ -5,5 +5,6 @@ module.exports = {
   appDirectory: "app",
   assetsBuildDirectory: "public/build",
   publicPath: "/build/",
-  serverBuildDirectory: "server/build"
+  serverBuildDirectory: "server/build",
+  ignoredRouteFiles: [".*"]
 };
diff --git a/packages/create-remix/templates/_shared_ts/remix.config.js b/packages/create-remix/templates/_shared_ts/remix.config.js
@@ -5,5 +5,6 @@ module.exports = {
   appDirectory: "app",
   assetsBuildDirectory: "public/build",
   publicPath: "/build/",
-  serverBuildDirectory: "server/build"
+  serverBuildDirectory: "server/build",
+  ignoredRouteFiles: [".*"]
 };
diff --git a/packages/create-remix/templates/arc/remix.config.js b/packages/create-remix/templates/arc/remix.config.js
@@ -6,5 +6,6 @@ module.exports = {
   assetsBuildDirectory: "public/build",
   publicPath: "/_static/build/",
   serverBuildDirectory: "server/build",
-  devServerPort: 8002
+  devServerPort: 8002,
+  ignoredRouteFiles: [".*"]
 };
diff --git a/packages/create-remix/templates/cloudflare-workers/remix.config.js b/packages/create-remix/templates/cloudflare-workers/remix.config.js
@@ -6,5 +6,6 @@ module.exports = {
   assetsBuildDirectory: "public/build",
   publicPath: "/build/",
   serverBuildDirectory: "build",
-  devServerBroadcastDelay: 1000
+  devServerBroadcastDelay: 1000,
+  ignoredRouteFiles: [".*"]
 };
diff --git a/packages/create-remix/templates/express/remix.config.js b/packages/create-remix/templates/express/remix.config.js
@@ -6,5 +6,6 @@ module.exports = {
   assetsBuildDirectory: "public/build",
   publicPath: "/build/",
   serverBuildDirectory: "server/build",
-  devServerPort: 8002
+  devServerPort: 8002,
+  ignoredRouteFiles: [".*"]
 };
diff --git a/packages/create-remix/templates/fly/remix.config.js b/packages/create-remix/templates/fly/remix.config.js
@@ -6,5 +6,6 @@ module.exports = {
   assetsBuildDirectory: "public/build",
   publicPath: "/build/",
   serverBuildDirectory: "build",
-  devServerPort: 8002
+  devServerPort: 8002,
+  ignoredRouteFiles: [".*"]
 };
diff --git a/packages/create-remix/templates/netlify/remix.config.js b/packages/create-remix/templates/netlify/remix.config.js
@@ -6,5 +6,6 @@ module.exports = {
   assetsBuildDirectory: "public/build",
   publicPath: "/build/",
   serverBuildDirectory: "netlify/functions/server/build",
-  devServerPort: 8002
+  devServerPort: 8002,
+  ignoredRouteFiles: [".*"]
 };
diff --git a/packages/create-remix/templates/remix/remix.config.js b/packages/create-remix/templates/remix/remix.config.js
@@ -6,5 +6,6 @@ module.exports = {
   assetsBuildDirectory: "public/build",
   publicPath: "/build/",
   serverBuildDirectory: "build",
-  devServerPort: 8002
+  devServerPort: 8002,
+  ignoredRouteFiles: [".*"]
 };
diff --git a/packages/create-remix/templates/vercel/remix.config.js b/packages/create-remix/templates/vercel/remix.config.js
@@ -5,5 +5,6 @@ module.exports = {
   appDirectory: "app",
   assetsBuildDirectory: "public/build",
   publicPath: "/build/",
-  serverBuildDirectory: "api/_build"
+  serverBuildDirectory: "api/_build",
+  ignoredRouteFiles: [".*"]
 };
diff --git a/packages/remix-dev/config.ts b/packages/remix-dev/config.ts
@@ -83,6 +83,13 @@ export interface AppConfig {
    * The output format of the server build. Defaults to "cjs".
    */
   serverModuleFormat: "esm" | "cjs";
+
+  /**
+   * A list of filenames or a glob patterns to match files in the `app/routes`
+   * directory that Remix will ignore. Matching files will not be recognized as
+   * routes.
+   */
+  ignoredRouteFiles?: string[];
 }
 
 /**
@@ -235,7 +242,10 @@ export async function readConfig(
     root: { path: "", id: "root", file: rootRouteFile }
   };
   if (fs.existsSync(path.resolve(appDirectory, "routes"))) {
-    let conventionalRoutes = defineConventionalRoutes(appDirectory);
+    let conventionalRoutes = defineConventionalRoutes(
+      appDirectory,
+      appConfig.ignoredRouteFiles
+    );
     for (let key of Object.keys(conventionalRoutes)) {
       let route = conventionalRoutes[key];
       routes[route.id] = { ...route, parentId: route.parentId || "root" };

diff --git a/packages/remix-dev/config/routesConvention.ts b/packages/remix-dev/config/routesConvention.ts
@@ -1,5 +1,6 @@
 import * as fs from "fs";
 import * as path from "path";
+import minimatch from "minimatch";
 
 import type { RouteManifest, DefineRouteFunction } from "./routes";
 import { defineRoutes, createRouteId } from "./routes";
@@ -21,20 +22,24 @@ export function isRouteModuleFile(filename: string): boolean {
  * For example, a file named `app/routes/gists/$username.tsx` creates a route
  * with a path of `gists/:username`.
  */
-export function defineConventionalRoutes(appDir: string): RouteManifest {
+export function defineConventionalRoutes(
+  appDir: string,
+  ignoredFilePatterns?: string[]
+): RouteManifest {
   let files: { [routeId: string]: string } = {};
 
   // First, find all route modules in app/routes
   visitFiles(path.join(appDir, "routes"), file => {
-    let routeId = createRouteId(path.join("routes", file));
-
-    if (isRouteModuleFile(file)) {
-      files[routeId] = path.join("routes", file);
+    if (
+      ignoredFilePatterns &&
+      ignoredFilePatterns.some(pattern => minimatch(file, pattern))
+    ) {
       return;
     }
 
-    // https://github.com/remix-run/remix/issues/391
-    if (path.basename(file).startsWith(".")) {
+    if (isRouteModuleFile(file)) {
+      let routeId = createRouteId(path.join("routes", file));
+      files[routeId] = path.join("routes", file);
       return;
     }
 

diff --git a/packages/remix-dev/package.json b/packages/remix-dev/package.json
@@ -21,6 +21,7 @@
     "fs-extra": "^10.0.0",
     "lodash.debounce": "^4.0.8",
     "meow": "^7.1.1",
+    "minimatch": "^3.0.4",
     "pretty-ms": "^7.0.1",
     "read-package-json-fast": "^2.0.2",
     "remark-frontmatter": "^4.0.0",
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		// this file should be ignored by Remix
		export default {};