Package Health Score

94 / 100

security
No known security issues
popularity
Key ecosystem project
maintenance
Healthy
community
Active

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
0.15.1	\|	11/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.14.2	\|	09/2022	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.13.2	\|	04/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.12.24	\|	12/2020		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.11.0	\|	10/2018		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Yes

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

Key ecosystem project

Weekly Downloads (3,137,029)

GitHub Stars: 4.77K
Forks: 134
Contributors: 40

Direct Usage Popularity

The npm package @microsoft/tsdoc receives a total of 3,137,029 downloads a week. As such, we scored @microsoft/tsdoc popularity level to be Key ecosystem project.

Based on project statistics from the GitHub repository for the npm package @microsoft/tsdoc, we found that it has been starred 4,766 times.

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

Community

Active

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

With more than 10 contributors for the @microsoft/tsdoc repository, this is possibly a sign for a growing and inviting community.

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 129
Open PR: 9
Last Release: 29 days ago
Last Commit: 11 days ago

Further analysis of the maintenance status of @microsoft/tsdoc based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that @microsoft/tsdoc 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: 7 years
Dependencies: 0 Direct
Versions: 51
Install Size: 2.71 MB
Dist-tags: 1
# of Files: 443
Maintainers: 2
TS Typings: Yes

@microsoft/tsdoc 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.

Not sure how to use @microsoft/tsdoc?

To help you get started, we've collected the most common ways that @microsoft/tsdoc is being used within popular public projects.

microsoft / tsdoc / api-demo / src / advancedDemo.ts View on Github

console.log(os.EOL + colors.green('Comment to be parsed:') + os.EOL);
  console.log(colors.gray('&lt;&lt;&lt;&lt;&lt;&lt;'));
  console.log(foundComment.textRange.toString());
  console.log(colors.gray('&gt;&gt;&gt;&gt;&gt;&gt;'));

  const customConfiguration: tsdoc.TSDocConfiguration = new tsdoc.TSDocConfiguration();

  const customInlineDefinition: tsdoc.TSDocTagDefinition = new tsdoc.TSDocTagDefinition({
    tagName: '@customInline',
    syntaxKind: tsdoc.TSDocTagSyntaxKind.InlineTag,
    allowMultiple: true
  });

  // NOTE: Defining this causes a new DocBlock to be created under docComment.customBlocks.
  // Otherwise, a simple DocBlockTag would appear inline in the @remarks section.
  const customBlockDefinition: tsdoc.TSDocTagDefinition = new tsdoc.TSDocTagDefinition({
    tagName: '@customBlock',
    syntaxKind: tsdoc.TSDocTagSyntaxKind.BlockTag
  });

  // NOTE: Defining this causes @customModifier to be removed from its section,
  // and added to the docComment.modifierTagSet
  const customModifierDefinition: tsdoc.TSDocTagDefinition = new tsdoc.TSDocTagDefinition({
    tagName: '@customModifier',
    syntaxKind: tsdoc.TSDocTagSyntaxKind.ModifierTag
  });

  customConfiguration.addTagDefinitions([
    customInlineDefinition,
    customBlockDefinition,
    customModifierDefinition
  ]);

View more ways to use @microsoft/tsdoc

@microsoft/tsdoc

This library is the reference implementation of a parser for the TSDoc syntax. Using this library is an easy way to ensure that your tool is 100% compatible with the standard.

What is TSDoc?

TSDoc is a proposal to standardize the doc comments used in TypeScript source files. It allows different tools to extract content from comments without getting confused by each other's syntax. The TSDoc notation looks pretty familiar:

export class Statistics {
  /**
   * Returns the average of two numbers.
   *
   * @remarks
   * This method is part of the {@link core-library#Statistics | Statistics subsystem}.
   *
   * @param x - The first input number
   * @param y - The second input number
   * @returns The arithmetic mean of `x` and `y`
   *
   * @beta
   */
  public static getAverage(x: number, y: number): number {
    return (x + y) / 2.0;
  }
}

Give it a try!

Check out the TSDoc Playground for a cool live demo of our parser!

API Usage

The api-demo folder on GitHub illustrates how to invoke the TSDoc parser.

A separate NPM package @microsoft/tsdoc-config is used for loading the tsdoc.json file.

Get involved

The TSDoc project is actively evolving. Please visit the website for the latest documentation, instructions for building/debugging the projects, and other resources:

https://tsdoc.org/

@microsoft/tsdoc development dependencies

@rushstack/heft-web-rig @rushstack/heft @types/heft-jest eslint eslint-plugin-header

FAQs

What is @microsoft/tsdoc?

A parser for the TypeScript doc comment syntax. Visit Snyk Advisor to see a full health score report for @microsoft/tsdoc, including popularity, security, maintenance & community analysis.

Is @microsoft/tsdoc popular?

The npm package @microsoft/tsdoc receives a total of 3,137,029 weekly downloads. As such, @microsoft/tsdoc popularity was classified as a key ecosystem project. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @microsoft/tsdoc well maintained?

We found that @microsoft/tsdoc demonstrated a healthy version release cadence and project activity. It has a community of 40 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is @microsoft/tsdoc safe to use?

The npm package @microsoft/tsdoc 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 December-2024, at 07:37 (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

@microsoft/tsdoc

A parser for the TypeScript doc comment syntax 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 (3,137,029)

Direct Usage Popularity

Community

Embed Package Health Score Badge

Maintenance

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Package

Not sure how to use @microsoft/tsdoc?

@microsoft/tsdoc

What is TSDoc?

Give it a try!

API Usage

Get involved

@microsoft/tsdoc development dependencies

FAQs

What is @microsoft/tsdoc?

Is @microsoft/tsdoc popular?

Is @microsoft/tsdoc well maintained?

Is @microsoft/tsdoc 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 (3,137,029)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Not sure how to use @microsoft/tsdoc?

@microsoft/tsdoc

What is TSDoc?

Give it a try!

API Usage

Get involved

@microsoft/tsdoc development dependencies

FAQs

What is @microsoft/tsdoc?

Is @microsoft/tsdoc popular?

Is @microsoft/tsdoc well maintained?

Is @microsoft/tsdoc 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