Gathering detailed insights and metrics for babel-plugin-tsconfig-paths-module-resolver
Gathering detailed insights and metrics for babel-plugin-tsconfig-paths-module-resolver
Installations
npm install babel-plugin-tsconfig-paths-module-resolverDeveloper
ricokahler
Developer Guide
BETA
Module System
CommonJS, ESM
Min. Node Version
Typescript Support
Yes
Node Version
18.13.0
NPM Version
7.21.1
Statistics
40 Stars
58 Commits
2 Forks
2 Watching
7 Branches
2 Contributors
Updated on 01 Nov 2024
Bundle Size
107.87 kB
Minified
31.50 kB
Minified + Gzipped
Languages
TypeScript (94.89%)
JavaScript (3.42%)
Shell (1.69%)
Total Downloads
Cumulative downloads
Total Downloads
1,011,894
Last day
-3.2%
2,833
Compared to previous day
Last week
8.4%
15,659
Compared to previous week
Last month
29%
63,756
Compared to previous month
Last year
84.2%
574,955
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
2
Dev Dependencies
19
@babel/cli@babel/core@babel/preset-env@babel/preset-typescript@types/jest@typescript-eslint/eslint-plugin@typescript-eslint/parserbabel-eslinteslinteslint-config-react-appeslint-plugin-flowtypeeslint-plugin-importeslint-plugin-jsx-a11yeslint-plugin-reacteslint-plugin-react-hooksjestprettiersemantic-releasetypescript
Versions
babel-plugin-tsconfig-paths-module-resolver
Combines
babel-plugin-module-resolverandtsconfig-pathsto make a babel plugin that resolves tsconfig paths.Use tsconfig-paths in any bundler that supports a custom babel config.
This library is a re-export of babel-plugin-module-resolver pre-configured with tsconfig paths support via the package tsconfig-paths.
It aims to be stable by relying on these already widely-used packages to power the heavy logic:
| dependency | weekly downloads |
|---|---|
babel-plugin-module-resolver | |
tsconfig-paths |
These dependencies are automatically updated via renovate bot and semantic release.
How is this different from babel-plugin-tsconfig-paths?
- It does less — as stated above, this library depends on battled tested libs (
tsconfig-pathsandbabel-plugin-module-resolver) to do the actual logic. The source code for this library is around ~100 SLOC which makes it easy to test and maintain. - It re-exports
babel-plugin-module-resolver— giving you all the features of that babel plugin including custom resolve functions.
Installation
npm install --save-dev babel-plugin-tsconfig-paths-module-resolver
or
yarn add --dev babel-plugin-tsconfig-paths-module-resolver
Specify the plugin in your .babelrc (or equivalent configuration file).
1{ 2 "presets": [ 3 // ... 4 "@babel/preset-typescript", 5 // ... 6 ], 7 "plugins": [ 8 // add this to your babel config file in `plugins` 9 // 👇👇👇 10 "tsconfig-paths-module-resolver" 11 // 👆👆👆 12 // ... 13 ] 14}
That's it! Paths from your tsconfig.json should now work!
Advanced usage
babel-plugin-tsconfig-paths-module-resolver accepts the same options as babel-plugin-module-resolver.
You can supply those extra options in your babel configuration file like so:
1{ 2 "presets": [ 3 // ... 4 "@babel/preset-typescript", 5 // ... 6 ], 7 "plugins": [ 8 // ... 9 [ 10 "tsconfig-paths-module-resolver", 11 // add extra options here 12 // 👇👇👇 13 { 14 // see here: 15 // https://github.com/tleunen/babel-plugin-module-resolver/blob/master/DOCS.md 16 } 17 // 👆👆👆 18 ] 19 ] 20};
resolvePath and createResolvePath
babel-plugin-module-resolver includes a configuration option to allow you to programmatically resolve your imports.
This plugin provides a resolvePath implementation powered by tsconfig-paths. If you'd like to implement your own resolvePath implementation while still utilizing this plugin's default implementation, you can separately import createResolvePath that returns a resolvePath implementation.
1const createResolvePath = require('babel-plugin-tsconfig-paths-module-resolver/create-resolve-path'); 2const defaultResolvePath = createResolvePath(); 3 4/** 5 * @param sourceFile {string} the input source path 6 * @param currentFile {string} the absolute path of the current file 7 * @param opts {any} the options as passed to the Babel config 8 * @return {string} 9 */ 10function customResolvePath(sourceFile, currentFile, opts) { 11 // ... 12 const result = defaultResolvePath(sourceFile, currentFile, opts); 13 // ... 14 15 return result; 16} 17 18// .babelrc.js 19module.exports = { 20 presets: [ 21 // ... 22 '@babel/preset-typescript', 23 // ... 24 ], 25 plugins: [ 26 // ... 27 [ 28 'tsconfig-paths-module-resolver', 29 { 30 // 👇👇👇 31 resolvePath: customResolvePath, 32 // 👆👆👆 33 }, 34 ], 35 ], 36};
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
packaging workflow detected
Details
- Info: Project packages its releases by way of GitHub Actions.: .github/workflows/release.yml:9
Reason
5 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 4
Reason
dependency not pinned by hash detected -- score normalized to 3
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/ricokahler/babel-plugin-tsconfig-paths-module-resolver/release.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/ricokahler/babel-plugin-tsconfig-paths-module-resolver/release.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/ricokahler/babel-plugin-tsconfig-paths-module-resolver/release.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/ricokahler/babel-plugin-tsconfig-paths-module-resolver/test.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/ricokahler/babel-plugin-tsconfig-paths-module-resolver/test.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/ricokahler/babel-plugin-tsconfig-paths-module-resolver/test.yml/main?enable=pin
- Warn: npmCommand not pinned by hash: .github/workflows/release.yml:25
- Warn: npmCommand not pinned by hash: .github/workflows/test.yml:22
- Info: 0 out of 4 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 2 third-party GitHubAction dependencies pinned
- Info: 2 out of 4 npmCommand dependencies pinned
Reason
Found 0/30 approved changesets -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/release.yml:1
- Warn: no topLevel permission defined: .github/workflows/test.yml:1
- Info: no jobLevel write permissions found
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 30 are checked with a SAST tool
Reason
10 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
- Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v
- Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
- Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
- Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Score
3.8
/10
Last Scanned on 2024-11-18
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