# @environment-safe/jsdoc-builder

> Build jsdoc directly into docs and types.

Latest version **0.0.3** (published 2024-01-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install @environment-safe/jsdoc-builder
pnpm add @environment-safe/jsdoc-builder
yarn add @environment-safe/jsdoc-builder
bun add @environment-safe/jsdoc-builder
```

Provides the command `build-jsdoc`.

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2024-01-15 |
| First published | 2023-07-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 6 |
| Unpacked size | 1018 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Abbey Hawk Sparrow |
| Maintainers | khrome |

## Links

- npm: https://www.npmjs.com/package/@environment-safe/jsdoc-builder
- Repository: https://github.com/environment-safe/jsdoc-builder
- Issues: https://github.com/repos/environment-safe/jsdoc-builder/issues
- npm.io page: https://npm.io/package/@environment-safe/jsdoc-builder

## Dependencies (6)

- [glob](https://npm.io/package/glob.md) ^10.3.3
- [jsdoc](https://npm.io/package/jsdoc.md) ^4.0.2
- [async-arrays](https://npm.io/package/async-arrays.md) ^2.0.0
- [browser-or-node](https://npm.io/package/browser-or-node.md) ^2.1.1
- [jsdoc-to-markdown](https://npm.io/package/jsdoc-to-markdown.md) ^8.0.0
- [@environment-safe/tsd-jsdoc](https://npm.io/package/@environment-safe/tsd-jsdoc.md) ^3.0.0

## Recent versions

- 0.0.3 (latest) — 2024-01-15
- 0.0.2 — 2023-07-21
- 0.0.1 — 2023-07-20

## README

jsdoc-builder
============================
Build types and docs from jsdoc annotations.

Usage
-----

```bash
npm install --save-dev jsdoc-builder
npm pkg set scripts.build-docs="build-jsdoc docs"
npm pkg set scripts.build-types="build-jsdoc types"
npm run build-docs
npm run build-types
```

Testing
-------

Run the es module tests to test the root modules
```bash
npm run import-test
```
to run the same test inside the browser:

```bash
npm run browser-test
```
to run the same test headless in chrome:
```bash
npm run headless-browser-test
```

to run the same test inside docker:
```bash
npm run container-test
```

Run the commonjs tests against the `/dist` commonjs source (generated with the `build-commonjs` target).
```bash
npm run require-test
```

Development
-----------
All work is done in the .mjs files and will be transpiled on commit to commonjs and tested.

If the above tests pass, then attempt a commit which will generate .d.ts files alongside the `src` files and commonjs classes in `dist`

---
_Source: https://npm.io/package/@environment-safe/jsdoc-builder · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._