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

yadop

v1.3.1

Published

Yet another Doc Parser

Downloads

6

Readme

yadop

Yadop (Yet Another Doc Parser) is a JSDoc parser that uses Espree and Doctrine to process your sources.

Installation

You can install Yadop using npm:

$ npm install yadop --save-dev

Usage

Require yadop inside of your JavaScript:

var yadop = require("yadop");

JSDoc

In order to process the jsdoc you can execute the following:

yadop.jsdoc.processor({
    cwd: 'directory/containing/sources', // the source directory
    pattern: '*/*.js' // the pattern
}).process();

NGDoc

In order to process the ngdoc you can execute the following:

var comments = yadop.ngdoc.processor({
    cwd: 'directory/containing/sources', // the source directory
    pattern: '*/*.js' // the pattern
}).process();

var results = yadop.ngdoc.mapper().map(comments);

Configuration

Both the yadop.jsdoc.processor and the yadop.ngdoc.processor are called with a configuration object. This object contains the following attributes:

cwd

Type: string Default: current working directory Mandatory: false

The current working directory.

pattern

Type: string Default: **/*.js Mandatory: false

The file pattern.

ignore

Type: string Default: [] Mandatory: false

The ignore patterns.

Example

{
    cwd: 'directory/containing/sources', // the source directory
    pattern: '*/*.js' // the pattern
}

Available functions

yadop.jsdoc.processor

Type: Function Param: Configuration The configuration object as seen above. Returns: doctrineComment[]

Processes jsdoc for each file in the specified cwd.

yadop.ngdoc.processor

Type: Function Param: Configuration Returns: doctrineComment[]

Processes jsdoc for each file in the specified cwd but only containing the ngdoc tags.

yadop.ngdoc.mapper

Type: Function Param: doctrineComment[] Returns: yadopModule[]

Processes a doctrineComment[] and returns a yadopmodule[].

Example

[{ "name": "my-module" }, {
    "name": "another-module",
    "entities": [{
        "name": "my-component",
        "type": "component",
        "attributes": [{
            "name": "items",
            "optional": false,
            "description": "Some attribute",
            "type": "Object[]"
        }, {
            "name": "items[].name",
            "optional": true,
            "description": "The (optional) name of the item",
            "type": "string"
        }, {
            "name": "items[].value",
            "optional": false,
            "description": "The value of the item",
            "type": "number"
        }]
    }, {
        "name": "SomeService",
        "type": "service",
        "methods": [{
            "name": "SomeService#sayWhat",
            "description": "Says what.",
            "params": [{ "name": "who", "description": "Who said it", "type": "string" }, {
                "name": "when",
                "description": "When to say"
            }]
        }, {
            "name": "SomeService#welcome",
            "description": "Say welcome",
            "returns": { "name": "message The message", "type": "object" }
        }]
    }, { "name": "AnotherService", "type": "service" }]
}]