Awesome
textr
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
.
There are plugins for PostHTML
Few words for plugin creators
:+1::tada: First off, you are awesome and thanks for taking the time to contribute! :tada::+1:
Testability
As far as we want to go beyond monolythic typographic engines, then
we (as ecosystem) need to have small atomic 100% covered with tests plugins.
That’s why please have index.js
and test.js
in the repository
and .travis.yml
to validate pull-requests. Badges about npm version,
passing tests and tests coverage are optionable, but preferred.
Give a chance to npm scripts as cross-platform tool for automatization.
README
Everyone will read README, and only ones—sources. Please include in your readme file following sections: package name, description, installation instructions, usage section with spec from tests and license note. License note is important for enterprise users. We want to create ecosystem, so it’s reasonable to have a link to textr in README’s plugins, good place for it is in the top, maybe in the short description.
'locale' option consistence
tl;dr: Use ISO 639 and rely on locale codes like these: en-uk
,
en-us
, zh-Hans
, ru
, da
, sv
—regular values for lang
attribute.
Typography is locale dependent by it’s nature, that’s why locale
option
is most usable option and this is a good reason to be consistent about. We looked
around and found that ISO 639 standard is very well fits us, the fact that
it was chosen by w3c for defining lang attribute assure us to use this
unification.
License
MIT © Shuvalov Anton, Vladimir Starkov