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

i18n-webpack-plugin-generate-json

v1.1.0

Published

Generate translation json files for i18n-webpack-plugin

Downloads

3

Readme

Generate translation json files for i18n-webpack-plugin

i18n-webpack-plugin is great, but making translation files can be a big manual job! This script will search your app and generate translation json files for you. It's actually not tied to i18n-webpack-plugin at all. In fact I use it with my own translation function that is called at runtime. For that reason I provide the option to make your keys transformed to snake-case. This is my personal preference.

Example package.json

  scripts: {
    "i18n-generate": "i18n-generate -d src -l 'de cn'"
  }

Example app code

  <span>{__('oh hi, I need to be translated')}</span>
  <span>{__('this script will save me *NUMBER* hours').replace('*NUMBER*', 73)}</span> // variable replacement

Install

npm i i18n-webpack-plugin-generate-json --save-dev

Run

  1. add a script (see example package.json)
  2. npm run i18n-generate

Options

  • -d, -directory, REQUIRED, default [none]
  • -f, -functionName, default [__]
  • -o, -outputDirectory, default [translations]
  • -l, -languages, default ['en']
  • -t, -transformise, default [false] : Transformises using lower snake case whilst preserving the * character to be used for variable substitution. e.g. the key for __('i have *number* ducks') is 'i_have_*number*_ducks'
  • -p, -prefix, default [!!] : The prefix is so you can see visually what translations have been mapped in your application. It also allows this script to regenerate your un-translated sentences.

Example using lower-snake-case keys

  import { transformise } from 'i18n-webpack-plugin-generate-json';
  // custom translate function
  export function translate(translations, key) {
    const translation = translations[transformise(key)];
    if (translation) return translation;    
    return key;
  }

Example React + Webpack project

https://github.com/mattcolman/i18n-webpack-plugin-generate-json-example

Gotchas

  1. The script searches for the functionName and expects the contents to start with a single or double quote. So if you have something like <span>{__(`twelve ${animal}s`)}</span> or <span>{__(isHello ? 'hello' : 'hi')}</span>, it won't work! I don't think you need to do either of these things. The first example is a variable replacement, so it will need to use the method shown in the example code above. The second example can be re-written as <span>{isHello ? __('hello') : __('hi')}</span>
  2. Requires Node v7+