Book a Demo!
CoCalc Logo Icon
StoreFeaturesDocsShareSupportNewsAboutPoliciesSign UpSign In
epidemian
GitHub Repository: epidemian/eslint-plugin-import
Path: blob/main/docs/rules/newline-after-import.md
829 views

import/newline-after-import

Enforces having one or more empty lines after the last top-level import statement or require call. +(fixable) The --fix option on the [command line] automatically fixes problems reported by this rule.

Rule Details

This rule has one option, count which sets the number of newlines that are enforced after the last top-level import statement or require call. This option defaults to 1.

Valid:

import defaultExport from './foo' const FOO = 'BAR'
import defaultExport from './foo' import { bar } from 'bar-lib' const FOO = 'BAR'
const FOO = require('./foo') const BAR = require('./bar') const BAZ = 1

Invalid:

import * as foo from 'foo' const FOO = 'BAR'
import * as foo from 'foo' const FOO = 'BAR' import { bar } from 'bar-lib'
const FOO = require('./foo') const BAZ = 1 const BAR = require('./bar')

With count set to 2 this will be considered valid:

import defaultExport from './foo' const FOO = 'BAR'

With count set to 2 these will be considered invalid:

import defaultExport from './foo' const FOO = 'BAR'
import defaultExport from './foo' const FOO = 'BAR'

Example options usage

{ "rules": { "import/newline-after-import": ["error", { "count": 2 }] } }

When Not To Use It

If you like to visually group module imports with its usage, you don't want to use this rule.