Gathering detailed insights and metrics for ts-deps
Gathering detailed insights and metrics for ts-deps
TypeScript related dependencies and libraries to setup typical build/lint/format/test pipeline and CI/CD pipeline using babel, jest, prettier, tslint and semantic-release. Meant to be added as dev dependency.
Installations
npm install ts-depsDeveloper Guide
BETA
Typescript
No
Module System
CommonJS
Min. Node Version
>= 12.18.4
Node Version
15.0.1
NPM Version
6.14.8
Releases
101
Languages
2
JavaScript
TypeScript
JavaScript (76.27%)
TypeScript (23.73%)
Developer
Aimee-Blue
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
GitHub Statistics
370 Commits
27 Branches
3 Contributors
Updated on Jan 25, 2021
Maintainers
2
Package Meta Information
Latest Version
0.21.2
Package Id
ts-deps@0.21.2
Unpacked Size
199.12 kB
Size
56.53 kB
File Count
69
NPM Version
6.14.8
Node Version
15.0.1
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
Dependencies
39
@babel/cli@babel/core@babel/plugin-proposal-class-properties@babel/plugin-proposal-nullish-coalescing-operator@babel/plugin-proposal-object-rest-spread@babel/plugin-proposal-optional-chaining@babel/preset-env@babel/preset-typescript@commitlint/cli@commitlint/config-conventional@types/fs-extra@types/inquirer@types/jest@types/yargs@typescript-eslint/eslint-plugin@typescript-eslint/parserbabel-corebabel-eslintbabel-plugin-module-resolverconcurrentlyconfusing-browser-globalsdeepmergeeslinteslint-config-prettiereslint-formatter-prettyeslint-plugin-importeslint-plugin-jesteslint-plugin-reactfast-globfs-extrainquireristanbul-apijestprettiersort-package-jsonsource-map-supporttar-fstypescriptyargs
ts-deps
dev dependency for your simple TypeScript projects
Installation
npm add ts-deps --save-dev
npx ts-deps init
The init command will scaffold config files for your project. The typical output would be:
scripts/
scripts/build.js
scripts/clean.js
scripts/combineCoverage.js
src/
src/__integration-tests__
src/__tests__
.eslintrc.js
babel.config.js
commitlint.config.js
jest.config.integration.js
jest.config.js
package.json
prettier.config.js
release.config.js
tsconfig.json
tsconfig.declarations.json
Following packages already included for you:
- babel - Babel 7 to build
.jsor.tswhich brings more transformation options and speed - typescript - TypeScript used for type checking and declarations
- jest - Jest uses same babel config as build pipeline
- eslint
- prettier https://prettier.io/
- semantic-release https://github.com/semantic-release/semantic-release
- husky
- pretty-quick
- commitlint https://conventional-changelog.github.io/commitlint
The init command can be run on an existing project, it will change your package.json and remove superfluous dev dependencies.
Building your code
All the source code should be located in src directory. Extensions for the code should be .ts or .js.
You can add // @ts-check in the beginning of .js files to make TypeScript check those files as well.
For a Web app, please consider using create-react-app, however, .tsx and .jsx extensions are still allowed, but not well-tested.
npm build
The code will be transformed by Babel and put into lib folder. In addition to that .json and .d.ts files are copied over as well.
Declarations
If declarations are required, we can generate them by running:
npm run declarations
This will use tsconfig.declarations.json config to write declarations to the same lib folder as transformed .js or .ts files.
Checking your code
To run all builds and compilation checks we can use the check command which is automatically executed by husky on push.
npm run check
The build and other commands listed below are included into check.
So, to check your code for Type Script errors we can run:
npm run type-check
Linting:
npm run lint
Aliases
Current configuration supports aliases. Sometimes we need to be able to alias a path to a module in order to require it by that alias name like so:
import { db } from '@shared'
The above becomes possible with aliases. The setup of aliases is tedious and requires multiple configuration changes that span across Babel, TypeScript and Jest.
With ts-deps it should be as simple as creating a ts-deps.config.js file at the root of your project and executing ts-deps patch to patch tsconfig.json:
module.exports = {
aliases: {
'@core-lib': './src/shared/core-lib',
'@feature-1': './src/shared/features/feature-1',
},
}
In the above example, in order to reference files within core-lib directory we can just use:
import Module from '@core-lib'
That saves us from having to backward slash to that directory if we have a module in feature-1 directory that requires it.
Testing
The library supports two categories of tests: unit-tests and integration-tests.
Unit tests should be located within __tests__ directory anywhere under src directory. Deep nesting is supported. Every test should have .test. suffix. This is to ensure that the tests can also have test-only related helper files that can be required by the test but not included into result of build.
Integration tests should be located within ./src/__integration-tests__ at the root. Similarly, every test should have .test. suffix.
Integration and unit tests can be ran separately. If integration tests generate any coverage information we can combine it with unit tests using combine-coverage script.
npm run test --coverage
npm run integration --coverage
npm run combine-coverage
Release
To use semantic-release for release process we could run:
npm run release
To setup follow the link at the top and follow the steps in documentation. With current config we only need to declare environment variables to make
semantic-release push changes to GitHub Releases, git repo and npm.
export GH_TOKEN=
export NPM_TOKEN=
export GIT_AUTHOR_EMAIL=
export GIT_AUTHOR_NAME=
export GIT_COMMITTER_EMAIL=
export GIT_COMMITTER_NAME
Happy coding!
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
Found 0/26 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
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pull-request.yaml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/Aimee-Blue/ts-deps/pull-request.yaml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pull-request.yaml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/Aimee-Blue/ts-deps/pull-request.yaml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pull-request.yaml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/Aimee-Blue/ts-deps/pull-request.yaml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/push.yaml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/Aimee-Blue/ts-deps/push.yaml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/push.yaml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/Aimee-Blue/ts-deps/push.yaml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/push.yaml:40: update your workflow using https://app.stepsecurity.io/secureworkflow/Aimee-Blue/ts-deps/push.yaml/master?enable=pin
- Warn: npmCommand not pinned by hash: .github/workflows/pull-request.yaml:25
- Warn: npmCommand not pinned by hash: .github/workflows/push.yaml:35
- Info: 0 out of 6 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 2 npmCommand dependencies pinned
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/pull-request.yaml:1
- Warn: no topLevel permission defined: .github/workflows/push.yaml:1
- Info: no jobLevel write permissions 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
license file not detected
Details
- Warn: project does not have a license file
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 4 are checked with a SAST tool
Reason
33 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-fwr7-v2mv-hh25
- 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-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
- Warn: Project is vulnerable to: GHSA-ww39-953v-wcq6
- Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
- Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
- Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
- 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-xvch-5gv4-984h
- 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-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-44c6-4v22-4mhx
- Warn: Project is vulnerable to: GHSA-4x5v-gmq8-25ch
- Warn: Project is vulnerable to: GHSA-pq67-2wwv-3xjx
- Warn: Project is vulnerable to: GHSA-8cj5-5rvv-wf4v
- 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-6fc8-4gx4-v693
- Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Score
2.4
/10
Last Scanned on 2025-07-07
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