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

@messageformat/loader

v1.0.0

Published

Webpack loader for MessageFormat

Downloads

2,557

Readme

Webpack Loader for MessageFormat

A loader that parses input JSON, YAML and Java .properties files consisting of messages as objects of JavaScript message functions with a matching structure, all during the build of your application.

This package was previously named messageformat-loader.

Installation

npm install --save-dev @messageformat/core @messageformat/loader

If you're intending to publish a library with external dependencies, you should also include the runtime as a dependency:

npm install @messageformat/runtime

Usage

After installation, you'll need to add the loader to your Webpack config. Note the test value; you may want to customise the messages part to match whatever you're actually using, in particular if a generic match like /\.yaml$/ would overlap with another loader.

webpack.config.js

module.exports = {
  module: {
    rules: [
      {
        test: [/\bmessages\.(json|ya?ml)$/, /\.properties$/],
        type: 'javascript/auto', // required by Webpack for JSON files
        loader: '@messageformat/loader',
        options: { locale: ['en'] }
      }
    ]
  }
};

With that in place, you'll be able to use your messages like this:

messages.yaml

simple: 'A simple message.'
var: 'Message with {X}.'
plural: 'You have {N, plural, =0{no messages} one{1 message} other{# messages}}.'
select: '{GENDER, select, male{He has} female{She has} other{They have}} sent you a message.'
ordinal: 'The {N, selectordinal, one{1st} two{2nd} few{3rd} other{#th}} message.'

example.js

import messages from './messages.yaml';

messages.ordinal({ N: 1 });
// → 'The 1st message.'

Options

In addition to the options accepted by @messageformat/core, the loader supports the following:

| Option | Type | Default | Description | | ------------- | ----------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------- | | convert | boolean | false | Use @messageformat/convert to convert non-MessageFormat syntax and plural objects into MessageFormat. Use an object value to configure. | | encoding | 'auto'/'utf8'/ 'latin1' | 'auto' | File encoding. With 'auto', attempts to detect 'utf8', falling back to 'latin1'. | | locale | string[] | ['en'] | The CLDR language codes to pass to MessageFormat. | | propKeyPath | boolean | true | Parse dots . in .properties file keys as path separators, resulting in a multi-level message object. |

As MessageFormat is often used to provide multi-language support, it's important to include all of your supported locales in the options.locale value. For example, using locale: ['en', 'fr'] would allow for imports from foo.en.properties and foo.fr.properties to have their messages' locale set correctly, based on the file name. Using a locale identifier as a key within the message file contents will also select that locale within it.


Messageformat is an OpenJS Foundation project, and we follow its Code of Conduct.