npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

grunt-plugin-esdoc

v1.0.0

Published

A plugin that integrates ESDoc into your Grunt build setup.

Downloads

2

Readme

Grunt Plugin: ESDoc

Build status npm version Dependencies

A Grunt plugin for the ES2015+ documentation tool ESDoc.

Getting Started

This plugin requires Grunt >= 0.4.0

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-plugin-esdoc

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks("grunt-plugin-esdoc");

Usage

MyClass.js
/**
 * Description of MyClass.
 */

export default class MyClass {

	/**
	 * Description of the method.
	 *
	 * @param {Number} param - Description of the parameter.
	 * @return {Number} Description of the return value.
	 */

	method(param) {}

}
Gruntfile.js
grunt.initConfig({
	esdoc: {
		compile: {
			options: {
				plugins: [{
					"name": "esdoc-standard-plugin"
				}]
			},
			src: "src",
			dest: "docs"
		}
	}
});

Call the esdoc task to generate the documentation. Use --verbose to see all ESDoc log messages.

grunt esdoc [--verbose]

You may also integrate the task into your build sequence:

grunt.registerTask("default", ["lint", "test", "esdoc"]);

Configuration

All ESDoc options defined under options are passed to ESDoc. You may also specify additional plugin-specific options:

| Option | Description | Default | |-------------------|---------------------------------------------------------------------------------------------------------------------------------|---------| | coverageThreshold | Affects the color of the coverage report in the console. Has no effect if coverage is not available. Expressed as a percentage. | 100.0 | | verbose | Enables exhaustive ESDoc logging. | false |

grunt.initConfig({
	esdoc: {
		compile: {
			options: {
				verbose: true,
				coverageThreshold: 95.0,
				plugins: [{
					name: "esdoc-standard-plugin",
					option: {
						test: {
							source: "./test/",
							interfaces: ["suite", "test"],
							includes: ["(spec|Spec|test|Test)\\.js$"],
							excludes: ["\\.config\\.js$"]
						}
					}
				}]
			},
			src: "./path/to/src",
			dest: "./path/to/esdoc/output"
		}
	}
});

Alternatively, you can specify a config path to a file containing the configuration options for ESDoc.

esdoc.json
{
	"coverageThreshold": 95.0,
	"source": "src",
	"destination": "docs",
	"plugins": [{"name": "esdoc-standard-plugin"}]
}
Gruntfile.js
grunt.initConfig({
	esdoc: {
		compile: {
			options: {
				config: "esdoc.json"
			}
		}
	}
});

Note that src and dest override source and destination if they are defined.

Contributing

Maintain the existing coding style. Lint and test your code.