# @remix-run/v1-route-convention

> Enables the [v1 route file convention](https://remix.run/docs/en/v1/file-conventions/routes-files) in Remix v2.

Latest version **0.1.4** (published 2023-10-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install @remix-run/v1-route-convention
pnpm add @remix-run/v1-route-convention
yarn add @remix-run/v1-route-convention
bun add @remix-run/v1-route-convention
```

## Health

**Score 40/100 (D)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.1.4 |
| Published | 2023-10-02 |
| First published | 2023-03-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 39.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 15 |
| Maintainers | chancestrickland, mjackson |

## Links

- npm: https://www.npmjs.com/package/@remix-run/v1-route-convention
- Repository: https://github.com/remix-run/v1-compat-utils
- Homepage: https://remix.run
- Issues: https://github.com/remix-run/v1-compat-utils/issues
- npm.io page: https://npm.io/package/@remix-run/v1-route-convention

## Dependencies (1)

- [minimatch](https://npm.io/package/minimatch.md) ^7.4.3

## Recent versions

- 0.1.4 (latest) — 2023-10-02
- 0.1.4-pre.0 (pre) — 2023-09-27
- 0.1.3 — 2023-09-18
- 0.1.3-pre.0 — 2023-09-18
- 0.1.2 — 2023-05-24
- 0.1.2-pre.0 — 2023-05-24
- 0.1.1 — 2023-03-31
- 0.1.0 — 2023-03-30
- 0.1.0-pre.0 — 2023-03-30

## README

# V1 Route Convention

Enables the [v1 route file convention](https://remix.run/docs/en/v1/file-conventions/routes-files) in Remix v2.

```js
// remix.config.js
const { createRoutesFromFolders } = require("@remix-run/v1-route-convention");

/** @type {import('@remix-run/dev').AppConfig} */
module.exports = {
  // Tell Remix to ignore everything in the routes directory.
  // We'll let `createRoutesFromFolders` take care of that.
  ignoredRouteFiles: ["**/*"],
  routes: (defineRoutes) => {
    // `createRoutesFromFolders` will create routes for all files in the
    // routes directory using the same default conventions as Remix v1.
    return createRoutesFromFolders(defineRoutes, {
      // If you're already using `ignoredRouteFiles` in your Remix config,
      // you can move them to `ignoredFilePatterns` in the plugin's options.
      ignoredFilePatterns: ["**/.*", "**/*.css"],
    });
  },
};
```

---
_Source: https://npm.io/package/@remix-run/v1-route-convention · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._