npmpackage.info

Gathering detailed insights and metrics for @definitelytyped/dts-critic

@definitelytyped/dts-critic - 0.1.20 | npmpackage.info

@definitelytyped/dts-critic

Infrastructure for DefinitelyTyped

0.1.20

394

MIT

TypeScript

97.06 kB

6.6

Installations

npm install @definitelytyped/dts-critic

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Min. Node Version

>=18.18.0

Node Version

20.19.0

NPM Version

10.8.2 Pull Requests

Open

20

Total

1,071

Closed

96

Merged

955

Issues

Open

54

Total

107

Closed

53

Releases

615

@definitelytyped/header-parser@0.2.19

Updated on Apr 04, 2025

@definitelytyped/dtslint-runner@0.1.36

Updated on Apr 04, 2025

@definitelytyped/dtslint@0.2.32

Updated on Apr 04, 2025

@definitelytyped/dts-critic@0.1.20

Updated on Apr 04, 2025

@definitelytyped/definitions-parser@0.1.22

Updated on Apr 04, 2025

@definitelytyped/dtslint-runner@0.1.35

Updated on Apr 02, 2025

View All 615 releases

Languages

TypeScript

JavaScript

TypeScript (92.29%)

JavaScript (7.71%)

Developer

microsoft

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

394 Stars

3,036 Commits

218 Forks

12 Watchers

27 Branches

242 Contributors

Updated on Jul 14, 2025

Maintainers

View All 242 Contributors

Package Meta Information

Latest Version

0.1.20

Package Id

@definitelytyped/dts-critic@0.1.20

Unpacked Size

97.06 kB

Size

21.84 kB

File Count

NPM Version

10.8.2

Node Version

20.19.0

Published on

Apr 04, 2025

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

typescript yargs @definitelytyped/header-parser

Peer Dependencies

typescript

dts-critic

Checks a new dts against the Javascript sources and tells you what problems it has.

Usage

Build the program:

1$ npm run build

Run the program using node:

1$ node dist/index.js --dts=path-to-d.ts [--js=path-to-source] [--mode=mode] [--debug]

If the d.ts path is to a file named index.d.ts, the name of the directory will be used as the package name instead. For example ~/dt/types/jquery/index.d.ts will use jquery as the name.

path-to-source is optional; if you leave it off, the code will check npm for a package with the same name as the d.ts.

Mode

You can run dts-critic in different modes that affect which checks will be performed:

name-only: dts-critic will check your package name and DefinitelyTyped header (if present) against npm packages. For example, if your declaration is for an npm package called 'cool-js-package', it will check if a package named 'cool-js-package' actually exists in npm.
code: in addition to the checks performed in name-only mode, dts-critic will check if your declaration exports match the source JavaScript module exports. For example, if your declaration has a default export, it will check if the JavaScript module also has a default export.

Current checks

Npm declaration

If your declaration is for an npm package:

An npm package with the same name of your declaration's package must exist.
If your package has a Definitely Typed-conforming package.json, the npm package's version must match your version.
If you are running under code mode, your declaration must also match the source JavaScript module.

Non-npm declaration

If your declaration is for a non-npm package (in other words, if your declaration has a Definitely Typed-conforming package.json with "nonNpm": true):

An npm package with the same name of your declaration's package cannot exist.
If you are running under code mode and a path to the JavaScript source file was provided, your declaration must also match the source JavaScript module.

Planned work

Make sure your module structure fits the source.
Make sure your exported symbols match the source.
Make sure your types match the source types???
Download source based on npm homepage (if it is github).

Note that for real use on Definitely Typed, a lot of these checks need to be pretty loose.

Contributing

Testing

The tests use the Jest framework. To build and execute the tests, run:

1$ npm run test

This will build the program and run jest.

No vulnerabilities found.

10

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

10

Maintained

Determines if the project is "actively maintained".

10

Security-Policy

Determines if the project has published a security policy.

10

License

Determines if the project has defined a license.

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

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

9

SAST

Determines if the project uses static code analysis.

5

Branch-Protection

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

0

CII-Best-Practices

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

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Fuzzing

Determines if the project uses fuzzing.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

6.6

/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