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

inks

v3.0.1

Published

Interpolate values from a shared context into a string template.

Downloads

4,795

Readme

inks

Interpolate values from a shared context into a string template (or another object).

Substitutes sections of a string marked with `` by evaluating contents. As a convenience, the values can be referenced from a context object.

Used by seneca-msg-test to support back references to earlier test results.

npm version Build Coverage Status DeepScan grade Maintainability Dependency Status

Quick Example

const Inks = require('inks')

var out = Inks('`foo:bar`', {foo:{bar:'zed'}}) 
// out === 'zed'

out = Inks({deep:'`foo:bar`'}, {foo:{bar:'zed'}}) 
// out === {deep:'zed'}

out = Inks({deep:'`$.foo`'}, {foo:{bar:'zed'}}) 
// out === {deep:{bar:'zed'}}

Another example, where $ references the context object.

const context = { red: { foo: 1, bar: 'zed'}, green: { fizz: { buzz: 'FRED' }} }
const template = 'Lorem `red:foo` ipsum `$.red.foo + $.red.bar.length` dolor `green:fizz.buzz` sit \\` amet.'

const result = Inks(template, context)

// prints:
// Lorem 1 ipsum 4 dolor FRED sit ` amet.

Notes

  • Value reference syntax: key:dot-path.
  • General form: <js-expression> where $ === context.
  • Single values are not converted to a string and retain their type: red:foo -> 1 not '1'.
  • Anything that is not a number or string is converted to a string (if embedded) using JSON.stringify.
  • Escape backticks by prefixing with a backslash:
'a\\`b' -> 'a`b'

Questions?

@rjrodger

License

Copyright (c) 2018-2020, Richard Rodger and other contributors. Licensed under MIT.