Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

sprintf-kit

Package Overview
Dependencies
Maintainers
1
Versions
10
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

sprintf-kit

sprintf parser and basic formatter

  • 2.0.2
  • unpublished
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
1M
decreased by-0.17%
Maintainers
1
Weekly downloads
 
Created
Source

Build status Tests coverage npm version

sprintf-kit

sprintf parser and basic formatter

Installation

npm install sprintf-kit

Utilities

Parser

Parses format string into data map with respect to printf syntax

const parse = require("sprintf-kit/parse");

const data = parse("Some %s with %d count");

// `data` resolves with following content:
{
  literals: ["Some ", " with ", " count"],
  placeholders: [
    { type: "s", content: "%s" },
    { type: "d", content: "%d" }
  ],
  isParameterIndexingValid: true
}

data spec:

  • literals - Surrounding string literals
  • placeholders - Meta data of parsed placholders. Placeholder properties map (refer to spec for explanation of each property)
    • parameter - (optional) parameter setting (e.g. 1)
    • flags - (optional) array of flags (e.g. ["0", "-"])
    • width - (optional) width (e.g. 4 or "*" if dynamic)
    • precision - (optional) precision (e.g. 4 or "*" if dynamic)
    • length - (optional) length (e.g. "z")
    • type - Modifier type (e.g. "s" or "d")
    • content - Full string representation of placeholder (e.g. "%s")
  • isParameterIndexingValid - Whether parameter indexing is valid across all placeholders. e.g. if no placeholders come with parameters it'll be true. If some but not all of them will come with parameters, it'll be false (if used, then all placeholders should use them).
Format function generator
// Configure format function that resolves 's' and 'd' modifiers
let format = require("sprintf-kit")({
  d: require("sprintf-kit/modifiers/d"),
  s: require("sprintf-kit/modifiers/s")
});

format("Some %s with %d count %x boo", "foo", 12, "ignored"); // Some foo with 12 count %x boo

// Special `rest` formater can be used to handle leftover arguments

format = require("sprintf-kit")({
  d: require("sprintf-kit/modifiers/d"),
  s: require("sprintf-kit/modifiers/s"),
  rest: args => " " + args.join(" ")
});

format("Some %s with %d count", "foo", 12, "rest", "args"); // Some foo with 12 count rest args

// Message string literals (all but placeholders text) can be additionally decorated
// Useful when we want to apply some specific color to message without affecting format of special arguments

const clc = require("cli-color");

format = require("sprintf-kit")({
  d: require("sprintf-kit/modifiers/d"),
  s: require("sprintf-kit/modifiers/s"),
  literal: literal => clc.red(literal)
});
Parts resolver generator

Resolver returns resolved data in form of object parts, which maybe helpful if additional programmatical processing is needed

// Configure format function that resolves 's' and 'd' modifiers
let resolve = require("sprintf-kit/get-resolver")({
  d: require("sprintf-kit/modifiers/d"),
  s: require("sprintf-kit/modifiers/s")
});

resolve("Some %s with %d count %x boo", "foo", 12, "ignored");
// {
//   literals: ["Some ", " with ", " count ", " boo"],
//   substitutions: [
//     { value: "foo", placeholder: { type: "s", content: "%s" } },
//     { value: "12", placeholder:  { type: "d", content: "%d" } },
//     { value: "%x", placeholder: { type: "x", content: "%x" }
//   ],
//   rest: null
// }

resolve = require("sprintf-kit/get-resolver")({
  d: require("sprintf-kit/modifiers/d"),
  s: require("sprintf-kit/modifiers/s"),
  rest: args => " " + args.join(" ")
});

resolve("Some %s with %d count", "foo", 12, "rest", "args");
// {
//   literals: ["Some ", " with ", " count"],
//   substitutions: [
//     { value: "foo", placeholder: { type: "s", content: "%s" } },
//     { value: "12", placeholder:  { type: "d", content: "%d" } }
//   ],
//   rest: " rest args"
// }
Preconfigured modifiers

Currently just basic modifiers are configured in (PR's welcome to extend this support).

Modifiers can be found at sprintf-kit/modifiers folder.

Preconfigured modifiers

  • d - Number
  • f - Floating point value
  • i - Integer
  • j - JSON
  • s - String

Every modifier is exception safe, in case of approaching invalid value, adequate error message token is displayed in place of placeholder

Tests

npm test

Project cross-browser compatibility supported by:

Security contact information

To report a security vulnerability, please use the Tidelift security contact. Tidelift will coordinate the fix and disclosure.

Keywords

FAQs

Package last updated on 30 May 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc