WordPress/gutenberg

Add linting rule to fail build if package A incorrectly depends on package B

Open

#11,865 opened on Nov 14, 2018

View on GitHub
 (3 comments) (0 reactions) (0 assignees)JavaScript (3,893 forks)batch import
Good First IssueNeeds Dev[Type] Automated Testing[Type] Enhancement

Repository metrics

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

Description

Because we want to avoid cross-dependencies in our packages, it would be helpful if these cross-dependencies were caught by JavaScript linting.

We should add a linting rule that fails the build if package A incorrectly depends on package B.

From https://github.com/WordPress/gutenberg/pull/11409#issuecomment-438695404

Contributor guide

Research direction
Study the existing ESLint configuration in the repository, particularly how other custom rules are defined. Examine the dependency structure between packages to understand what constitutes an incorrect dependency. Then implement a new lint rule that fails the build when such a dependency is detected.
Tech stack
javascript
Domain
toolingdeveloper experience
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaScriptGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70