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

textr

v0.3.0

Published

Tiny and extendable text transforming framework

Downloads

134,892

Readme

textr

NPM version Build Status Coveralls Status Dependency Status DevDependency Status

Textr is simple framework to compose text transformation functions

Textr is good instrument to create modular tools to make your typography better. It can compose any functions that get text, transform it and return result of processing. For example, check out few: typographic-quotes, typographic-math-symbols, typographic-em-dashes and typographic-ellipses.

Plugins are available on npm, labelled with textr keyword. Also you can easily create new one. Don’t be scared.

Idea behind textr

Typography for everybody! At the same time it’s impossible to create one ideal typographic engine. It doesn’t work this way. What we can do with it? We can easily create and maintain small, simple, full-tested and single responsible modules. After this we can compose bunch of these well done modules for every specific situation we need, and everybody will be happy with it’s own ideal text transformer.

Install

npm install --save textr

Usage

var textr    = require('textr');
var ellipses = require('typographic-ellipses');
var spaces   = require('typographic-single-spaces');
var quotes  = require('typographic-quotes');

// Create new text transformer by compose yours
tf = textr({ locale: 'ru'})
  .use(ellipses)
  .use(spaces)
  .use(quotes)
  .use(String.prototype.trim)
;

// then just send some text to the transformer
tf('Hello  "world"...\n'); // Hello «world»…

API

textr(defaults)

Create new textr transform function (tf). You can pass default options when create new transform stack.

tf.use(...fn)

Register transform function as tf middleware.

tf.exec(text, options)

Process given text by the middlewares.

tf(text)

Identical to tf.exec(text). This alias makes tf just regular transform function, that you can register as middleware for textr as well.

var typorgapher = textr().use(typography, tools, here)
var autocorrector = textr().use(autocorrection, things)
var smiles = textr().use(text, to, smiles, goodies)

var tf = textr()
  .use(typographer)
  .use(autocorrector)
  .use(smiles)
;

tf(text); // oh, that's awesome!11

Plugins API

Each plugin will be called with 2 arguments: text and options setted on textr().

function plugin(text, options) {
  console.log(options); // { locale: 'ru' }
  return text;
}

To support String.prototype methods as transformation functions, this value is equal to the text.

License

MIT © Shuvalov Anton, Vladimir Starkov