bcherny/tslint-no-circular-imports

The plugin crashes if you export './index'

Open

#17 opened on Jul 18, 2018

View on GitHub
 (0 comments) (3 reactions) (0 assignees)TypeScript (11 forks)github user discovery
bughelp wanted

Repository metrics

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

Description

I was just using the plugin and I had an index file which contained the following line by mistake.

export * from './index'

This code crashes the plugin with the following error:

TypeError: Cannot read property 'getStart' of undefined

I have created a project which demonstrates the bug here: https://github.com/w0rp/no-circular-import-index-error

You can run yarn && node_modules/.bin/tslint -p . on that project to see the error, or you can create a similar file and try it yourself. I think that bug should be fixed, and it should be reported as an error.

Contributor guide

Research direction
Investigate the code that handles export statements in imports resolver; specifically, add a check for circular self imports (export * from './index') and handle gracefully instead of crashing with 'getStart' undefined error.
Tech stack
typescript
Domain
devtools
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
TypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75