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

therror-doc

v0.2.0-rc.0

Published

Documentation parser for therror

Downloads

6

Readme

therror-doc

Documentation parser for therror

npm version Build Status Coverage Status

Creates a javascript object with all the documentation present in therror errors registrations. Once you have this, you will have the possibility to:

  • Filter the errors based on your custom criterias, to make versions for developers, delivery teams, operation teams.
  • Create Web pages with rich errors description
  • Create Markdown files
  • Anything you can imagine!

Installation

 npm install --save-dev therror-doc

You can also save globally and use the cli to generate docs

 npm install -g therror-doc
 therror-doc lib/*.js > errors.json

Examples

CLI

$ therror-doc --help

  Usage: therror-doc <file ...> [options]

  Generate a json with the errors documentation for the provided files

  Options:

    -h, --help     output usage information
    -V, --version  output the version number

  Examples:

  Get and generate error doc from js files in lib directory, output to stdout
    $ therror-doc lib/*.js
  Get and generate error doc from all node_module dependencies, output to file (bash)
    $ therror-doc $(find node_modules -name *.js) > errors.json

Exit Codes:

  • 0: All went fine
  • 1: Something failed. Check your stderr for details.

API

Give your file paths to the parser, and it will produce an static js object ready for JSONification

var therrorDoc = require('therror-doc');

therrorDoc.parse([
    './server-errors.js',
    './client-errors.js'
  ], function onParse(err, data) {
    console.log(JSON.stringify(data, null, 2));
  }
);

Current limitations

At this time, the parser only understands error registrations using exactly an asignation of a therror.register(...) call.

var something = therror.register('NAMESPACE', {...});
module.exports = therror.register({...});
therror.register({...});

Knowing which variable holds the therror module on a file should not be difficult enought (as the parser is using an esprima AST)

LICENSE

Copyright 2014,2015 Telefónica I+D

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.