eslint-config-expo

What is eslint-config-expo?

The eslint-config-expo package provides a set of ESLint configurations tailored for Expo projects. It helps developers maintain consistent code quality and style across their React Native applications by extending the base ESLint configurations with additional rules and settings specific to Expo.

What are eslint-config-expo's main functionalities?

Expo-specific ESLint rules

This feature allows developers to extend their ESLint configuration with Expo-specific rules. By adding 'extends': 'expo' to the ESLint configuration file, developers can ensure that their code adheres to best practices and conventions recommended for Expo projects.

{
  "extends": "expo"
}

Integration with React Native

This feature integrates React Native specific linting rules into the Expo configuration. By extending with 'plugin:react-native/all', developers can enforce React Native best practices alongside Expo-specific rules, ensuring a comprehensive linting setup for their mobile applications.

{
  "extends": ["expo", "plugin:react-native/all"]
}

Other packages similar to eslint-config-expo

eslint-config-airbnb

eslint-config-airbnb is a popular ESLint configuration that enforces Airbnb's JavaScript style guide. It is widely used in the JavaScript community for both web and mobile projects. Compared to eslint-config-expo, it provides a more general set of rules that are not specifically tailored for Expo or React Native, but it is highly regarded for its comprehensive and strict style guidelines.

eslint-config-react-app

eslint-config-react-app is the ESLint configuration used by Create React App. It is designed to work seamlessly with React projects, providing a set of rules that ensure code quality and consistency. While it is not specific to Expo, it offers a solid foundation for React projects, including those using React Native, but may require additional customization for Expo-specific needs.

eslint-plugin-react-native

eslint-plugin-react-native provides React Native specific linting rules. It can be used alongside other ESLint configurations to enhance linting for React Native projects. While eslint-config-expo includes some React Native rules, eslint-plugin-react-native offers a more focused set of rules for developers who need additional React Native-specific linting capabilities.

README

eslint-config-expo

Base ESLint config for Expo projects. This is a minimal config that supports JSX and TypeScript, platform-specific global variables, and file extensions like .android.js, .ios.js and .web.js. You are intended to compose this base config with the linter rules of your choice in your own ESLint configuration.

Installation

yarn add --dev eslint-config-expo

You will also need to install eslint:

yarn add --dev eslint

Usage

With flat config (recommended)

Import this config into your configuration file, e.g. eslint.config.js and spread it into the config array.

// eslint.config.js
const expoConfig = require("eslint-config-expo/flat");
const { defineConfig } = require("eslint/config");

module.exports = defineConfig([
  expoConfig,
  // your other config
]);

With legacy config

Import this config into your own ESLint configuration using the extends option. ESLint checks both package.json and .eslintrc.* files for its configuration:

package.json

{
  "eslintConfig": {
    "extends": ["expo"]
  }
}

.eslintrc.js

module.exports = {
  extends: ["expo"],
};