Nobody Preheats Microwaves

    i10010n

    0.4.3 • Public • Published

    i10010n

    coming "soon"

    • Pluralization (this might take some thinking)
      • Maybe a generic variation system to allow for more flexibility
    • Tool to generate JSON configurations

    changelog

    • 0.4.1
      • improved logging function; user logging function is now passed an error type, as seen in Error.js, as well as an object of relevant data and a message. JSDoc updates are not in yet, I didn't feel like it
    • 0.3.1
      • changed default logging function from console.error to () => {}
    • 0.3.0
      • broke the init function; now it takes an object with various configuration parameters. See the documentation for more details

    what does it do?

    i10010n allows you to easily translate your application, and dynamically use translated text when sending strings, making strings, doing other stuff with strings...

    config

    The config file is fairly basic. It is also a javascript file, not JSON. Obviously.

    Note: You can do it in JSON, but it'll take more work. See the DB used by i18n-yummy for more details.

    First, you're going to want to import some functions from i10010n:

    import { define, ID } from "i10010n";

    Then, you can configure the various template strings to support, as well as the different locales it's available in:

    import { define, ID } from "i10010n";
     
    export default {
        [ID `${0} template strings`]: {
            "yoda": define `template strings, i ${0}`
        }
    }

    Note: you can put anything you want in the ID template string values, but putting the indexes makes things a little clearer

    You don't have to define the base language, since your template strings are already in that language. Probably.

    usage

    Elsewhere, you can do this:

    import { init } from "i10010n";
    import i10010nConf from "./theplacewhereimadetheconf";
     
    const i10010n = init({DB: i18nConf});
     
    console.log(
        i10010n("yoda") `${"love"} template strings`
    );
    // "template strings, i love"

    if you're not english

    You don't have to use English for the base language.

    To specify a different base locale than "en", you can just say so when you initialize i18n, like so:

    const i10010n = init({
      DB: i18nConf,
      defaultLocale: "yoda"
    });

    Setting things up this way would mean that you write your base template strings in yoda, and anything else will be a translation of that.

    advanced(ish) usage

    Let's say you have an array of things you want to put in a translated template string. You can do this:

    const things3 = ["i18n", "internationalization", "yoda"];
     
    console.log(
        i18n("yoda") `i like 3 things:\n${
            things3.map(thing => i18n("yoda") `i like ${thing}\n`;
        }`
    );
    /*
    "3 things, i like:
    i18n, i like
    internationalization, i like
    yoda, i like"
    */

    It's like magic! Or Array.prototype.join!

    credits

    This project is quite inspired by i18n-yummy. I did rewrite everything from scratch (it's more than 9 lines, as you can probably tell), and changed some of the concepts, but the epiphany came from that.

    One difference is that there is no static locale setting. You must provide the locale with each function call. This means that you do not need to have multiple instances of i10010n in an application that may respond in different languages from the same instance.

    Install

    npm i i10010n

    DownloadsWeekly Downloads

    2

    Version

    0.4.3

    License

    MIT

    Unpacked Size

    1.07 MB

    Total Files

    38

    Last publish

    Collaborators

    • p7g