Zero-dependency CLI that finds exported functions and classes missing JSDoc
Project description
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
pip install jsdocscan
Usage
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
jsdocscan-0.1.0.tar.gz
(6.7 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file jsdocscan-0.1.0.tar.gz.
File metadata
- Download URL: jsdocscan-0.1.0.tar.gz
- Upload date:
- Size: 6.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
79c5f35d4db1448a90f309ce82576e70b6ec53beef1ab5ad9059b72f8a0c3d6a
|
|
| MD5 |
420ee57682d5ff402fdabbf24ab5a267
|
|
| BLAKE2b-256 |
5720cf0c32f7ab6f50a1a263f9c01907f823df97db17dc52ddb9fff92a0e18fa
|
File details
Details for the file jsdocscan-0.1.0-py3-none-any.whl.
File metadata
- Download URL: jsdocscan-0.1.0-py3-none-any.whl
- Upload date:
- Size: 6.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c1077c8c6f6e367a6073d99212d84e1f18736f2b6b6f3e54d931896ca29696bb
|
|
| MD5 |
a75a8d2a856186fd993fe42c764a0712
|
|
| BLAKE2b-256 |
027914857b97ad3e701d3b21eef68ef7479f3f2030318dac3df6136f4dc4f2b0
|
