@atlassian/i18n-properties-loader
Advanced tools
Comparing version 0.7.4 to 0.8.0
@@ -6,2 +6,8 @@ # Change Log | ||
## 0.8.0 (2020-05-11) | ||
- chore: Add note about minimal requirements ([ee38cec](https://bitbucket.org/atlassianlabs/fe-server/commits/ee38cec)) | ||
- chore: downgrade to Node version 10 ([9fc7bab](https://bitbucket.org/atlassianlabs/fe-server/commits/9fc7bab)) | ||
- chore: Update minimal Node version to version 12 so we can support 'String.proptotype.matchall' ([cb0ed25](https://bitbucket.org/atlassianlabs/fe-server/commits/cb0ed25)) | ||
## [0.7.4](https://bitbucket.org/atlassianlabs/fe-server/compare/@atlassian/i18n-properties-loader@0.7.3...@atlassian/i18n-properties-loader@0.7.4) (2020-04-21) | ||
@@ -8,0 +14,0 @@ |
{ | ||
"name": "@atlassian/i18n-properties-loader", | ||
"version": "0.7.4", | ||
"version": "0.8.0", | ||
"description": "A webpack loader for i18n *.properties files that can be used in Atlassian Server products", | ||
@@ -52,3 +52,6 @@ "main": "index.js", | ||
}, | ||
"gitHead": "7032b223801ab6bcc31aa16fd350405812f8899b" | ||
"engines": { | ||
"node": ">=10" | ||
}, | ||
"gitHead": "f6ee366f1ce80a83157d0ec5a51f1f26db307cdb" | ||
} |
# @atlassian/i18n-properties-loader | ||
 | ||
 | ||
 | ||
A webpack loader for i18n `*.properties` files that can be used in Atlassian Server products and plugins. | ||
@@ -11,4 +15,4 @@ | ||
now. | ||
The `@atlassian/i18n-properties-loader` can help you with solving that problem. It's a webpack loader that allows you | ||
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. | ||
@@ -18,5 +22,6 @@ | ||
- [Internationalising your plugin](https://developer.atlassian.com/server/framework/atlassian-sdk/internationalising-your-plugin/) | ||
- [Internationalising your plugin](https://developer.atlassian.com/server/framework/atlassian-sdk/internationalising-your-plugin/) | ||
## Installation | ||
```sh | ||
@@ -48,3 +53,3 @@ npm install @atlassian/i18n-properties-loader --save-dev | ||
options: { | ||
i18nFiles: myI18nFiles | ||
i18nFiles: myI18nFiles, | ||
}, | ||
@@ -54,9 +59,9 @@ }, | ||
{ | ||
loader: 'babel-loader' | ||
} | ||
] | ||
} | ||
] | ||
} | ||
} | ||
loader: 'babel-loader', | ||
}, | ||
], | ||
}, | ||
], | ||
}, | ||
}; | ||
``` | ||
@@ -66,4 +71,4 @@ | ||
- `i18nFiles` list of paths to your `*.properties` files (required) | ||
- `disabled` disables the loader; can we used to disabled in production bundle (optional, default `false`) | ||
- `i18nFiles` list of paths to your `*.properties` files (required) | ||
- `disabled` disables the loader; can we used to disabled in production bundle (optional, default `false`) | ||
@@ -81,26 +86,26 @@ ### Creating production bundle | ||
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 | ||
} | ||
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' | ||
} | ||
] | ||
} | ||
] | ||
} | ||
{ | ||
loader: 'babel-loader', | ||
}, | ||
], | ||
}, | ||
], | ||
}, | ||
}; | ||
@@ -110,13 +115,20 @@ }; | ||
## React i18n helper | ||
## React i18n helper | ||
This package plays nice with the [`@atlassian/wrm-react-i18n`](https://www.npmjs.com/package/@atlassian/wrm-react-i18n) | ||
This package plays nice with the [`@atlassian/wrm-react-i18n`](https://www.npmjs.com/package/@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. | ||
You can check the package description for more details and learn how to integrate it with your webpack configuration. | ||
## Additional links | ||
- [https://www.npmjs.com/package/@atlassian/i18n-properties-loader](https://www.npmjs.com/package/@atlassian/i18n-properties-loader) | ||
- [https://www.npmjs.com/package/@atlassian/wrm-react-i18n](https://www.npmjs.com/package/@atlassian/wrm-react-i18n) | ||
- [https://www.npmjs.com/package/atlassian-webresource-webpack-plugin](https://www.npmjs.com/package/atlassian-webresource-webpack-plugin) | ||
- [https://www.npmjs.com/package/@atlassian/i18n-properties-loader](https://www.npmjs.com/package/@atlassian/i18n-properties-loader) | ||
- [https://www.npmjs.com/package/@atlassian/wrm-react-i18n](https://www.npmjs.com/package/@atlassian/wrm-react-i18n) | ||
- [https://www.npmjs.com/package/atlassian-webresource-webpack-plugin](https://www.npmjs.com/package/atlassian-webresource-webpack-plugin) | ||
## Minimum requirements | ||
This plugin has been built to work with the following versions of the external build tools: | ||
- webpack 4+ | ||
- Node 10+ |
17564
128