noReactNativeDeepImports (JavaScript)

Language JavaScript (and super languages)

Summary

Rule available since: v2.4.13
Diagnostic Category: lint/suspicious/noReactNativeDeepImports
This rule is recommended, meaning it is enabled by default.
This rule doesn’t have a fix.
The default severity of this rule is error.
This rule belongs to the following domains:
- reactNative
Sources:
- Same as @react-native/no-deep-imports

How to configure

1
{
2
  "linter": {
3
    "rules": {
4
      "suspicious": {
5
        "noReactNativeDeepImports": "error"
6
      }
7
    }
8
  }
9
}

Description

Disallow deep imports from the react-native package.

Deep imports reach into React Native’s internal file structure, which is not part of the public API. Internal paths can change between versions without warning, breaking code that depends on them.

Examples

Invalid

1
import View from "react-native/Libraries/Components/View/View";

code-block.js:1:18 lint/suspicious/noReactNativeDeepImports ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ✖ Deep imports from react-native are not allowed.
  
  > 1 │ import View from "react-native/Libraries/Components/View/View";
      │                  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    2 │ 
  
  ℹ React Native's internal file structure is not part of the public API and may change between versions without warning.
  
  ℹ Import from the top-level react-native entry point instead.

1
const Platform = require("react-native/Libraries/Utilities/Platform");

code-block.js:1:26 lint/suspicious/noReactNativeDeepImports ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ✖ Deep imports from react-native are not allowed.
  
  > 1 │ const Platform = require("react-native/Libraries/Utilities/Platform");
      │                          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    2 │ 
  
  ℹ React Native's internal file structure is not part of the public API and may change between versions without warning.
  
  ℹ Import from the top-level react-native entry point instead.

1
const View = require("react-native/Libraries/Components/View/View");

code-block.js:1:22 lint/suspicious/noReactNativeDeepImports ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ✖ Deep imports from react-native are not allowed.
  
  > 1 │ const View = require("react-native/Libraries/Components/View/View");
      │                      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    2 │ 
  
  ℹ React Native's internal file structure is not part of the public API and may change between versions without warning.
  
  ℹ Import from the top-level react-native entry point instead.

1
import("react-native/Libraries/Utilities/Platform");

code-block.js:1:8 lint/suspicious/noReactNativeDeepImports ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ✖ Deep imports from react-native are not allowed.
  
  > 1 │ import("react-native/Libraries/Utilities/Platform");
      │        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    2 │ 
  
  ℹ React Native's internal file structure is not part of the public API and may change between versions without warning.
  
  ℹ Import from the top-level react-native entry point instead.

Valid

1
import { View } from "react-native";

1
const { Platform } = require("react-native");