Giter VIP home page Giter VIP logo

babel-plugin-transform-typograf's Introduction

Amplifr Logo

Babel Typograf Plugin

The plugin automatically formats your translations in JS.

Features

  • It uses Typograf to format the text;
  • Also, it replaces ~ with non-breaking space. It’s easier to use than UTF-8 character, and it is visible in any editor.

Structure (our approach)

const I18N = {
  ru: {
    heading: 'Структура должна быть ',
    content: 'вот такая. Допускается ' +
             'использовать~переносы',
    array: [
      'Допускается использовать массивы',
      [
        'И массивы внутри массивов',
        'Удобно для списков'
      ]
    ]
  },
  en: {
    heading: 'Structure should be ',
    content: 'like this. It`s allowed ' +
             'to use multiline~translations',
    array: [
      'You can use arrays',
      [
        'And arrays inside of arrays',
        'It is used as lists in the main'
      ]
    ]
  }
}

🚩 Also, you can wrap the translation object with any function if translation is a first argument of this function:

const I18N = messages({...})

Example usage

const t = I18N[this.context.locale]

h('div', [
  h('h1', [t.heading])
  h('p', [t.content])
])
  • Translation should be plain otherwise it won’t be processed;
  • But Arrays are supported (used as lists in the main);
  • Anyway Functions won’t be processed.

This is mine very first Babel Plugin so please send an Issue if you have any suggestions how to improve this.

Plugin installation

  1. First of all, you need to install the package:
$ yarn add babel-plugin-transform-typograf
  1. Then you should add the plugin in your Babel config, for example, .babelrc:
  "plugins": [
    ...
    "react-hyperscript",
    "transform-typograf"
  ]

Limitations

  • It is tested with ru 🇷🇺 and en 🇺🇸 languages only for now;
  • Rules enabled: nbsp, hellip (ellipsis), apostrophe.

Tests

Run the following command to run test:

$ yarn test

It compares actual.js after transformation with an expected.js. Please note that due to unexpected behavior of Babel (it forces escaping of Cyrillic symbols), I have to add unescaping function to the test file.


Special thanks to Andrey Sitnik

babel-plugin-transform-typograf's People

Contributors

ai avatar vrizo avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

babel-plugin-transform-typograf's Issues

Add paths to npmignore

You can run npm pack to see what will be added to npm package. I think we need much more paths in .npmignore.

Add ESLint

You can use same Logux config as Amplifr

nbsp is not working

Input:

    permissionDesc2: 'Запросите доступ у коллег, пригласивших вас в проект. ' +
                     'Или~попросите~их поправить нужные настройки.'

Output:
v8f8392

@killbillsbor check new line after Или

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.