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 (1,540 forks)batch import
acceptedhelp wantedrule proposalsemver-minorstyle-guide

Repository metrics

Stars
 (4,946 stars)
PR merge metrics
 (Avg merge 138d 22h) (3 merged PRs in 30d)

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

Research direction
Study the existing ESLint rule structure in the eslint plugin import repository, particularly rules like named imports or exports. Implement a new rule that checks for newlines between import specifiers similar to object property newline.
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.
2
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.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaScriptESLint plugin development
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65