npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@benricheson101/i18n

v1.3.1

Published

A very tiny Node.js internationalization library

Downloads

19

Readme

Usage:

  1. Install i18n
$ yarn add @benricheson101/i18n
# or
$ npm install @benricheson101/i18n
  1. Import and instantiate the constructor
const I18n = require('@benricheson101/i18n')
const i = new I18n({ fallback: 'en' })
  1. Parse yaml
i.parseDir('./i18n')
  .parseFile('./en.yml')
  .parse(`
en:
  STRING: 'aaaaaa'
  PLACEHOLDER: 'This has a placeholder: %{food}'
  COMMAND:
    MAN:
      SHORT_DESC: 'Read a command\'s manual'
    OPTIONS:
      - 'works'
      - 'with'
      - '%{datatype}'
      - 'too'
  `)
  1. Use the string methods!
i.get('en', 'STRING') // aaaaaa
i.replace('en', 'PLACEHOLDER', { food: 'potato' }) // This has a placeholder: potato
i.get('en', 'COMMAND:MAN:SHORT_DESC') // Read a command's manual
i.replace('en', 'OPTIONS', { datatype: 'arrays' }) // ['works', 'with', 'arrays', 'too']

Options and Methods:

Constructor Options:

  • fallback: string - set a fallback language code

Parse Methods:

  • parseDir(dir: string) - adds all files ending in .yml from the specified dir
  • parseFile(file: string) - adds a single file
  • parseRecursive(dir: string) - adds all yaml files in a dir/subdirs recursively
  • parse(yaml: string, file?: string) - adds a yaml string

Generator Method:

  • generate(code?: string) - generate missing strings for all files. (See below for explanation)

String Methods:

  • get(code: string, stringKey: string) - gets a string
  • replace(code: string, stringKey: string, placeholders: object) - gets a string and replaces placeholders

Setters/Getters:

  • regex () = placeholder_regex: RegExp - regex for extracting and replacing placeholders. note: the placeholder name capture group MUST be named placeholder

Static Properties:

  • langs - a set contain all of the added language codes
  • strings - the added language files/strings
  • raw - an array of raw language file data

Usage Example:

Basic Parsing:

# i18n/en.yml
en:
  STRING: 'This is a string'
  STRING_WITH_PLACEHOLDER: 'This is a placeholder: %{placeholder}'
  NESTED:
    OBJECTS:
      WORK:
        TOO: 'abcde'

Note: yaml files must start with the language code on the first line, with no indentation, followed by translated strings. Refer to the above example.

const i = new I18n()
  .parseDir('./i18n')

 i.get('en', 'STRING') // This is a string
 i.replace('en', 'STRING_WITH_PLACEHOLDER', { placeholder: 'abc123' }) // This is a placeholder: abc123
 i.get('en', 'NESTED:OBJECTS:WORK:TOO') // abcde

Using the Generator:

What does it do?

Imagine you add 100 new strings to en.yml. Your translators may have a difficult time seeings which strings are missing or could easily miss one. The generator will add all of the new strings from the default (fallback) language as empty strings so it is easy to see what must be added and what already exists

Example:

# i18n/en.yml
en:
  food:
    fruits:
      - apple
      - banana

generator:
  id: foods

# ------
# i18n/es.yml
es: {}

generator:
  id: foods

Note: the generator.id property can be anything (string or number); after running the generator, all files with the same generator.id will have the same structure and strings. setting generator.ignore to false or not including a generator object at all will ignore the file.

new I18n({ fallback: 'en' })
  .parseDir('./i18n')
  .generate()

Note: the generate function returns the class instance, so methods can be chained.

After running the generate function, i18n/es.yml will look like this:

es:
  food:
    fruits:
      - ''
      - ''
generator:
  id: foods