typograf

Типограф на JavaScript

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

Попробуйте типограф в действии.

Черты:

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

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

Форматы:

• TXT
• HTML
• XML
• SVG

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

В браузере

npm install typograf

<script src="./node_modules/typograf/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

Командный интерфейс

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/beforeShortLastWord', '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

v4.0.0

Новые правила

• Нераз. пробел после сокращений «см.» и «им.» ru/nbsp/see
• Пробел перед многоточием, !.. и ?.. ru/space/afterHellip
• Тире между днями в одном месяце ru/dash/daysMonth
• Тире в интервалах времени ru/dash/time
• Тире в десятилетиях ru/dash/decade

Правило ru/dash/main разделено на несколько правил:

• Замена дефиса на тире в веках ru/dash/centuries
• Замена дефиса на тире в годах ru/dash/years
• Тире в прямой речи ru/dash/directSpeech
• Сокращения с помощью тире ru/dash/surname

Переименование правил

• common/sym/* → common/symbols/*
• ru/punctuation/quot → ru/punctuation/quote
• en/punctuation/quot → en/punctuation/quote
• ru/optalign/quot → ru/optalign/quote
• ru/nbsp/xxxx → ru/nbsp/year
• common/nbsp/afterPara → common/nbsp/afterParagraph
• ru/date/main → ru/date/fromISO
• ru/nbsp/cc → ru/nbsp/centuries
• common/punctuation/exclamation → ru/punctuation/exclamation
• common/punctuation/exclamationQuestion → ru/punctuation/exclamationQuestion

Прочее

• Неразрывный тонкий пробел после № и §
• Командный интерфейс перенесен в отдельный репозиторий
• Удалено свойство index у большинства правил
• Рефакторинг регулярных выражений в правилах
• Исправлены неточности в описаниях правил