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

pennyworth

v1.0.1

Published

a natural language templating engine

Downloads

29

Readme

pennyworth Build Status

a natural language templating engine

NPM

usage

// build a template from a template string
var template = pennyworth.template('my $adjective template.');

// the template is a function that can be called with data at
// any time and multiple times
template('my beautiful template').then(function (compiled) {
	// it will always return a promise to allow support for
	// asynchronous filters

	console.log(compiled); // { adjective : 'beautiful' }
});

spec

variables

template: hello, $who.

  • for hello, alfred => $who = alfred
  • for hello, alfred. how are you? => $who = alfred how are you
  • for hello, how are you? => $who = how are you

template: hello, $who. how are you?

  • for hello, alfred. => $who = alfred
  • for hello, alferd. how are you? => $who = alfred
  • for hello, how are you? => $who = ``

variable filters

template: i am $x years old.

  • for i am 18 years old. => $x = "18"

template: i am $x:int years old.

  • for i am 18 years old => $x = 18

Supported filters: string, int, float, word.

Adding a new filter:

pennyworth.filter('my-new-filter', function ( input ) {
	return String(input) + '!';
});

var template = pennyworth.template('hello, $who:my-new-filter.');
template('hello, alfred.').who === 'alfred!'; // true

For asynchronous filters, grab a callback using this.async():

pennyworth.filter('async', function ( input ) {
	let done = this.async();
	done( error , filtered );
});

named entities

pennyworth uses the Stanford NER for named entity filters.

Supported filters (from the 7 class model): Location, Person, Organization, Money, Percent, Date, Time

To use any, just use the entity type as the filter name:

For instance, for the input string My name is Alfred Pennyworth not Wayne Mansion., if you use the filter 'string': My name is $name:string then the resolved name will be "Alfred Pennyworth not Wayne Mansion". But if you use the filter 'person', the output will be "Alfred Pennyworth".

expander

to expand a set of arguments, use curly braces:

  • {hey, hi, hello}, there will expand to:
  • hey, there.
  • hi, there.
  • hello, there.

conditional

to make a part of the expansion conditional, use a question mark:

  • i am $age {years?} expands to:
  • i am $age
  • i am $age years