npmpackage.info

@dword-design/eslint-plugin-import-alias

An ESLint plugin that enforces the use of import aliases. Also supports autofixing.

5.1.1

NOASSERTION

JavaScript

345.06 kB

1,737,429 3

Installations

npm install @dword-design/eslint-plugin-import-alias

Developer Guide

BETA

Typescript

No

Module System

ESM

Min. Node Version

>=18

Node Version

20.16.0

NPM Version

10.8.2 Score

85.1

Supply Chain

97.3

Quality

79.5

Maintenance

100

Vulnerability

98.6

License

Pull Requests

Open

6

Total

186

Closed

26

Merged

154

Issues

Open

3

Total

8

Closed

5

Releases

v5.1.1

Published on 18 Aug 2024

v5.1.0

Published on 17 Aug 2024

v5.0.2

Published on 17 Aug 2024

v5.0.1

Published on 14 Aug 2024

v5.0.0

Published on 04 Mar 2024

v4.0.9

Published on 04 Nov 2023

View all 53 releases

Contributors

Unable to fetch Contributors

View all 7 contributors

Languages

JavaScript

Shell

JavaScript (99.45%)

Shell (0.55%)

Developer

dword-design

Download Statistics

Total Downloads

1,737,429

Last Day

5,264

Last Week

18,355

Last Month

188,718

Last Year

1,249,096

GitHub Statistics

70 Stars

263 Commits

11 Forks

2 Watching

6 Branches

7 Contributors

Bundle Size

1.42 MB

Minified

345.06 kB

Minified + Gzipped

Bundlephobia

Sponsor this package

https://github.com/sponsors/dword-design

Maintainers

Package Meta Information

Latest Version

5.1.1

Package Id

@dword-design/eslint-plugin-import-alias@5.1.1

Unpacked Size

13.04 kB

Size

4.82 kB

File Count

NPM Version

10.8.2

Node Version

20.16.0

Publised On

18 Aug 2024

Total Downloads

Cumulative downloads

Total Downloads

1,737,429

Last day

-76%

5,264

Compared to previous day

Last week

-79.2%

18,355

Compared to previous week

Last month

295.4%

188,718

Compared to previous month

Last year

273.9%

1,249,096

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

@babel/core @dword-design/functions babel-plugin-module-resolver deepmerge jiti

Dev Dependencies

@dword-design/base @dword-design/tester @dword-design/tester-plugin-tmp-dir depcheck-package-name eslint execa fs-extra output-files

Versions

@dword-design/eslint-plugin-import-alias

An ESLint plugin that enforces the use of import aliases. Also supports autofixing.

Aliases are a great thing to make imports more readable and you do not have to change import paths that often when a file path is changed.

1import foo from '../../model/sub/foo'
2import bar from '../other/bar'

changes to

1import foo from '@/model/sub/foo'
2import bar from '@/sub/other/bar'

Now what if you are in a bigger team or you have a lot of projects to update. Or you just want to make sure that everything is consistent. This is where a linter comes into the play. This rule allows you to detect inconsistent imports and even autofix them. This works by matching alias paths agains the imports and replacing the import paths with the first matching aliased path.

Install

1# npm
2$ npm install @dword-design/eslint-plugin-import-alias
3
4# Yarn
5$ yarn add @dword-design/eslint-plugin-import-alias

Usage

Add the plugin to your ESLint config:

1{
2  "extends": [
3    "plugin:@dword-design/import-alias/recommended"
4  ],
5}

Alright, now you have to tell the plugin which aliases to use. In the simplest case, you are already using babel-plugin-module-resolver for your aliases. Your babel config would look something like this:

1{
2  "plugins": {
3    ["module-resolver", {
4      "alias": {
5        "@": ".",
6      },
7    }]
8  }
9}

In this case lucky you, you don't have to do anything else. The plugin should work out of the box.

If you have a special project setup that does not have a babel config in the project path, you can still use the plugin by passing the aliases directly to the rule. In this case you define the rule additionally in the rules section:

