gatsby-transformer-jsdoc

v1.0.1

Gatsby transformer plugin which uses Documentation.js to extract JavaScript documentation For more information about how to use this package see README

Latest version published 6 years ago

License: MIT

NPM

GitHub

Package Health Score

63 / 100

security
Security review needed
popularity
Small
maintenance
Inactive
community
Active

Explore Similar Packages

Security

Security review needed

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
1.0.1	\|	11/2018	Popular	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

Small

Weekly Downloads (1)

GitHub Stars: 55.28K
Forks: 10.31K
Contributors: 420

Direct Usage Popularity

The npm package gatsby-transformer-jsdoc receives a total of 1 downloads a week. As such, we scored gatsby-transformer-jsdoc popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package gatsby-transformer-jsdoc, we found that it has been starred 55,276 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: Yes
Code of Conduct: Yes
Contributors: 420
Funding: No

A good and healthy external contribution signal for gatsby-transformer-jsdoc project, which invites more than one hundred open source maintainers to collaborate on the repository.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

Open Issues: 189
Open PR: 197
Last Release: 6 years ago
Last Commit: 5 days ago

Further analysis of the maintenance status of gatsby-transformer-jsdoc 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 gatsby-transformer-jsdoc 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.

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: 6 years
Dependencies: 3 Direct
Versions: 3
Install Size: 52.5 kB
Dist-tags: 1
# of Files: 12
Maintainers: 1
TS Typings: No

gatsby-transformer-jsdoc 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

gatsby-transformer-documentationjs

Uses Documentation.js to extract code metadata (JSDocs is supported currently though Flow is also supported by Documentation.js and can be added to this plugin as well).

It's used on gatsbyjs.org and can be seen in use on several pages there e.g. https://www.gatsbyjs.org/docs/node-apis/

Install

npm install --save gatsby-transformer-documentationjs

How to use

Add the plugin to your gatsby-config.js.

plugins: [`gatsby-transformer-documentationjs`]

Ensure that there's an instance of gatsby-source-filesystem that's pointed at your source code e.g.

plugins: [
  `gatsby-transformer-documentationjs`,
  {
    resolve: `gatsby-source-filesystem`,
    options: {
      name: `source`,
      path: `${__dirname}/../src/`,
    },
  },
]

Then you can write GraphQL queries pulling out JSDoc comments like:

{
  allDocumentationJs {
    edges {
      node {
        name
        description {
          childMarkdownRemark {
            html
          }
        }
        returns {
          title
        }
        examples {
          raw
          highlighted
        }
        params {
          name
          type {
            name
          }
          description {
            childMarkdownRemark {
              html
            }
          }
        }
      }
    }
  }
}

gatsby-transformer-jsdoc dependencies

@babel/runtime documentation prismjs

gatsby-transformer-jsdoc development dependencies

@babel/cli @babel/core babel-preset-gatsby-package cross-env

FAQs

What is gatsby-transformer-jsdoc?

Gatsby transformer plugin which uses Documentation.js to extract JavaScript documentation. Visit Snyk Advisor to see a full health score report for gatsby-transformer-jsdoc, including popularity, security, maintenance & community analysis.

Is gatsby-transformer-jsdoc popular?

The npm package gatsby-transformer-jsdoc receives a total of 1 weekly downloads. As such, gatsby-transformer-jsdoc popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is gatsby-transformer-jsdoc well maintained?

We found indications that gatsby-transformer-jsdoc is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is gatsby-transformer-jsdoc safe to use?

While scanning the latest version of gatsby-transformer-jsdoc, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 12 November-2024, at 11:50 (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