Gathering detailed insights and metrics for babel-plugin-transform-typescript-metadata
Gathering detailed insights and metrics for babel-plugin-transform-typescript-metadata
Babel plugin to emit decorator metadata like typescript compiler
Installations
npm install babel-plugin-transform-typescript-metadataDeveloper Guide
BETA
Typescript
No
Module System
CommonJS
Node Version
12.16.3
NPM Version
6.14.4
Score
99.3
Supply Chain
99
Quality
75.5
Maintenance
100
Vulnerability
100
License
Releases
8
Languages
2
JavaScript
TypeScript
JavaScript (53.52%)
TypeScript (46.48%)
Developer
leonardfactory
Download Statistics
Total Downloads
191,492,693
Last Day
69,352
Last Week
2,004,273
Last Month
8,511,378
Last Year
86,443,358
GitHub Statistics
MIT License
218 Stars
82 Commits
17 Forks
3 Watchers
8 Branches
4 Contributors
Updated on Mar 03, 2025
Bundle Size
7.00 kB
Minified
2.37 kB
Minified + Gzipped
Maintainers
1
Package Meta Information
Latest Version
0.3.2
Package Id
babel-plugin-transform-typescript-metadata@0.3.2
Size
9.10 kB
NPM Version
6.14.4
Node Version
12.16.3
Published on
Mar 19, 2021
Total Downloads
Cumulative downloads
Total Downloads
191,492,693
Last Day
7.5%
69,352
Compared to previous day
Last Week
-5.8%
2,004,273
Compared to previous week
Last Month
2.6%
8,511,378
Compared to previous month
Last Year
45.6%
86,443,358
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
1
Dev Dependencies
19
@babel/cli@babel/core@babel/plugin-proposal-class-properties@babel/plugin-proposal-decorators@babel/plugin-transform-modules-commonjs@babel/preset-env@babel/preset-typescript@babel/template@babel/types@favoloso/conventional-changelog-emoji@release-it/conventional-changelog@types/jestbabel-testconventional-changelog-clihuskyjestjest-file-snapshotrelease-ittypescript
babel-plugin-transform-typescript-metadata
Babel plugin to emit decorator metadata like typescript compiler
Motivation
TypeScript Decorators allows advanced reflection patterns when combined
with Reflect.metadata output.
Current @babel/preset-typescript implementation however just strips all types and
does not emit the relative Metadata in the output code.
Since this kind of information is used extensively in libraries like
Nest and TypeORM
to implement advanced features like Dependency Injection, I've thought it would
be awesome to be able to provide the same functionality that TypeScript
compiler experimentalDecorators and emitDecoratorMetadata
flags provide.
This means that code like:
1import { Injectable, Inject } from 'some-di-library'; // Just an example 2import { MyService } from './MyService'; 3import { Configuration } from './Configuration'; 4 5@Injectable() 6class AnotherService { 7 @Inject() 8 config: Configuration; 9 10 constructor(private service: MyService) {} 11}
will be interpreted like:
1import { MyService } from './MyService'; 2import { Configuration } from './Configuration'; 3 4@Injectable() 5@Reflect.metadata('design:paramtypes', [MyService]) 6class AnotherService { 7 @Inject() 8 @Reflect.metadata('design:type', Configuration) 9 config: Configuration; 10 11 constructor(private service: MyService) {} 12}
Parameter decorators
Since decorators in typescript supports also Parameters, this plugin also provides support for them, enabling the following syntax:
1@Injectable() 2class Some { 3 constructor(@Inject() private: SomeService); 4}
This will be roughly translated to:
1// ... 2Inject()(Some.prototype, undefined, 0);
Installation
With npm:
1npm install --dev --save babel-plugin-transform-typescript-metadata
or with Yarn:
1yarn add --dev babel-plugin-transform-typescript-metadata
Usage
With .babelrc:
Note: should be placed before
@babel/plugin-proposal-decorators.
1{ 2 "plugins": [ 3 "babel-plugin-transform-typescript-metadata", 4 ["@babel/plugin-proposal-decorators", { "legacy": true }], 5 ["@babel/plugin-proposal-class-properties", { "loose": true }], 6 ], 7 "presets": [ 8 "@babel/preset-typescript" 9 ] 10}
Usage with InversifyJS
If you are using normal dependency injection letting Inversify create your instances, you should be fine with all kind of decorators.
Instead, if you are using property injection, when the container does not create the instances, you would likely encounter errors since babel decorators are not exactly the same as TypeScript.
You can fix it by enhancing property decorators with the following function:
1import getDecorators from 'inversify-inject-decorators'; 2// setup the container... 3let { lazyInject: originalLazyInject } = getDecorators(container); 4 5// Additional function to make properties decorators compatible with babel. 6function fixPropertyDecorator<T extends Function>(decorator: T): T { 7 return ((...args: any[]) => ( 8 target: any, 9 propertyName: any, 10 ...decoratorArgs: any[] 11 ) => { 12 decorator(...args)(target, propertyName, ...decoratorArgs); 13 return Object.getOwnPropertyDescriptor(target, propertyName); 14 }) as any; 15} 16 17export const lazyInject = fixPropertyDecorator(originalLazyInject);
Current Pitfalls
-
If you are using webpack and it complains about missing exports due to types not being removed, you can switch from
import { MyType } from ...toimport type { MyType } from .... See #46 for details and examples. -
We cannot know if type annotations are just types (i.e.
IMyInterface) or concrete values (like classes, etc.). In order to resolve this, we emit the following:typeof Type === 'undefined' ? Object : Type. The code has the advantage of not throwing. If you know a better way to do this, let me know!
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
Found 4/14 approved changesets -- score normalized to 2
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/test.yml:1
- Info: no jobLevel write permissions found
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/leonardfactory/babel-plugin-transform-typescript-metadata/test.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/leonardfactory/babel-plugin-transform-typescript-metadata/test.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/leonardfactory/babel-plugin-transform-typescript-metadata/test.yml/master?enable=pin
- Info: 0 out of 2 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 1 third-party GitHubAction dependencies pinned
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 22 are checked with a SAST tool
Reason
58 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8
- Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
- Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
- Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-w8qv-6jwh-64r5
- Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
- Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
- Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3
- Warn: Project is vulnerable to: MAL-2023-462
- Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
- Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
- Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp
- Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
- Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
- Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m
- Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
- Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-4g88-fppr-53pp
- Warn: Project is vulnerable to: GHSA-4jqc-8m5r-9rpr
- Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
- Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw
- Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc
- Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
- Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p
- Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
- Warn: Project is vulnerable to: GHSA-h5c3-5r3r-rr8q
- Warn: Project is vulnerable to: GHSA-rmvr-2pp2-xj38
- Warn: Project is vulnerable to: GHSA-xx4v-prfh-6cgc
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-ww39-953v-wcq6
- Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97
- Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44
- Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988
- Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
- Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j
- Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g
- Warn: Project is vulnerable to: GHSA-px4h-xg32-q955
- Warn: Project is vulnerable to: GHSA-3j8f-xvm3-ffx4
- Warn: Project is vulnerable to: GHSA-4p35-cfcx-8653
- Warn: Project is vulnerable to: GHSA-7f3x-x4pr-wqhj
- Warn: Project is vulnerable to: GHSA-jpp7-7chh-cf67
- Warn: Project is vulnerable to: GHSA-q6wq-5p59-983w
- Warn: Project is vulnerable to: GHSA-j9fq-vwqv-2fm2
- Warn: Project is vulnerable to: GHSA-pqw5-jmp5-px4v
- Warn: Project is vulnerable to: GHSA-44c6-4v22-4mhx
- Warn: Project is vulnerable to: GHSA-4x5v-gmq8-25ch
- Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6
- Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj
- Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v
- Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
- Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v
- Warn: Project is vulnerable to: GHSA-38fc-wpqx-33j7
- Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
- Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Score
3
/10
Last Scanned on 2025-06-23
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