1"rules": {
2  "@dword-design/import-alias/prefer-alias": [
3    "error",
4    {
5      "alias": {
6        "@": "./src",
7        "@components": "./src/components"
8      }
9    }
10  ]
11}

By default, the plugin will convert parent paths to aliases (like ../model/foo), but will keep subpath imports relative. You can change that to also convert subpaths to aliased imports by passing the aliasForSubpaths option to the rule like so:

1"rules": {
2  "@dword-design/import-alias/prefer-alias": ["error", { "aliasForSubpaths": true }]
3}

Contribute

Are you missing something or want to contribute? Feel free to file an issue or a pull request! ⚙️

Support

Hey, I am Sebastian Landwehr, a freelance web developer, and I love developing web apps and open source packages. If you want to support me so that I can keep packages up to date and build more helpful tools, you can donate here:

If you want to send me a one time donation. The coffee is pretty good 😊.
Also for one time donations if you like PayPal.
Here you can support me regularly, which is great so I can steadily work on projects.

Thanks a lot for your support! ❤️

License

No vulnerabilities found.

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.

9

License

Determines if the project has defined a license.

4

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

2

Maintained

Determines if the project is "actively maintained".

0

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

CII-Best-Practices

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

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

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/build.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/dword-design/eslint-plugin-import-alias/build.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/dword-design/eslint-plugin-import-alias/build.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/dword-design/eslint-plugin-import-alias/build.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:46: update your workflow using https://app.stepsecurity.io/secureworkflow/dword-design/eslint-plugin-import-alias/build.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:55: update your workflow using https://app.stepsecurity.io/secureworkflow/dword-design/eslint-plugin-import-alias/build.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/build.yml:60: update your workflow using https://app.stepsecurity.io/secureworkflow/dword-design/eslint-plugin-import-alias/build.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/build.yml:8: update your workflow using https://app.stepsecurity.io/secureworkflow/dword-design/eslint-plugin-import-alias/build.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/deprecated-dependencies.yml:5: update your workflow using https://app.stepsecurity.io/secureworkflow/dword-design/eslint-plugin-import-alias/deprecated-dependencies.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/deprecated-dependencies.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/dword-design/eslint-plugin-import-alias/deprecated-dependencies.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/deprecated-dependencies.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/dword-design/eslint-plugin-import-alias/deprecated-dependencies.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/deprecated-dependencies.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/dword-design/eslint-plugin-import-alias/deprecated-dependencies.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/deprecated-dependencies.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/dword-design/eslint-plugin-import-alias/deprecated-dependencies.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/sync-labels.yml:5: update your workflow using https://app.stepsecurity.io/secureworkflow/dword-design/eslint-plugin-import-alias/sync-labels.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/sync-labels.yml:8: update your workflow using https://app.stepsecurity.io/secureworkflow/dword-design/eslint-plugin-import-alias/sync-labels.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/sync-metadata.yml:5: update your workflow using https://app.stepsecurity.io/secureworkflow/dword-design/eslint-plugin-import-alias/sync-metadata.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/sync-metadata.yml:6: update your workflow using https://app.stepsecurity.io/secureworkflow/dword-design/eslint-plugin-import-alias/sync-metadata.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/sync-metadata.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/dword-design/eslint-plugin-import-alias/sync-metadata.yml/master?enable=pin
Warn: containerImage not pinned by hash: .gitpod.Dockerfile:2: pin your Docker image by updating gitpod/workspace-full-vnc:latest to gitpod/workspace-full-vnc:latest@sha256:c49f110b8e6260c51c31e8045e0f4b8165a614c65c57f3e6286eb06cad8cab84
Warn: downloadThenRun not pinned by hash: .gitpod.Dockerfile:4
Info: 0 out of 8 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 9 third-party GitHubAction dependencies pinned
Info: 0 out of 1 containerImage dependencies pinned
Info: 0 out of 1 downloadThenRun dependencies pinned

0

SAST

Determines if the project uses static code analysis.

Score

3

/10

Last Scanned on 2025-01-27

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.

Learn More