@pika/plugin-build-types

v0.9.2

A @pika/pack plugin: Adds TypeScript type definitions to your package build. For more information about how to use this package see README

Latest version published 5 years ago

License: MIT

NPM

GitHub

Package Health Score

51 / 100

security
No known security issues
popularity
Small
maintenance
Inactive
community
Sustainable

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
0.8.3	\|	02/2020		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.9.2	\|	02/2020	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.7.1	\|	10/2019		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.6.1	\|	09/2019		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.5.1	\|	07/2019		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Small

Weekly Downloads (1,914)

GitHub Stars: 162
Forks: 31
Contributors: 30

Direct Usage Popularity

The npm package @pika/plugin-build-types receives a total of 1,914 downloads a week. As such, we scored @pika/plugin-build-types popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package @pika/plugin-build-types, we found that it has been starred 162 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 30
Funding: No

With more than 10 contributors for the @pika/plugin-build-types repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like @pika/plugin-build-types is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

archived

Commit Frequency

No Recent Commits

Open Issues: 29
Open PR: 75
Last Release: 5 years ago
Last Commit: 4 years ago

Further analysis of the maintenance status of @pika/plugin-build-types based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for @pika/plugin-build-types is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 6 years
Dependencies: 4 Direct
Versions: 29
Install Size: 15.8 kB
Dist-tags: 1
# of Files: 7
Maintainers: 1
TS Typings: Yes

@pika/plugin-build-types has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

@pika/plugin-build-types

A @pika/pack build plugin. Automatically adds TypeScript type definitions to your package build.

Note: This plugin is not needed if you are already writing TypeScript and using the ts-standard-pkg plugin.

Install

# npm:
npm install @pika/plugin-build-types --save-dev
# yarn:
yarn add @pika/plugin-build-types --dev

Usage

{
  "name": "example-package-json",
  "version": "1.0.0",
  "@pika/pack": {
    "pipeline": [
      ["@pika/plugin-standard-pkg"],
      ["@pika/plugin-build-types"]
    ]
  }
}

For more information about @pika/pack & help getting started, check out the main project repo.

Options

"tsconfig": The relative path to the tsconfig.json config file to use. Defaults to the top-level project TypeScript config file, if one exists.
"args": Optional, an array of additional arguments for tsc. Example: ["--build"]
"entrypoint" (Default: "types"): Customize the package.json manifest entrypoint set by this plugin. Accepts either a string, an array of strings, or null to disable entrypoint. Changing this is not recommended for most usage.

Result

Adds or generates TypeScript definitions for your package build: dist-types/

If your package is written in TypeScript: Types are automatically generated from your source.
If your package already includes custom-written type definitions: These files are automatically copied into your package build.
Otherwise: Automatically generate definitions from your JavaScript source. (Note that this currently requires that you include @pika/plugin-build-node or some other Node.js build earlier in the pipeline.)

Adds a "types" entrypoint to your built package.json manifest.

@pika/plugin-build-types dependencies

@pika/types execa mkdirp typescript

@pika/plugin-build-types development dependencies

@pika/pack @pika/plugin-build-node @pika/plugin-ts-standard-pkg @types/node

FAQs

What is @pika/plugin-build-types?

A @pika/pack plugin: Adds TypeScript type definitions to your package build. Visit Snyk Advisor to see a full health score report for @pika/plugin-build-types, including popularity, security, maintenance & community analysis.

Is @pika/plugin-build-types popular?

The npm package @pika/plugin-build-types receives a total of 1,914 weekly downloads. As such, @pika/plugin-build-types popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @pika/plugin-build-types well maintained?

We found indications that @pika/plugin-build-types is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is @pika/plugin-build-types safe to use?

The npm package @pika/plugin-build-types was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 21 November-2024, at 10:34 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (1,914)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

@pika/plugin-build-types

Install

Usage

Options

Result

@pika/plugin-build-types dependencies

@pika/plugin-build-types development dependencies

FAQs

What is @pika/plugin-build-types?

Is @pika/plugin-build-types popular?

Is @pika/plugin-build-types well maintained?

Is @pika/plugin-build-types safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues