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

@atlassian/i18n-properties-loader

v1.0.13

Published

A webpack loader for i18n *.properties files that can be used in Atlassian Server products

Downloads

1,646

Readme

@atlassian/i18n-properties-loader

node version webpack peer dependency version npm downloads

A webpack loader for i18n *.properties files that can be used in Atlassian Server products and plugins.

Motivation

If your work with the modern Front-End Server code there is a good chance you are already using the Atlassian Web-Resource webpack Plugin. If you did configure your webpack to use development server you might be missing displaying translation phrases right now.

The @atlassian/i18n-properties-loader can help you with solving that problem. It's a webpack loader that allows you displaying translation phrases during your development workflow and at the same time uses the WRM.

For more information about the translations system check the Atlassian Development documentation page:

Installation

npm install @atlassian/i18n-properties-loader --save-dev

Usage example

// webpack.config.js

const myI18nFiles = [
  'foo/i18n/my-translation-file.properties',
  'foo/bar/i18n/my-other-translation-file.properties',
  'bar/i18n/some-translation-file.properties',
];

module.exports = {
  module: {
    rules: [
      {
        test: /\.jsx?$/,
        include: ['src'],

        use: [
          {
            loader: '@atlassian/i18n-properties-loader',
            options: {
              i18nFiles: myI18nFiles,
            },
          },

          {
            loader: 'babel-loader',
          },
        ],
      },
    ],
  },
};

Options

  • i18nFiles list of paths to your *.properties files (required)
  • disabled disables the loader; can we used to disabled in production bundle (optional, default false)

Creating production bundle

The loader is required only in development mode. You should remember to disable it when you are creaing production bundle.

With webpack and its mode configuration you can intercept the currently selected mode inside your webpack configuration and disable the loader accoridngly:

// webpack.config.js

module.exports = (env, argv) => {
  const isDevelopmentMode = argv.mode === 'development'; // 1. Check if we are running webpack in "development" mode

  return {
    module: {
      rules: [
        {
          test: /\.jsx?$/,
          include: ['src'],

          use: [
            {
              loader: '@atlassian/i18n-properties-loader',
              options: {
                i18nFiles,
                disabled: !isDevelopmentMode, // 2. Skip and disable loader when webpack is running in "production" mode
              },
            },

            {
              loader: 'babel-loader',
            },
          ],
        },
      ],
    },
  };
};

React i18n helper

This package plays nice with the @atlassian/wrm-react-i18n when you want to use I18n.getText() translation helper with React components.

You can check the package description for more details and learn how to integrate it with your webpack configuration.

Additional links

Minimum requirements

This plugin is compatible with:

  • webpack 4.0+ and 5.0+
  • Node 12+