bcherny/tslint-no-circular-imports

Ignoring interfaces?

Open

#19 opened on Aug 4, 2018

View on GitHub
 (2 comments) (5 reactions) (0 assignees)TypeScript (11 forks)github user discovery
enhancementhelp wanted

Repository metrics

Stars
 (90 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Yo! This is a great plugin - helps me avoid some hard-to-track bugs!

Is there any way we could have an option to ignore interfaces / types? Circular references between interfaces do not cause runtime issues and my project has a few that are hard to get rid of!

Contributor guide

Research direction
Add a configuration option to ignore circular references that only involve interfaces/types. Modify the rule's logic to skip imports that are purely type only imports (e.g., using 'import type' or when the imported member is an interface/type). Update documentation to explain the new option.
Tech stack
typescript
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.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
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
TypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90