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 🙏

© 2024 – Pkg Stats / Ryan Hefner

es-code-docer

v1.0.0

Published

Generates code documentation for ECMAScript files

Downloads

4

Vulnerabilities

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

Links

Maintainers

titannanotitannano

Keywords

esjsdoc

Readme

ES Code Docer

Greenkeeper badge Build Status David GitHub release npm npm

ES Code Docer is a modern code documentation tool for ECMAScript. The CLI application is designed for ECMAScript modules and supports the JSDoc comment syntax. Source Code files are parsed with the acorn ECMAScript parser and analysed for type information. The identified type information will be combined with the JSDoc type annotations and then rendered into the documentation.

Notice

ES Code Docer is not quite complete yet. If you have trouble running it on your project, feel free to file an issue for it.

Installation

npm -g i es-code-docer

Usage

es-code-docer ./src/

Multiple source files can be specified. For every file code docer will search for a package.json in order to deduce the project root. Currently there are three options for rendering the documentation which are hard coded at the moment. The options will be exposed soon and can be changed inside the index.js file for the time being.

Supported Render Outputs

ES Code Docer currently only implements a Markdown renderer, to implement additional renders should be straight forward though.

Supported JSDoc Tags

At the moment only the most important JSDoc tags are supported in the code docer.

  • @type
  • @return(s)
  • @private
  • @param
  • @deprecated

If not specified aliases are not supported. ES Code Docer tries to implement the JSDoc tags the way they are specified by JSDoc, but this is not always possible. JSDoc namepaths are not supported and most likely will never be. This is due to the fact, that ES Code Docer is based on the ECMAScript modules and does not implement the JSDoc module system.