# esdoc-standard-plugin

> A standard plugin for ESDoc

Latest version **1.0.0** (published 2017-07-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install esdoc-standard-plugin
pnpm add esdoc-standard-plugin
yarn add esdoc-standard-plugin
bun add esdoc-standard-plugin
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2017-07-30 |
| First published | 2017-04-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 6.0.0 |
| Dependencies | 11 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 139 |
| Author | h13i32maru |
| Maintainers | h13i32maru |
| Keywords | esdoc, standard, plugin |

## Links

- npm: https://www.npmjs.com/package/esdoc-standard-plugin
- Repository: https://github.com/esdoc/esdoc-plugins
- Issues: https://github.com/esdoc/esdoc-plugins/issues
- npm.io page: https://npm.io/package/esdoc-standard-plugin

## Dependencies (11)

- [esdoc-lint-plugin](https://npm.io/package/esdoc-lint-plugin.md) ^1.0.0
- [esdoc-brand-plugin](https://npm.io/package/esdoc-brand-plugin.md) ^1.0.0
- [esdoc-accessor-plugin](https://npm.io/package/esdoc-accessor-plugin.md) ^1.0.0
- [esdoc-coverage-plugin](https://npm.io/package/esdoc-coverage-plugin.md) ^1.0.0
- [esdoc-publish-html-plugin](https://npm.io/package/esdoc-publish-html-plugin.md) ^1.0.0
- [esdoc-integrate-test-plugin](https://npm.io/package/esdoc-integrate-test-plugin.md) ^1.0.0
- [esdoc-type-inference-plugin](https://npm.io/package/esdoc-type-inference-plugin.md) ^1.0.0
- [esdoc-integrate-manual-plugin](https://npm.io/package/esdoc-integrate-manual-plugin.md) ^1.0.0
- [esdoc-external-ecmascript-plugin](https://npm.io/package/esdoc-external-ecmascript-plugin.md) ^1.0.0
- [esdoc-unexported-identifier-plugin](https://npm.io/package/esdoc-unexported-identifier-plugin.md) ^1.0.0
- [esdoc-undocumented-identifier-plugin](https://npm.io/package/esdoc-undocumented-identifier-plugin.md) ^1.0.0

## Recent versions

- 1.0.0 (latest) — 2017-07-30
- 0.0.8 — 2017-06-25
- 0.0.7 — 2017-05-14
- 0.0.6 — 2017-05-14
- 0.0.5 — 2017-05-13
- 0.0.4 — 2017-05-12
- 0.0.3 — 2017-05-07
- 0.0.2 — 2017-04-23
- 0.0.1 — 2017-04-23

## README

# ESDoc Standard Plugin
## Install
```bash
npm install esdoc-standard-plugin
```

## Config
```json
{
  "source": "./src",
  "destination": "./doc",
  "plugins": [
    {
      "name": "esdoc-standard-plugin",
      "option": {
        "lint": {"enable": true},
        "coverage": {"enable": true},
        "accessor": {"access": ["public", "protected", "private"], "autoPrivate": true},
        "undocumentIdentifier": {"enable": true},
        "unexportedIdentifier": {"enable": false},
        "typeInference": {"enable": true},
        "brand": {
          "logo": "./logo.png",
          "title": "My Library",
          "description": "this is awesome library",
          "repository": "https://github.com/foo/bar",
          "site": "http://my-library.org",
          "author": "https://twitter.com/foo",
          "image": "http://my-library.org/logo.png"
        },
        "manual": {
          "index": "./manual/index.md",
          "globalIndex": true,
          "asset": "./manual/asset",
          "files": [
            "./manual/overview.md",
            "./manual/design.md",
            "./manual/installation.md",
            "./manual/usage1.md",
            "./manual/usage2.md",
            "./manual/tutorial.md",
            "./manual/configuration.md",
            "./manual/example.md",
            "./manual/advanced.md",
            "./manual/faq.md",
            "./CHANGELOG.md"
          ]
        },
        "test": {
          "source": "./test/",
          "interfaces": ["describe", "it", "context", "suite", "test"],
          "includes": ["(spec|Spec|test|Test)\\.js$"],
          "excludes": ["\\.config\\.js$"]
        }
      }
    }
  ]
}
```

The `esdoc-standard-plugin` is a glue plugin. The following plugins are used by this.
- [esdoc-lint-plugin](https://github.com/esdoc/esdoc-plugins/tree/master/esdoc-lint-plugin)
- [esdoc-coverage-plugin](https://github.com/esdoc/esdoc-plugins/tree/master/esdoc-coverage-plugin)
- [esdoc-accessor-plugin](https://github.com/esdoc/esdoc-plugins/tree/master/esdoc-accessor-plugin)
- [esdoc-type-inference-plugin](https://github.com/esdoc/esdoc-plugins/tree/master/esdoc-type-inference-plugin)
- [esdoc-external-ecmascript-plugin](https://github.com/esdoc/esdoc-plugins/tree/master/esdoc-external-ecmascript-plugin)
- [esdoc-brand-plugin](https://github.com/esdoc/esdoc-plugins/tree/master/esdoc-brand-plugin)
- [esdoc-undocumented-identifier-plugin](https://github.com/esdoc/esdoc-plugins/tree/master/esdoc-undocumented-identifier-plugin)
- [esdoc-unexported-identifier-plugin](https://github.com/esdoc/esdoc-plugins/tree/master/esdoc-unexported-identifier-plugin)
- [esdoc-integrate-manual-plugin](https://github.com/esdoc/esdoc-plugins/tree/master/esdoc-integrate-manual-plugin)
- [esdoc-integrate-test-plugin](https://github.com/esdoc/esdoc-plugins/tree/master/esdoc-integrate-test-plugin)
- [esdoc-publish-html-plugin](https://github.com/esdoc/esdoc-plugins/tree/master/esdoc-publish-html-plugin)

## LICENSE
MIT

## Author
[Ryo Maruyama@h13i32maru](https://github.com/h13i32maru)

---
_Source: https://npm.io/package/esdoc-standard-plugin · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._