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
1 maintainer
Metadata
1 maintainer
Release files for jsdocscan 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| jsdocscan-0.1.0.tar.gz | 6.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| jsdocscan-0.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 13.4 kB
Release files / jsdocscan-0.1.0.tar.gz
| Download URL | jsdocscan-0.1.0.tar.gz |
|---|---|
| Size | 6.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
79c5f35d4db1448a90f309ce82576e70b6ec53beef1ab5ad9059b72f8a0c3d6a
|
|
BLAKE2b-256 checksum How to use checksums |
5720cf0c32f7ab6f50a1a263f9c01907f823df97db17dc52ddb9fff92a0e18fa
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.11.7
|
Release files / jsdocscan-0.1.0-py3-none-any.whl
| Download URL | jsdocscan-0.1.0-py3-none-any.whl |
|---|---|
| Size | 6.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c1077c8c6f6e367a6073d99212d84e1f18736f2b6b6f3e54d931896ca29696bb
|
|
BLAKE2b-256 checksum How to use checksums |
027914857b97ad3e701d3b21eef68ef7479f3f2030318dac3df6136f4dc4f2b0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.11.7
|
