import-js/eslint-plugin-import

Add equivalent of object-property-newline for import declaration

Open

#344 opened on May 15, 2016

View on GitHub
 (8 comments) (31 reactions) (0 assignees)JavaScript (4,946 stars) (1,540 forks)batch import
acceptedhelp wantedrule proposalsemver-minorstyle-guide

Description

object-property-newline

While formatting preferences are very personal, a number of style guides require that object properties be placed on separate lines for better readability. Another argument in favor of this style is that it improves the readability of diffs when a property is changed:

Examples of incorrect code for this rule:

import {createMovieMatcher,matcher} from './../src/movieRecognizer';

Examples of correct code for this rule:

import {
    createMovieMatcher,
    matcher
} from './../src/movieRecognizer';

Contributor guide

Tech stack
javascript
Domain
tooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
ESLint rule developmentAST knowledge
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
Start by reviewing the implementation of the object property newline rule in the eslint plugin import repository to understand the pattern. Then create a new rule file following the same structure, using the rule API to check import declaration nodes for line breaks between specifiers. Reference the existing rule for parsing AST nodes and generating appropriate violation messages.