Skip to content

Commit d84534d

Browse files
authored
chore(route-convention): update readme (#8)
1 parent 1caf253 commit d84534d

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

packages/v1-route-convention/README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,22 @@
44
// remix.config.js
55
const { createRoutesFromFolders } = require("@remix-run/v1-route-convention");
66

7+
// tell Remix to ignore everything in the routes directory
8+
// we'll let `createRoutesFromFolders` take care of that
9+
exports.ignoredRouteFiles = ["**/*"];
710
exports.routes = (defineRoutes) => createRoutesFromFolders(defineRoutes);
811
```
12+
13+
> **Note**
14+
> If you're already using `ignoredRouteFiles` you can move that to the plugin to keep using it
15+
16+
```diff
17+
// remix.config.js
18+
const { createRoutesFromFolders } = require("@remix-run/v1-route-convention");
19+
20+
- exports.ignoredRouteFiles = ["**/.*"];
21+
+ exports.ignoredRouteFiles = ["**/*"];
22+
+ exports.routes = (defineRoutes) => createRoutesFromFolders(defineRoutes, {
23+
+ ignoredFilePatterns: ["**/.*"]
24+
+ });
25+
```

0 commit comments

Comments
 (0)