typograf

Типограф на JavaScript

Типограф

Помогает автоматически расставлять неразрывные пробелы, исправлять мелкие опечатки, приводить кавычки к правильному виду, заменять дефисы на тире в нужных местах и многое другое.

Типограф в действии с мобильной версией

Черты:

• гибкость и расширяемость;
• UTF-8;
• кроссплатформенность;
• кроссбраузерность;
• поддержка Node.js;
• типографирование на лету;
• TDD.

Поддерживаемые правила

Форматы:

• TXT
• HTML
• XML
• SVG

Использование

В браузере

bower install typograf

<script src="dist/typograf.min.js"></script>
<script>
    var tp = new Typograf({lang: 'ru'});
    alert(tp.execute('     Мир - мой мир!      '));
</script>

Node.js

npm install typograf

var Typograf = require('typograf'),
    tp = new Typograf({lang: 'ru'});

console.log(tp.execute(' Мир - мой мир!!   '));

Плагины

• grunt-typograf
• gulp-typograf

Командная строка

npm install typograf -g

typograf — вывод справки

typograf -l ru my_file.txt — типографировать текст по русским правилам

typograf -l en my_file.txt — типографировать файл по английским правилам

typograf -l ru -d ru/punctuation/quot -e ru/optaling/* my_file.txt > new_my_file — типографировать файл с отключенным правилом ru/punctuation/quot и включенными правилами ru/optaling/*

API

Висячая пунктуация

По умолчанию висячая пунктуация отключена.

Для включения необходимо подключить правила:

var Typograf = require('typograf'),
    tp = new Typograf({lang: 'ru'});

tp.enable('ru/optalign/*');
console.log(tp.execute('"Мир"'));

А также в HTML-код страницы добавить:

<link rel="stylesheet" href="dist/typograf.css" />

Включить/отключить правило

var tp = new Typograf({lang: 'ru'});
tp.enable('ru/money/ruble'); // Включить правило
tp.enable('ru/money/*'); // Включить все правила в группе
tp.enable('*'); // Включить все правила
//...
tp.disable('ru/money/ruble'); // Отключить правило
tp.disable('ru/money/*'); // Отключить все правила в группе
tp.disable('*'); // Отключить все правила

Изменить настройку у правила

var tp = new Typograf({lang: 'ru'});
// Название правила, название настройки, значение
tp.setting('common/nbsp/beforeShortLast', 'lengthLastWord', 5);

Добавить простое правило

Typograf.rule({
    name: 'common/other/emoji',
    handler: function (text) {
        return text.replace(/:-\)/g, '\uD83D\uDE0A');
    }
});

Режим работы

// Режим по умолчанию, HTML-сущности, как UTF-8 символы
var tp = new Typograf({lang: 'ru'});
tp.execute('...'); // …

// HTML-сущности, как имена
var tpName = new Typograf({lang: 'ru', mode: 'name'});
tpName.execute('...'); // …

// HTML-сущности, как цифры
var tpDigit = new Typograf({lang: 'ru', mode: 'digit'});
tpDigit.execute('...'); // …

Типографика на лету

var tp = new Typograf({lang: 'ru', live: true});
tp.execute('"Мир"');

Подробнее

Сжатие с UglifyJS

Если typograf.js сжимается вместе с другими js-файлами в UglifyJS, то необходимо использовать опцию ascii_only: false, иначе типограф будет работать некорректно.

Разработка

git clone https://github.com/typograf/typograf.git

Пересборка: gulp

Пересборка и запуск тестов: npm test

Подготовка новой версии: gulp dist

Лицензия

MIT License

Ссылки

• Букмарклет для типографа
• Средство поиска опечаток в текстах
• Восстановление буквы «ё» в русских текстах

Changelog

v3.3.0

Типографирование на лету

var tp = new Typograf({lang: 'ru', live: true});

У правил появилось дополнительное свойство live #133, #139.

// Добавляем правило
Typograf.rule({
    name: 'common/other/emoji',
    live: false,
    handler: function (text) {
        return text.replace(/:-\)/g, '\uD83D\uDE0A');
    }
});

live: true — правило работает только в режиме типографирования на лету. live: false — правило не работает на лету.

Доработки

• Исправлены сложные случаи с кавычками и HTML-тегами #131
• Не типографировать экранированные HTML-теги #138