@atlassian/atlassian-soy-loader

Atlassian Soy Loader

Compiles Soy Templates templates with @atlassian/soy-template-plugin-js package and allows to load them with webpack 3

Installation

You can install the library using NPM:

npm install @atlassian/atlassian-soy-loader

or by Yarn:

yarn add @atlassian/atlassian-soy-loader

Configure webpack 3

{
  module: {
    rules: [
      {
        test: /\.soy/,
        use: {
          loader: '@atlassian/atlassian-soy-loader',
          options: {
              functions: '/foo/bar/path', // optional, locations of custom soy functions, usually a jar
              i18n: '/foo/bar/path/**/*.properties', // optional, glob for matching i18n properties file
              data: 'foo:bar,moo:goo', // optional,  data to pass to soy renderer (soy rendering only) in the form <key1>:<value1>,<key2>:<value2>
              i18nBaseDir: '/foo/bar/path' // optional, base directory for i18n properties file
              dontExpose: true // default: false - indicate if the generated namespace should be exposed to the window or not.
          }
        }
      }
    ]
  }
}

Contributors

Pull requests, issues and comments welcome. For pull requests:

• Add tests for new features and bug fixes
• Follow the existing style
• Separate unrelated changes into multiple pull requests

See the existing issues for things to start contributing.

For bigger changes, make sure you start a discussion first by creating an issue and explaining the intended change.

Atlassian requires contributors to sign a Contributor License Agreement, known as a CLA. This serves as a record stating that the contributor is entitled to contribute the code/documentation/translation to the project and is willing to have it used in distributions and derivative works (or is willing to transfer ownership).

Prior to accepting your contributions we ask that you please follow the appropriate link below to digitally sign the CLA. The Corporate CLA is for those who are contributing as a member of an organization and the individual CLA is for those contributing as an individual.

• CLA for corporate contributors
• CLA for individuals

License

Copyright (c) 2017 Atlassian and others. Apache 2.0 licensed, see LICENSE file.