Package Health Score

66 / 100

security
No known security issues
popularity
Limited
maintenance
Sustainable
community
Limited

Explore Similar Packages

Security

No known security issues

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

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
2.0.2	\|	11/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.1.1	\|	03/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.0.0	\|	03/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

BSD-3-Clause

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

Limited

Weekly Downloads (261)

GitHub Stars: 0
Forks: 0
Contributors: 3

Direct Usage Popularity

The npm package typedoc-plugin-custom-validation receives a total of 261 downloads a week. As such, we scored typedoc-plugin-custom-validation popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package typedoc-plugin-custom-validation, we found that it has been starred ? times.

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

Community

Limited

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

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like typedoc-plugin-custom-validation is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

Open Issues: 0
Open PR: 0
Last Release: 8 days ago
Last Commit: 8 days ago

Further analysis of the maintenance status of typedoc-plugin-custom-validation based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that typedoc-plugin-custom-validation demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

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: 2 years
Dependencies: 0 Direct
Versions: 7
Install Size: 18.9 kB
Dist-tags: 1
# of Files: 8
Maintainers: 1
TS Typings: No

typedoc-plugin-custom-validation 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

typedoc-plugin-custom-validation

Donate

Any donations would be much appreciated. 😄

Installation

# Install with npm
npm install -D typedoc-plugin-custom-validation

# Install with pnpm
pnpm add -D typedoc-plugin-custom-validation

# Install with yarn
yarn add -D typedoc-plugin-custom-validation

Usage

All options are configured in the customValidation option.

`byKind`

This option is for specifying requirements for each kind of node.

Example: Require all functions to have a summary and have an @example tag.

{
  "plugin": ["typedoc-plugin-custom-validation"],
  "customValidation": {
    "byKind": [
      {
        "kinds": "Function",
        "summary": true,
        "tags": ["example"]
      }
    ]
  }
}

My Tags Don't Exists?

Due to the way typedoc works, some tags may be move to other nodes than the one they were defined on.

For example, @param tags are removed from the Function node they are defined on and its content is put onto the corresponding Parameter node. You can require parameters to be documented with:

{
  "plugin": ["typedoc-plugin-custom-validation"],
  "customValidation": {
    "byKind": [
      {
        "kinds": "Parameter",
        "summary": true
      }
    ]
  }
}

typedoc-plugin-custom-validation development dependencies

@commitlint/cli @commitlint/config-conventional @cspell/dict-cryptocurrencies @eslint/compat @rebeccastevens/eslint-config @rollup/plugin-replace @rollup/plugin-typescript @semantic-release/changelog @semantic-release/commit-analyzer @semantic-release/git @semantic-release/github @semantic-release/npm @semantic-release/release-notes-generator @stylistic/eslint-plugin @types/node @typescript-eslint/eslint-plugin @typescript-eslint/parser @vitest/coverage-v8 @vitest/eslint-plugin commitizen cspell cz-conventional-changelog eslint eslint-config-prettier eslint-flat-config-utils eslint-import-resolver-typescript eslint-merge-processors eslint-plugin-eslint-comments eslint-plugin-format eslint-plugin-functional eslint-plugin-import-x eslint-plugin-jsdoc eslint-plugin-jsonc eslint-plugin-markdown eslint-plugin-n eslint-plugin-no-only-tests eslint-plugin-optimize-regex eslint-plugin-prettier eslint-plugin-promise eslint-plugin-regexp eslint-plugin-sonarjs eslint-plugin-unicorn eslint-plugin-yml husky jsonc-eslint-parser knip lint-staged markdownlint-cli2 prettier prettier-plugin-packagejson rimraf rollup rollup-plugin-deassert rollup-plugin-dts-bundle-generator semantic-release tsc-files typedoc typescript vite-tsconfig-paths vitest yaml-eslint-parser

FAQs

What is typedoc-plugin-custom-validation?

<div></div>. Visit Snyk Advisor to see a full health score report for typedoc-plugin-custom-validation, including popularity, security, maintenance & community analysis.

Is typedoc-plugin-custom-validation popular?

The npm package typedoc-plugin-custom-validation receives a total of 261 weekly downloads. As such, typedoc-plugin-custom-validation popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is typedoc-plugin-custom-validation well maintained?

We found indications that typedoc-plugin-custom-validation maintenance is sustainable demonstrating some project activity. We saw a total of 3 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is typedoc-plugin-custom-validation safe to use?

The npm package typedoc-plugin-custom-validation 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 19 November-2024, at 22:38 (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

typedoc-plugin-custom-validation

<div align="center"> For more information about how to use this package see README

Ensure you're using the healthiest npm packages

Package Health Score

Explore Similar Packages

Security

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Popularity

Weekly Downloads (261)

Direct Usage Popularity

Community

Embed Package Health Score Badge

Maintenance

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Package

Readme

typedoc-plugin-custom-validation

Donate

Installation

Usage

`byKind`

My Tags Don't Exists?

typedoc-plugin-custom-validation development dependencies

FAQs

What is typedoc-plugin-custom-validation?

Is typedoc-plugin-custom-validation popular?

Is typedoc-plugin-custom-validation well maintained?

Is typedoc-plugin-custom-validation safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Fix identified vulnerabilities

Monitor for new issues

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (261)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

typedoc-plugin-custom-validation

Donate

Installation

Usage

byKind

My Tags Don't Exists?

typedoc-plugin-custom-validation development dependencies

FAQs

What is typedoc-plugin-custom-validation?

Is typedoc-plugin-custom-validation popular?

Is typedoc-plugin-custom-validation well maintained?

Is typedoc-plugin-custom-validation 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

`byKind`