Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(file-conventions/remix-config): update watchPaths' description #4833

Merged
merged 1 commit into from
Dec 12, 2022
Merged

docs(file-conventions/remix-config): update watchPaths' description #4833

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions contributors.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,6 +209,7 @@
- joshball
- jrf0110
- jrubins
- jsbmg
- jssisodiya
- jstafman
- juhanakristian
Expand Down
7 changes: 5 additions & 2 deletions docs/file-conventions/remix-config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,12 +155,15 @@ module.exports = {

## watchPaths

A function for defining custom directories to watch while running [remix dev][remix-dev], in addition to [`appDirectory`][app-directory].
An array, string, or async function that defines custom directories, relative to the project root, to watch while running [remix dev][remix-dev]. These directories are in addition to [`appDirectory`][app-directory].

```tsx
exports.watchPaths = async () => {
return ["/some/path/*"];
return ["./some/path/*"];
};

// also valid
exports.watchPaths = ["./some/path/*"];
```

## File Name Conventions
Expand Down