wuchale 0.3.0 → 0.3.1

package/README.md

@@ -279,9 +279,10 @@ script rule below.
 ### Script
 
 This includes all JS/TS code that is:
-    - Inside `<script>` tags
-    - Inside dynamic expressions inside the markup or attributes, anything in curly braces like `{call('this guy')}`
-    - In `*.svelte.[js|ts]` files.
+
+- Inside `<script>` tags
+- Inside dynamic expressions inside the markup or attributes, anything in curly braces like `{call('this guy')}`
+- In `*.svelte.[js|ts]` files.
 
 The rule for this is that all strings and template strings that start with
 capital letters are extracted. Additionally, if they are used inside the
@@ -363,6 +364,27 @@ it here. The function should receive the following arguments:
 
 And it should return boolean to indicate whether to extract it.
 
+## Files management
+
+`wuchale` generates two files for each locale.
+
+### `.po` file
+
+This is a `gettext` file that is used to exchange the text fragments with translators. The workflow is:
+
+- You give them the file with empty places for the translated fragments
+- They fill it with the translation, preserving the placeholders, but they can change the orders as the language requires.
+- You get the file back and make it part of your codebase.
+
+**Note**: You should commit these files, they are where the translated
+fragments are stored and are the source of truth for the translations.
+
+### Compiled `.json` file
+
+This is the compiled version of the `.po` file. It is generated at the startup
+of the dev server and at build time. As it has to be generated every time, you
+should consider it as a temp file and therefore you should **not** commit it.
+
 ## 🧹 Cleaning
 
 Unused keys are marked as obsolete during a production build. Obsoletes are

package/index.js

@@ -1,3 +1,3 @@
-import wuchale from "./preprocess/index.js"
+import plugin from "./preprocess/index.js"
 
-export default wuchale
+export const wuchale = plugin

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wuchale",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "i18n for svelte without turning your codebase upside down",
   "main": "index.js",
   "scripts": {