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

donna-vp

v1.0.13

Published

A CoffeeScript documentation generator. (w/fixes while the main rep is being updated)

Downloads

1

Readme

Donna Build Status

Donna is a tool for generating CoffeeScript metadata for the purpose of generating API documentation. It reads your CoffeeScript module, and outputs an object indicating the locations and other data about your classes, properties, methods, etc.

It pulled out of biscotto.

Metadata??

The Donna metadata format is a very raw format indicating the locations of objects like classes, functions, and imports within files of a CoffeeScript module. Included in the metadata are unmolested doc strings for these objects.

An Example:

# Public: A mutable text container with undo/redo support and the ability to
# annotate logical regions in the text.
#
class TextBuffer
  @prop2: "bar"

  # Public: Takes an argument and does some stuff.
  #
  # a - A {String}
  #
  # Returns {Boolean}.
  @method2: (a) ->

Generates metadata:

{
  "files": {
    "spec/metadata_templates/classes/class_with_prototype_properties.coffee": {
      "objects": {
        "3": {
          "0": {
            "type": "class",
            "name": "TextBuffer",
            "bindingType": null,
            "classProperties": [],
            "prototypeProperties": [
              [
                4,
                9
              ],
              [
                11,
                11
              ]
            ],
            "doc": " Public: A mutable text container with undo/redo support and the ability to\nannotate logical regions in the text.\n\n ",
            "range": [
              [
                3,
                0
              ],
              [
                11,
                17
              ]
            ]
          }
        },
        "4": {
          "9": {
            "name": "prop2",
            "type": "primitive",
            "range": [
              [
                4,
                9
              ],
              [
                4,
                13
              ]
            ],
            "bindingType": "prototypeProperty"
          }
        },
        "11": {
          "11": {
            "name": "method2",
            "bindingType": "prototypeProperty",
            "type": "function",
            "paramNames": [
              "a"
            ],
            "range": [
              [
                11,
                11
              ],
              [
                11,
                16
              ]
            ],
            "doc": " Public: Takes an argument and does some stuff.\n\na - A {String}\n\nReturns {Boolean}. "
          }
        }
      },
      "exports": {}
    }
  }
}

The Donna metadata format is doc-string-format agnostic. Use tomdoc? Javadoc? Markdown? With this format, you should be able to generate your own API docs with any doc format parser you like.

Donna currently has a counterpart named tello that generates an easily digestible json format using the atomdoc format on the docs strings from Donna output.

Usage

npm install donna

From your code

donna = require 'donna'
metadata = donna.generateMetadata(['/path/to/my-module', '/path/to/another-module'])

From the command line

Pass it the top level directory of your module. It will read the package.json file and index any .coffee files from within the src, app, or lib directories:

donna -o donna.json /path/to/my-module

It handles multiple modules. Each should have a package.json file. It will place the results from both modules in the donna.json file.

donna -o donna.json /path/to/my-module /path/to/another-module

License

(The MIT License)

Copyright (c) 2014 GitHub

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.