Metadata-Version: 2.4
Name: jsdocscan
Version: 0.1.0
Summary: Zero-dependency CLI that finds exported functions and classes missing JSDoc
License-Expression: MIT
License-File: LICENSE
Keywords: cli,documentation,jsdoc,lint
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Documentation
Requires-Python: >=3.8
Description-Content-Type: text/markdown

# jsdocscan

Zero-dependency CLI that finds exported functions and classes missing JSDoc — or missing `@param` tags.

```
$ jsdocscan src/
✗ src/utils.js:12 formatDate  missing JSDoc
! src/api.js:34 fetchUser  undocumented params: opts
jsdocscan: 2/5 files with issues — 1 error, 1 warning
```

## Install

```bash
pip install jsdocscan
```

## Usage

```bash
jsdocscan [options] [paths...]
# or
python -m jsdocscan [options] [paths...]
```

Scans `.js`, `.ts`, `.jsx`, `.tsx`, `.mjs`, `.cjs` files. Skips `node_modules`, `dist`, `build`, `.git`, `.next`, `coverage`, `vendor`.

### Options

| Flag | Description |
|------|-------------|
| `--ext <exts>` | Comma-separated extensions, e.g. `--ext .js,.ts` |
| `--no-params` | Skip undocumented-parameter checks |
| `--json` | Output JSON (no color) |
| `--quiet, -q` | Only print the summary line |
| `-v, --version` | Print version |
| `-h, --help` | Show help |

### Exit codes

| Code | Meaning |
|------|---------|
| `0` | All exports documented |
| `1` | Issues found (errors or warnings) |

## License

MIT
