npmpackage.info

Gathering detailed insights and metrics for gulp-jsdoc3

Other packages similar to gulp-jsdoc3

@sugarcrm/gulp-jsdoc3

0.2.4

gulp integration for jsdoc3 cli

jsdoc-simple-theme

1.2.6

jsDoc3 simple theme for gulp-jsdoc3 and jsdoc also.

leedian-jsdoc

1.0.5

gulp-jsdoc3 + jaguarjs-jsdoc template

Gathering detailed insights and metrics for gulp-jsdoc3

gulp-jsdoc3 - 3.0.0 | npmpackage.info

gulp-jsdoc3

A JSDoc 3 plugin for gulp

3.0.0

132

Apache-2.0

JavaScript

2.1

Installations

npm install gulp-jsdoc3

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Pull Requests

Open

16

Total

44

Closed

11

Merged

17

Issues

Open

1

Total

40

Closed

39

Releases

First stable release

v0.1.0

Updated on Dec 29, 2015

View All 1 releases

Languages

JavaScript

JavaScript (100%)

Developer

deshaw

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

Apache-2.0 License

132 Stars

52 Commits

39 Forks

8 Watchers

18 Branches

19 Contributors

Updated on Dec 10, 2024

Maintainers

View All 19 Contributors

Package Meta Information

Latest Version

3.0.0

Package Id

gulp-jsdoc3@3.0.0

Size

703.56 kB

Published on

Apr 03, 2020

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

gulp-jsdoc3

jsdoc plugin for gulp

Installation

Install gulp-jsdoc as a development dependency:

1npm install --save-dev gulp-jsdoc3

Usage

1const jsdoc = require('gulp-jsdoc3');
2
3gulp.task('doc', function (cb) {
4    gulp.src(['README.md', './src/**/*.js'], {read: false})
5        .pipe(jsdoc(cb));
6});

By default, documentation is output to docs/gen. gulp-jsdoc3 does not modify the source vinyl stream so the output location can only be specified via config, not gulp.dest(). You can see all the default options passed to jsdoc in src/jsdocConfig.json.

You can also pass in your own config to override the defaults. All CLI options can be specified here.

1const jsdoc = require('gulp-jsdoc3');
2
3gulp.task('doc', function (cb) {
4    const config = require('./jsdoc.json');
5    gulp.src(['README.md', './src/**/*.js'], {read: false})
6        .pipe(jsdoc(config, cb));
7});

Another good example is in this project's gulpfile!

Overriding the default layout

ink-docstrap is used as the default layout but you can easily override it in your config like this:

{
    "templates": {
        "default": {
            // Set my own layout file
            "layoutFile": "./layout.tmpl"
        }
    }
}

Other config tips and tricks

Use include and exclude patterns to filter the globs from gulp even more. For example, only include .js,.jsdoc, or .jsx files that do not start with _:

"source": {
    "includePattern": ".+\\.js(doc|x)?$",
    "excludePattern": "(^|\\/|\\\\)_"
}

If you want to document multiple markdown or html files, enable tutorial support:

"tutorials": "path/to/tutorials"

Debugging

Set env variable: DEBUG=gulp-jsdoc3

Notes

This is a reasonable attempt to wrap jsdoc using gulp as thinly as possible use the jsdoc config to pass in files from gulp. jsdoc does not allow for piped input, so this attempt may be considered a gulp anti-pattern. It also does not pass on output to be piped elsewhere.

We would like to thank Mangled Deutz @ gulp-jsdoc for the original implementation.

History

This plugin was contributed back to the community by the D. E. Shaw group.

Screenshot

License

Apache-2.0 License

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

3

Code-Review

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

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

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

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

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

0

Security-Policy

Determines if the project has published a security policy.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

48 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8
Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-w8qv-6jwh-64r5
Warn: Project is vulnerable to: GHSA-897m-rjf5-jp39
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
Warn: Project is vulnerable to: GHSA-4gmj-3p3h-gm8h
Warn: Project is vulnerable to: GHSA-2j2x-2gpw-g8fm
Warn: Project is vulnerable to: GHSA-4q6p-r6v2-jvc5
Warn: Project is vulnerable to: GHSA-ww39-953v-wcq6
Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44
Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988
Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
Warn: Project is vulnerable to: GHSA-6vfc-qv3f-vr6c
Warn: Project is vulnerable to: GHSA-5v2h-r2cx-5xgj
Warn: Project is vulnerable to: GHSA-rrrm-qjm4-v8hf
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-8hfj-j24r-96c4
Warn: Project is vulnerable to: GHSA-wc69-rhjr-hc9g
Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
Warn: Project is vulnerable to: GHSA-g6ww-v8xp-vmwg
Warn: Project is vulnerable to: GHSA-566m-qj78-rww5
Warn: Project is vulnerable to: GHSA-hwj9-h5mp-3pm3
Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-rjqq-98f6-6j3r
Warn: Project is vulnerable to: GHSA-mjxr-4v3x-q3m4
Warn: Project is vulnerable to: GHSA-cgfm-xwp7-2cvr
Warn: Project is vulnerable to: GHSA-rm97-x556-q36h
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-mxhp-79qh-mcx6
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Warn: Project is vulnerable to: GHSA-cf4h-3jhx-xvhq
Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp

Score

2.1

/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

Other packages similar to gulp-jsdoc3

Other packages similar to gulp-jsdoc3

gulp-jsdoc3

Installations

Developer Guide

No

CommonJS

Pull Requests

16

44

11

17

Issues

1

40

39

Releases

Languages

Developer

deshaw

Download Statistics

GitHub Statistics

Maintainers

Package Meta Information

Total Downloads

NaN

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

gulp-jsdoc3

Installation

Usage

Overriding the default layout

Other config tips and tricks

Debugging

Notes

History

License

10

10

3

0

0

0

0

0

0

0

2.1

/10