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

grumpf

v1.0.1

Published

Extracts //@generic tags in source code

Downloads

15

Readme

Grumpf the Generic Todo Extractor

Build Status

Note this is just the parser, for a CLI, please see grumpf-cli

This parser extracts tags like //@todo or //@fix(function): descripion from source code. In theory, any C-Like language, that uses // or /* for comments should work, but it was designed around JavaScript/TypeScript.

Format

The parser tries to accommodate many different styles, but the base format is: // @TYPE(SCOPE): DESCRIPTION, however, the following should work too (and any combination thereof):

  • //@TYPE: DESCRIPTION
  • /* @TYPE([SCOPE]): DESCRIPTION
  • * @TYPE DESCRIPTION
  • // @TYPE: DESCRIPTION

Usage

grumpf exposes one main method: parse(code: string, plugins?: Map<string, Plugin>), that returns an array of Tags.

import {parse} from 'grumpf';
import {readFileSync} from 'fs';
let tags = parse(readFileSync('src/index.js'), 'utf8'));

Tag-Type

type Tag = {
    tagName: string,
    scope: string,
    params: Map<string, string>,
    body: string,
    meta: Object
}

Plugins

grumpf supports transforming or decorating tags using plugins. These plugins must simply comply to the interface below:

Plugin-Interface

interface Plugin {
    (tag: Tag, params: Map<string, string>, lines: string[]): Tag;
}

Git Commit Messages

  • Use the past tense ("Added feature" not "Add feature")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally
  • Consider starting the commit message with an applicable emoji:
  • ➕ when adding a feature
  • ➖ when removing a feature
  • 🎉 when improving a feature
  • 🎨 when improving the format/structure of the code
  • 🐎 when improving performance
  • 🚱 when plugging memory leaks
  • 🔞 when using dirty hacks
  • 📝 when writing docs
  • 🐛 when fixing a bug
  • 🔥 when removing code or files
  • 💚 when fixing the CI build
  • 💻 when making changes to the infrastructure
  • ✅ when adding tests
  • 🔒 when dealing with security
  • ⬆️ when upgrading dependencies
  • ⬇️ when downgrading dependencies
  • 👕 when removing linter warnings

(source)