Permalink
Cannot retrieve contributors at this time
118 lines (80 sloc)
2.13 KB
Name already in use
A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
codeql-action/node_modules/eslint-plugin-import/docs/rules/newline-after-import.md
Go to fileThis commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# import/newline-after-import | |
🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix). | |
<!-- end auto-generated rule header --> | |
Enforces having one or more empty lines after the last top-level import statement or require call. | |
## Rule Details | |
This rule supports the following options: | |
- `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`. | |
- `considerComments` which enforces the rule on comments after the last import-statement as well when set to true. This option defaults to `false`. | |
Valid: | |
```js | |
import defaultExport from './foo' | |
const FOO = 'BAR' | |
``` | |
```js | |
import defaultExport from './foo' | |
import { bar } from 'bar-lib' | |
const FOO = 'BAR' | |
``` | |
```js | |
const FOO = require('./foo') | |
const BAR = require('./bar') | |
const BAZ = 1 | |
``` | |
Invalid: | |
```js | |
import * as foo from 'foo' | |
const FOO = 'BAR' | |
``` | |
```js | |
import * as foo from 'foo' | |
const FOO = 'BAR' | |
import { bar } from 'bar-lib' | |
``` | |
```js | |
const FOO = require('./foo') | |
const BAZ = 1 | |
const BAR = require('./bar') | |
``` | |
With `count` set to `2` this will be considered valid: | |
```js | |
import defaultExport from './foo' | |
const FOO = 'BAR' | |
``` | |
With `count` set to `2` these will be considered invalid: | |
```js | |
import defaultExport from './foo' | |
const FOO = 'BAR' | |
``` | |
```js | |
import defaultExport from './foo' | |
const FOO = 'BAR' | |
``` | |
With `considerComments` set to `false` this will be considered valid: | |
```js | |
import defaultExport from './foo' | |
// some comment here. | |
const FOO = 'BAR' | |
``` | |
With `considerComments` set to `true` this will be considered valid: | |
```js | |
import defaultExport from './foo' | |
// some comment here. | |
const FOO = 'BAR' | |
``` | |
With `considerComments` set to `true` this will be considered invalid: | |
```js | |
import defaultExport from './foo' | |
// some comment here. | |
const FOO = 'BAR' | |
``` | |
## Example options usage | |
```json | |
{ | |
"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. |