@remix-run/eslint-config

@remix-run/eslint-config

[!WARNING] The @remix-run/eslint-config package is deprecated and will not be included in React Router v7. We recommend moving towards a streamlined ESLint config such as the ones included in the Remix templates. See https://github.com/remix-run/remix/blob/main/templates/remix/.eslintrc.cjs.

This package includes a shareable ESLint config for Remix projects.

If you create your app with create-remix no additional configuration is necessary.

Installation

First, install this package along with ESLint in your project. This package requires at least version 8.1 of ESLint

npm install -D eslint @remix-run/eslint-config

Then create a file named .eslintrc.js in the root of your project:

module.exports = {
  extends: "@remix-run/eslint-config",
};

Jest + Testing Library

This packages also ships with optional configuration options for projects that use Jest with Testing Library. To enable these rules, add the following to your .eslintrc:

module.exports = {
  extends: [
    "@remix-run/eslint-config",
    "@remix-run/eslint-config/jest-testing-library",
  ],
};

Please note that because this ruleset is optional, we do not include the core libraries as peer dependencies for this package. If you use these rules, be sure that you have the following dependencies installed in your project:

{
  "dependencies": {
    "@testing-library/jest-dom": ">=5.16.0",
    "@testing-library/react": ">=12.0.0",
    "jest": ">=28.0.0"
  }
}

Changelog

v2.14.0

Date: 2024-11-08

Minor Changes

• Deprecate SerializeFrom in favor of generics because it will be removed in React Router v7 (#10173)

• Add deprecation warning to @remix-run/eslint-config (#10174)

• Add support for routes.ts behind future.unstable_routeConfig flag to assist with the migration to React Router v7. (#10107)

  Config-based routing is the new default in React Router v7, configured via the routes.ts file in the app directory. Support for routes.ts and its related APIs in Remix are designed as a migration path to help minimize the number of changes required when moving your Remix project over to React Router v7. While some new packages have been introduced within the @remix-run scope, these new packages only exist to keep the code in routes.ts as similar as possible to the equivalent code for React Router v7.

  When the unstable_routeConfig future flag is enabled, Remix's built-in file system routing will be disabled and your project will opted into React Router v7's config-based routing.

  To enable the flag, in your vite.config.ts file:

  remix({
    future: {
      unstable_routeConfig: true,
    },
  });
  

  A minimal routes.ts file to support Remix's built-in file system routing looks like this:

  // app/routes.ts
  import { flatRoutes } from "@remix-run/fs-routes";
  import type { RouteConfig } from "@remix-run/route-config";
  
  export const routes: RouteConfig = flatRoutes();
  

• Log deprecation warnings for v3 future flags (#10126)

  • Add @deprecated annotations to json/defer utilities

Patch Changes

• Fix defaultShouldRevalidate value when using single fetch (#10139)
• Update externally-accessed resource routes warning to cover null usage as well (#10145)

Updated Dependencies

• react-router-dom@6.28.0
• @remix-run/router@1.21.0

Changes by Package

• create-remix
• @remix-run/architect
• @remix-run/cloudflare
• @remix-run/cloudflare-pages
• @remix-run/cloudflare-workers
• @remix-run/css-bundle
• @remix-run/deno
• @remix-run/dev
• @remix-run/eslint-config
• @remix-run/express
• @remix-run/fs-routes
• @remix-run/node
• @remix-run/react
• @remix-run/route-config
• @remix-run/routes-option-adapter
• @remix-run/serve
• @remix-run/server-runtime
• @remix-run/testing

Full Changelog: v2.13.1...v2.14.0