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

@vroomlabs/grpc-docs

v1.0.22

Published

Command line utility to launch or debug Google's Extensible Service Proxy

Downloads

5

Readme

grpc-docs

Auto-generator for markdown documentation

Usage:

$ npm install --save-dev @vroomlabs/grpc-docs
./node_modules/.bin/grpc-docs

Scripts:

package.json script:

"scripts": {
    "doc": "grpc-docs"
}

Requirements:

If you are not already using gsdk-deploy, create the following deploy.yaml file in the root of your project.

# =============================================================================
# = Deployment configuration
# =============================================================================
dev:
  name: "search"
  host: "search-dev.catalog.com"
  google-project: "my-google-project-id"
  endpointFormat: ""
  env: []
# =============================================================================
prod:
  extends: dev
  google-project: "my-google-project-id"
  host: "search.catalog.com"
# =============================================================================

Changing Default Paths:

Modify package.json to include any or all of the following:

"grpc-docs": {
    "source": "./config/;./src/;"   // search path for all source files, default = /src;/config
    "deploy": "./deploy.yaml",      // where to find the above deploy.yaml file
    "docker": "./Dockerfile",       // where to find the associated docker file for run/env info
    "proto":  "./proto/",           // where to find proto files (if any)
    "output": "./README.md"         // where to write the output documentation file
}

Customizing Output:

Currently there is only one thing that can be manually written and automatically injected into the output, examples. Create a file named "examples.js" anywhere in the source search path. Export each example as a function from that source file.

examples.js

/**
 * A simple example method exists inside a file named "examples.js"
 * @param {string} text - A parameter we use in this example
 */
function exampleMethodName(text) {
    // do something.
}