{"id":15313996,"url":"https://github.com/vanruesc/grunt-plugin-esdoc","last_synced_at":"2025-10-08T23:32:14.718Z","repository":{"id":57255529,"uuid":"108681057","full_name":"vanruesc/grunt-plugin-esdoc","owner":"vanruesc","description":"A Grunt plugin for ESDoc.","archived":true,"fork":false,"pushed_at":"2018-08-30T21:41:34.000Z","size":22,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-21T11:30:57.504Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"zlib","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vanruesc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-10-28T20:15:59.000Z","updated_at":"2023-01-27T21:28:10.000Z","dependencies_parsed_at":"2022-09-04T21:50:50.328Z","dependency_job_id":null,"html_url":"https://github.com/vanruesc/grunt-plugin-esdoc","commit_stats":null,"previous_names":["vanruesc/vanruesc-grunt-esdoc"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vanruesc%2Fgrunt-plugin-esdoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vanruesc%2Fgrunt-plugin-esdoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vanruesc%2Fgrunt-plugin-esdoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vanruesc%2Fgrunt-plugin-esdoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vanruesc","download_url":"https://codeload.github.com/vanruesc/grunt-plugin-esdoc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":235775518,"owners_count":19043180,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-01T08:44:04.669Z","updated_at":"2025-10-08T23:32:09.426Z","avatar_url":"https://github.com/vanruesc.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Grunt Plugin: ESDoc\n\n[![Build status](https://travis-ci.org/vanruesc/grunt-plugin-esdoc.svg?branch=master)](https://travis-ci.org/vanruesc/grunt-plugin-esdoc)\n[![npm version](https://badge.fury.io/js/grunt-plugin-esdoc.svg)](https://badge.fury.io/js/grunt-plugin-esdoc)\n[![Dependencies](https://david-dm.org/vanruesc/grunt-plugin-esdoc.svg?branch=master)](https://david-dm.org/vanruesc/grunt-plugin-esdoc)\n\nA Grunt plugin for the ES2015+ documentation tool [ESDoc](https://esdoc.org/).\n\n\n## Getting Started\n\nThis plugin requires Grunt \u003e= 0.4.0\n\nIf you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) \nguide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. \nOnce you're familiar with that process, you may install this plugin with this command:\n\n```sh\nnpm install grunt-plugin-esdoc\n``` \n\nOnce the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:\n\n```js\ngrunt.loadNpmTasks(\"grunt-plugin-esdoc\");\n```\n\n\n## Usage\n\n##### MyClass.js\n\n```js\n/**\n * Description of MyClass.\n */\n\nexport default class MyClass {\n\n\t/**\n\t * Description of the method.\n\t *\n\t * @param {Number} param - Description of the parameter.\n\t * @return {Number} Description of the return value.\n\t */\n\n\tmethod(param) {}\n\n}\n```\n\n##### Gruntfile.js\n\n```js\ngrunt.initConfig({\n\tesdoc: {\n\t\toptions: {\n\t\t\tplugins: [{\n\t\t\t\tname: \"esdoc-standard-plugin\"\n\t\t\t}]\n\t\t},\n\t\tcompile: {\n\t\t\tsrc: \"src\",\n\t\t\tdest: \"docs\"\n\t\t}\n\t}\n});\n```\n\nCall the `esdoc` task to generate the documentation. Use `--verbose` to see all ESDoc log messages.\n\n```bash\ngrunt esdoc [--verbose]\n```\n\nYou may also integrate the task into your build sequence:\n\n```js\ngrunt.registerTask(\"default\", [\"lint\", \"test\", \"esdoc\"]);\n```\n\n\n## Configuration\n\nAll [ESDoc options](https://esdoc.org/manual/config.html) defined under `options` are passed to ESDoc.\nYou may also specify additional plugin-specific options:\n\n| Option            | Description                                                                                                                     | Default |\n|-------------------|---------------------------------------------------------------------------------------------------------------------------------|---------|\n| 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   |\n| verbose           | Enables exhaustive ESDoc logging.                                                                                               | false   |\n\n```js\ngrunt.initConfig({\n\tesdoc: {\n\t\toptions: {\n\t\t\tverbose: true,\n\t\t\tcoverageThreshold: 95.0,\n\t\t\tplugins: [{\n\t\t\t\tname: \"esdoc-standard-plugin\",\n\t\t\t\toption: {\n\t\t\t\t\ttest: {\n\t\t\t\t\t\tsource: \"./test/\",\n\t\t\t\t\t\tinterfaces: [\"suite\", \"test\"],\n\t\t\t\t\t\tincludes: [\"(spec|Spec|test|Test)\\\\.js$\"],\n\t\t\t\t\t\texcludes: [\"\\\\.config\\\\.js$\"]\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}]\n\t\t},\n\t\tcompile: {\n\t\t\tsrc: \"./path/to/src\",\n\t\t\tdest: \"./path/to/esdoc/output\"\n\t\t}\n\t}\n});\n```\n\nAlternatively, you can specify a `config` path to a file containing the configuration options for ESDoc.\n\n##### esdoc.json\n\n```js\n{\n\t\"source\": \"src\",\n\t\"destination\": \"docs\",\n\t\"coverageThreshold\": 95.0,\n\t\"plugins\": [{\"name\": \"esdoc-standard-plugin\"}]\n}\n```\n\n##### Gruntfile.js\n\n```js\ngrunt.initConfig({\n\tesdoc: {\n\t\tcompile: {\n\t\t\toptions: {\n\t\t\t\tconfig: \"esdoc.json\"\n\t\t\t}\n\t\t}\n\t}\n});\n```\n\nNote that `src` and `dest` override `source` and `destination` if they are defined.\n\n\n## Contributing\n\nMaintain the existing coding style. Lint and test your code.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvanruesc%2Fgrunt-plugin-esdoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvanruesc%2Fgrunt-plugin-esdoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvanruesc%2Fgrunt-plugin-esdoc/lists"}