WordPress/gutenberg

ESLint Plugin: @wordpress/dependency-group wrong grouping with fixer

Open

#17,050 opened on Aug 15, 2019

View on GitHub
 (4 comments) (0 reactions) (0 assignees)JavaScript (3,893 forks)batch import
Good First IssueNeeds Dev[Priority] Low[Tool] ESLint plugin[Type] Enhancement

Repository metrics

Stars
 (9,607 stars)
PR merge metrics
 (Avg merge 12d 18h) (509 merged PRs in 30d)

Description

Describe the bug I have this sample import statements:

import { format } from '@wordpress/date'
import { pickBy } from 'lodash'
import { PanelBody } from '@wordpress/components'

Running wp-scripts lint-js --fix on this groups together the dependencies, but doesn't rearrange the location so I end up with:

/**
 * WordPress dependencies
 */
import { format } from '@wordpress/date'

/**
 * External dependencies
 */
import { pickBy } from 'lodash'
import { PanelBody } from '@wordpress/components'

You'll have to manually move the @wordpress/* dependencies together.

Expected behavior The @wordpress/* / External / Internal dependencies would be sorted and grouped together.

Desktop (please complete the following information): Relevant part of my devDependencies:

"devDependencies": {
    "@wordpress/eslint-plugin": "^2.4.0",
    "eslint": "^6.1.0"
}

Contributor guide

Research direction
Inspect the ESLint plugin's dependency group rule and fixer logic to ensure imports are sorted and grouped correctly.
Tech stack
javascript
Domain
tooling
Issue type
Bug
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.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaScriptESLint
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50