Gathering detailed insights and metrics for @the-gear/ts-lib-starter
Gathering detailed insights and metrics for @the-gear/ts-lib-starter
Installations
npm install @the-gear/ts-lib-starterDeveloper Guide
BETA
Typescript
No
Module System
CommonJS
Node Version
11.6.0
NPM Version
6.5.0
Releases
Unable to fetch releases
Languages
2
JavaScript
TypeScript
JavaScript (94.95%)
TypeScript (5.05%)
Developer
the-gear
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
GitHub Statistics
MIT License
2 Stars
255 Commits
1 Watchers
202 Branches
3 Contributors
Updated on May 12, 2021
Maintainers
1
Package Meta Information
Latest Version
6.3.0
Package Id
@the-gear/ts-lib-starter@6.3.0
Unpacked Size
35.40 kB
Size
9.56 kB
File Count
30
NPM Version
6.5.0
Node Version
11.6.0
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Peer Dependencies
1
@the-gear/ts-lib-starter
git clone https://github.com/the-gear/ts-lib-starter LIBNAME && cd $_ && yarn
✨ Features
- creates package for both Node and Browser
- build will creates 4 standard "package" formats:
umd👉 UMD bundle for Node and Browsermainfield in package.jsonesm5👉 transpiled files to ES5 + es2015 modules for tree shakingmodulefield in package.jsonesm2015👉 raw javascript files transpiled from typescript to latest ES standard ( es2018 )es2015field in package.jsonthis is useful if you wanna transpile everything or just wanna ship untranspiled esNext code for evergreen browsers)
fesm👉 experimental bundle type introduced by Angular team (TL;DR: it's an es2015 flattened bundle, like UMD but with latest ECMAscript and JS modules)
- type definitions are automatically generated and shipped with your package
-
typesfield in package.json
-
sideEffects👉 support proper tree-shaking for whole library ( Webpack >= 4). Turn this off or adjust as needed if your modules are not pure!
Start coding in seconds !
git clone https://github.com/the-gear/ts-lib-starter LIBNAME && cd $_yarn
Yes that's it. Happy coding ! 🖖
💉 Consumption of published library:
- install it 🤖
1yarn add my-new-library 2# OR 3npm install my-new-library
- use it 💪
Webpack
NOTE:
Don't forget to turn off ES modules transpilation to enable tree-shaking!
- babel:
{"modules": false}- typescript:
{"module": "esnext"}
1// main.ts or main.js 2import { Greeter } from 'my-new-library'; 3 4const mountPoint = document.getElementById('app'); 5const App = () => { 6 const greeter = new Greeter('Stranger'); 7 return `<h1>${greeter.greet()}</h1>`; 8}; 9const render = (Root: Function, where: HTMLElement) => { 10 where.innerHTML = Root(); 11}; 12 13render(App, mountPoint);
1<!-- index.htm --> 2<html> 3 <head> 4 <script src="bundle.js" async></script> 5 </head> 6 <body> 7 <div id="app"></div> 8 </body> 9</html>
UMD/ES2015 module aware browsers (no bundler)
1<html> 2 <head> 3 <script type="module"> 4 import { Greeter } from './node_modules/my-lib/esm2015/index.js'; 5 6 const mountPoint = document.querySelector('#root'); 7 8 const App = () => { 9 const greeter = new Greeter('Stranger'); 10 return `<h1>${greeter.greet()}</h1>`; 11 }; 12 13 const render = (Root, where) => { 14 where.innerHTML = Root(); 15 }; 16 17 render(App, mountPoint); 18 </script> 19 <script nomodule src="node_modules/my-lib/bundles/my-new-library.umd.min.js"></script> 20 <script nomodule async> 21 var Greeter = MyLib.Greeter; 22 23 var mountPoint = document.querySelector('#root'); 24 25 var App = function() { 26 var greeter = new Greeter('Stranger'); 27 return '<h1>' + greeter.greet() + '</h1>'; 28 }; 29 30 var render = function(Root, where) { 31 where.innerHTML = Root(); 32 }; 33 34 render(App, mountPoint); 35 </script> 36 </head> 37 <body> 38 <div id="root"></div> 39 </body> 40</html>
👨🔧 Technical overview
💅 Style guides
🚀 Publishing
🕵️♀️ Troubleshooting
dynamic import()
This starter uses latest TypeScript >=3.x which has support for lazy loading chunks/modules via import() and also definition acquisition via import('../path-to-module').TypeFoo
Before TS 2.9, it wasn't possible to properly generate ambient definitions if you used dynamic import(). This works now as expected without any hacks ❤️ !
Before TS 2.9
Please note that if you wanna use that feature, compiler will complain because declaration generation is turned on, and currently TS can't handle type generation with types that will be loaded in the future ( lazily )
How to solve this:
- turn of type checking and don't generate types for that lazy import:
import('./components/button') as any- or you can use this temporary workaround
🥂 License
Thanks
This is fork of typescript-lib-starter by Martin Hochel. Thank you! 🏅
- diff Hotell/typescript-lib-starter ← :gear: ts-lib-starter — local changes
- diff :gear: ts-lib-starter ← Hotell/typescript-lib-starter — Martin's new stuff
Other TypeScript Starters
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE.md:0
- Info: FSF or OSI recognized license: MIT License: LICENSE.md:0
Reason
Found 0/6 approved changesets -- score normalized to 0
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
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
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'ts-lib-starter'
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 26 are checked with a SAST tool
Reason
70 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-6chw-6frg-f759
- Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
- 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-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
- Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
- Warn: Project is vulnerable to: GHSA-ff7x-qrg7-qggm
- Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3
- Warn: Project is vulnerable to: MAL-2023-462
- Warn: Project is vulnerable to: GHSA-ww39-953v-wcq6
- Warn: Project is vulnerable to: GHSA-w457-6q6x-cgp9
- Warn: Project is vulnerable to: GHSA-62gr-4qp9-h98f
- Warn: Project is vulnerable to: GHSA-f52g-6jhx-586p
- Warn: Project is vulnerable to: GHSA-2cf5-4w76-r9qv
- Warn: Project is vulnerable to: GHSA-3cqr-58rm-57f8
- Warn: Project is vulnerable to: GHSA-g9r4-xpmj-mj65
- Warn: Project is vulnerable to: GHSA-q2c6-c6pm-g3gh
- Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44
- Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988
- Warn: Project is vulnerable to: GHSA-vfrc-7r7c-w9mx
- Warn: Project is vulnerable to: GHSA-7wwv-vh3v-89cq
- Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
- Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
- Warn: Project is vulnerable to: GHSA-gxr4-xjj5-5px2
- Warn: Project is vulnerable to: GHSA-jpcq-cgw6-v4j6
- Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
- Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
- Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp
- Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
- Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
- Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
- Warn: Project is vulnerable to: GHSA-5v2h-r2cx-5xgj
- Warn: Project is vulnerable to: GHSA-rrrm-qjm4-v8hf
- Warn: Project is vulnerable to: GHSA-7wpw-2hjm-89gp
- 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-5fw9-fq32-wv5p
- Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
- Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
- Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
- Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-h9rv-jmmf-4pgx
- Warn: Project is vulnerable to: GHSA-hxcc-f52p-wc94
- Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6
- Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj
- Warn: Project is vulnerable to: GHSA-7xcx-6wjh-7xp2
- 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-4wf5-vphf-c2xc
- 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-cf4h-3jhx-xvhq
- Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
- Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693
- Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
- Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
- Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp
Score
1.7
/10
Last Scanned on 2025-06-30
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