npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2026 – Pkg Stats / Ryan Hefner

autojsdoc

v1.0.1

Published

CLI tool for auto-generating JSDoc comments in JavaScript and TypeScript files

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Maintainers

gizebonillagizebonilla

Keywords

jsdocdocumentationjavascripttypescriptcliautojsdoccode-commentsdeveloper-tools

Readme

AutoJSDoc NPM

AutoJSDoc is a CLI tool designed to automatically generate JSDoc comments for your JavaScript and TypeScript functions. It helps streamline the process of documenting code by adding function descriptions and types based on inferred parameter names and return types.

Features

  • Automatically generates JSDoc comments for JavaScript and TypeScript functions.
  • Supports --overwrite option to replace existing comments.
  • Supports --dry-run to preview changes without modifying files.
  • Easily integrates into your existing workflow.

Installation

You can install AutoJSDoc globally or as a project dependency.

Global Installation

To install AutoJSDoc globally, run the following command:

npm install -g autojsdoc

Project Installation

To install AutoJSDoc as a project dependency, run the following command:

npm install --save-dev autojsdoc

Usage

After installation, you can run AutoJSDoc from the command line.

Generate JSDoc for a JavaScript File

autojsdoc <path-to-your-file.js>

Generate JSDoc for a TypeScript File

autojsdoc <path-to-your-file.ts>

Options

• -o, --overwrite: Overwrite existing JSDoc comments. • --dry-run: Preview the output without modifying files.

Example

autojsdoc examples/example.js --overwrite

This will generate JSDoc comments for all functions in example.js, overwriting any existing comments.

Development

To contribute or make changes to AutoJSDoc, follow these steps:

  1. Clone the repository:
git clone https://github.com/XixeBombilla/AutoJSDoc.git
  1. Install dependencies:
npm install
  1. Run tests and make changes as needed.

License

Distributed under the MIT License. See LICENSE for more information.