import-js/eslint-plugin-import

No errors for TypeScript `import` types

Open

#1,675 opened on Mar 3, 2020

View on GitHub
 (7 comments) (0 reactions) (0 assignees)JavaScript (1,540 forks)batch import
enhancementhelp wantedtypescript

Repository metrics

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

Description

Docs on import types: https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-9.html#import-types

Reduced test case (all dependencies are latest):

// ./cypress/test.ts

// Expected error, got one
// Unexpected path "../app/helpers/api" imported in restricted zone
import Api from '../app/helpers/api';

// Expected error, but got none
type Api = typeof import('../app/helpers/api');

// .eslintrc.js
const config = {
  extends: ['plugin:import/typescript'],
  parser: '@typescript-eslint/parser',
  parserOptions: {
    ecmaVersion: 6,
    sourceType: 'module',
  },
  plugins: ['import'],
  rules: {
    'import/no-restricted-paths': [
      2,
      {
        basePath: '.',
        zones: [
          {
            target: './cypress',
            from: './app',
          },
        ],
      },
    ],
  },
}

module.exports = config;

Contributor guide

Research direction
Investigate the `import/no restricted paths` rule to see if it handles `TSImportType` AST nodes. The rule likely only processes `ImportDeclaration` nodes, missing `TSImportType` used in `typeof import(...)`. To fix, extend the rule to also check `TSImportType` nodes and extract the module source. Check the rule implementation in `src/rules/no restricted paths.js` and look for handling of `ImportExpression` or `TSImportType`.
Tech stack
javascripttypescriptnodejs
Domain
toolingdeveloper experience
Issue type
Bug
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.
3-5 days
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
ESLintTypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40