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

esdoc-babeljs-plugin

v0.1.0

Published

An ESDoc plugin that provides support for all Babel transforms.

Downloads

1

Readme

esdoc-babel-plugin

An ESDoc plugin which loads and transforms your javascript based on your project Babel config. This allows you to write next-gen JS :metal:, using the latest and greatest features (e.g. Flowtype, ES2015+), while providing the benefits of having auto-generated documentation.

Install

npm install -S esdoc-babeljs-plugin

Usage

Add the plugin to the plugin property in your .esdoc.json config file.

{
  "source": "./src",
  "destination": "./doc",
  "plugins": [{
    "name": "esdoc-babeljs-plugin"
  }]
}

Add to your NPM scripts

{
    "scripts": {
        "gen-docs": "esdoc -c .esdoc.json"
  },
}

and run:

npm run gen-docs

License - MIT

See LICENSE for details.

Acknowledgements

This plugin is inspired by the esdoc-flow-plugin. However, this no longer appears to be actively maintained.

NOTES

Although ESDoc has support for ES2015+ core syntax, JS enhancements (e.g. Flowtype) or new syntax emerge all the time, which means that you'll probably hit a limit of what ESDoc understands. This plugin transfers your Babel setup to help ESDoc understand your code.