Skip to content
Prev Previous commit
Next Next commit
feat: improve docs (in comments)
  • Loading branch information
brandonmcconnell committed Nov 6, 2025
commit e6b056200d2e1a20fe4fdebbe5f87dffd8a923cb
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,13 @@ declare_lint_rule! {
/// - The name of the file can start with a dot, a plus sign, or a dollar sign, be prefixed and suffixed by underscores `_`.
/// For example, `.filename.js`, `+filename.js`, `$filename.js`, `__filename__.js`, or even `.__filename__.js`.
///
/// The convention of prefixing a filename with a plus sign is used by [Sveltekit](https://kit.svelte.dev/docs/routing#page) and [Vike](https://vike.dev/route).
/// - The convention of prefixing a filename with a plus sign is used by [Sveltekit](https://kit.svelte.dev/docs/routing#page) and [Vike](https://vike.dev/route).
/// - The convention of prefixing a filename with a dollar sign is used by [TanStack Start](https://tanstack.com/start/latest/docs/framework/react/guide/routing#file-based-routing) for file-based routing.
///
/// - Also, the rule supports dynamic route syntaxes of [Next.js](https://nextjs.org/docs/pages/building-your-application/routing/dynamic-routes#catch-all-segments), [SolidStart](https://docs.solidjs.com/solid-start/building-your-application/routing#renaming-index), [Nuxt](https://nuxt.com/docs/guide/directory-structure/server#catch-all-route), and [Astro](https://docs.astro.build/en/guides/routing/#rest-parameters).
/// For example `[...slug].js` and `[[...slug]].js` are valid filenames.
///
/// Note that if you specify the `match' option, the previous exceptions will no longer be handled.
/// Note that if you specify the `match` option, the previous exceptions will no longer be handled.
///
/// ## Ignoring some files
///
Expand Down