npmpackage.info

Gathering detailed insights and metrics for eslint-import-resolver-typescript

Gathering detailed insights and metrics for eslint-import-resolver-typescript

eslint-import-resolver-typescript

This plugin adds `TypeScript` support to `eslint-plugin-import`

3.6.3

731

ISC

TypeScript

60.18 kB

931,476,632 5.1

Installations

npm install eslint-import-resolver-typescript

Score

55.3

Supply Chain

89.6

Quality

78.5

Maintenance

100

Vulnerability

97.6

License

Pull Requests

Open

1

Total

164

Closed

20

Merged

143

Issues

Open

25

Total

157

Closed

132

Releases

38

v3.6.3

Published on 26 Aug 2024

v3.6.1

Published on 22 Sept 2023

v3.6.0

Published on 09 Aug 2023

v3.5.5

Published on 05 Apr 2023

v3.5.4

Published on 29 Mar 2023

v3.5.3

Published on 11 Jan 2023

View all 38 releases

Developer

Developer Guide

BETA

Module System

ESM

Min. Node Version

^14.18.0 || >=16.0.0

Typescript Support

Yes

Node Version

20.16.0

NPM Version

10.8.1

Statistics

731 Stars

243 Commits

62 Forks

4 Watching

3 Branches

38 Contributors

Updated on 21 Nov 2024

Bundle Size

206.24 kB

Minified

60.18 kB

Minified + Gzipped

Bundlephobia

Languages

TypeScript (70.88%)

JavaScript (29.12%)

Total Downloads

Cumulative downloads

Total Downloads

931,476,632

Last day

-6.7%

1,871,255

Compared to previous day

Last week

2.9%

10,080,663

Compared to previous week

Last month

11.9%

42,364,256

Compared to previous month

Last year

42.8%

415,478,400

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

eslint-import-resolver-typescript

This plugin adds TypeScript support to eslint-plugin-import (Or maybe you want to try eslint-plugin-i for faster speed)

This means you can:

import/require files with extension .cts/.mts/.ts/.tsx/.d.cts/.d.mts/.d.ts
Use paths defined in tsconfig.json
Prefer resolving @types/* definitions over plain .js/.jsx
Multiple tsconfigs support just like normal
imports/exports fields support in package.json

TOC

Notice
Installation
Configuration
Options from enhanced-resolve
- conditionNames
- extensions
- extensionAlias
- mainFields
- Other options
- Default options
Contributing
Sponsors
Backers
Changelog
License

Notice

After version 2.0.0, .d.ts will take higher priority then normal .js/.jsx files on resolving node_modules packages in favor of @types/* definitions or its own definition.

If you're facing some problems on rules import/default or import/named from eslint-plugin-import, do not post any issue here, because they are just working exactly as expected on our sides, take import-js/eslint-plugin-import#1525 as reference or post a new issue to eslint-plugin-import instead.

Installation

1# npm
2npm i -D eslint-plugin-import eslint-import-resolver-typescript
3
4# pnpm
5pnpm i -D eslint-plugin-import eslint-import-resolver-typescript
6
7# yarn
8yarn add -D eslint-plugin-import eslint-import-resolver-typescript

Important when using eslint-plugin-i and npm: Use npm i -D eslint-plugin-import@eslint-plugin-i@latest eslint-import-resolver-typescript, or you will end up with both eslint-plugin-import and eslint-plugin-i in your node_modules.

Configuration

Add the following to your .eslintrc config:

1{
2  "plugins": ["import"],
3  "rules": {
4    // turn on errors for missing imports
5    "import/no-unresolved": "error"
6  },
7  "settings": {
8    "import/parsers": {
9      "@typescript-eslint/parser": [".ts", ".tsx"]
10    },
11    "import/resolver": {
12      "typescript": {
13        "alwaysTryTypes": true, // always try to resolve types under `<root>@types` directory even it doesn't contain any source code, like `@types/unist`
14
15        // Choose from one of the "project" configs below or omit to use <root>/tsconfig.json by default
16
17        // use <root>/path/to/folder/tsconfig.json
18        "project": "path/to/folder",
19
20        // Multiple tsconfigs (Useful for monorepos)
21
22        // use a glob pattern
23        "project": "packages/*/tsconfig.json",
24
25        // use an array
26        "project": [
27          "packages/module-a/tsconfig.json",
28          "packages/module-b/tsconfig.json"
29        ],
30
31        // use an array of glob patterns
32        "project": [
33          "packages/*/tsconfig.json",
34          "other-packages/*/tsconfig.json"
35        ]
36      }
37    }
38  }
39}

