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

commonform-regexp-annotator

v2.0.0

Published

create Common Form annotators from lists of regular expressions

Downloads

3,040

Readme

commonform-regexp-annotator

The module exports a single function that takes an array of RegExp and a function for generating annotations and returns an annotator function to apply to Common Forms.

Include capture groups and flags in your RegExp as needed to match and generate annotation messages.

var expressions = [
  new RegExp('\\b(apple(s?))\\b', 'gi'),
  /\b(thereof)\b/
]

The annotation function receives the form in which a RegExp was found, its path within the overall form, the RegExp that matches, and the match data from RegeExp.prototype.exec. It must return a [Common Form Annotations][annotation]

[annotation]: https://npmjs.com/packages/commonform-annotation)

function message (form, path, expression, match) {
  var word = match[1]
  return {
    message: (
      match[1].indexOf('apple') > -1
        ? ('"' + word + '" is fruity')
        : ('"' + word + '" is archaic')
    ),
    path: path,
    source: 'example-annotator',
    url: null
  }
}

var reAnnotator = require('commonform-regexp-annotator')

var annotator = reAnnotator(expressions, message)

The library does the job of finding matches and calculating paths.

var assert = require('assert')

assert.deepStrictEqual(
  annotator({
    content: ['Drop them apples and the apple stem thereof!']
  }),
  [
    {
      message: '"apples" is fruity',
      path: ['content', 0],
      source: 'example-annotator',
      url: null
    },
    {
      message: '"apple" is fruity',
      path: ['content', 0],
      source: 'example-annotator',
      url: null
    },
    {
      message: '"thereof" is archaic',
      path: ['content', 0],
      source: 'example-annotator',
      url: null
    }
  ]
)