Options from `enhanced-resolve`

`conditionNames`

Default:

1[
2  "types",
3  "import",
4
5  // APF: https://angular.io/guide/angular-package-format
6  "esm2020",
7  "es2020",
8  "es2015",
9
10  "require",
11  "node",
12  "node-addons",
13  "browser",
14  "default"
15]

`extensions`

Default:

1[
2  // `.mts`, `.cts`, `.d.mts`, `.d.cts`, `.mjs`, `.cjs` are not included because `.cjs` and `.mjs` must be used explicitly
3  ".ts",
4  ".tsx",
5  ".d.ts",
6  ".js",
7  ".jsx",
8  ".json",
9  ".node"
10]

`extensionAlias`

Default:

1{
2  ".js": [
3    ".ts",
4    // `.tsx` can also be compiled as `.js`
5    ".tsx",
6    ".d.ts",
7    ".js"
8  ],
9  ".jsx": [".tsx", ".d.ts", ".jsx"],
10  ".cjs": [".cts", ".d.cts", ".cjs"],
11  ".mjs": [".mts", ".d.mts", ".mjs"]
12}

`mainFields`

Default:

1[
2  "types",
3  "typings",
4
5  // APF: https://angular.io/guide/angular-package-format
6  "fesm2020",
7  "fesm2015",
8  "esm2020",
9  "es2020",
10
11  "module",
12  "jsnext:main",
13
14  "main"
15]

Other options

You can pass through other options of enhanced-resolve directly

Default options

You can reuse defaultConditionNames, defaultExtensions, defaultExtensionAlias and defaultMainFields by require/import them directly

Contributing

Make sure your change is covered by a test import.
Make sure that yarn test passes without a failure.
Make sure that yarn lint passes without conflicts.
Make sure your code changes match our type-coverage settings: yarn type-coverage.

We have GitHub Actions which will run the above commands on your PRs.

If either fails, we won't be able to merge your PR until it's fixed.

Sponsors

1stG	RxTS	UnTS

Backers

1stG	RxTS	UnTS

Changelog

Detailed changes for each release are documented in CHANGELOG.md.

License

Empty State

No vulnerabilities found.

10

Maintained

Determines if the project is "actively maintained".

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

9

Security-Policy

Determines if the project has published a security policy.

9

SAST

Determines if the project uses static code analysis.

1

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 0

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/import-js/eslint-import-resolver-typescript/ci.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/import-js/eslint-import-resolver-typescript/ci.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/import-js/eslint-import-resolver-typescript/ci.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/import-js/eslint-import-resolver-typescript/codeql.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/import-js/eslint-import-resolver-typescript/codeql.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:39: update your workflow using https://app.stepsecurity.io/secureworkflow/import-js/eslint-import-resolver-typescript/codeql.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/import-js/eslint-import-resolver-typescript/codeql.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/import-js/eslint-import-resolver-typescript/release.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/import-js/eslint-import-resolver-typescript/release.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/import-js/eslint-import-resolver-typescript/release.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/size-limit.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/import-js/eslint-import-resolver-typescript/size-limit.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/size-limit.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/import-js/eslint-import-resolver-typescript/size-limit.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/size-limit.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/import-js/eslint-import-resolver-typescript/size-limit.yml/master?enable=pin
Info: 0 out of 11 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 2 third-party GitHubAction dependencies pinned

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

5.1

/10

Last Scanned on 2024-11-25

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.