wuchale 0.3.0 → 0.3.2

package/README.md

@@ -97,8 +97,8 @@ export default {
 
 ```
 
-Create `/locales/` if it doesn't exist, and then set it up in your main
-component. Assuming `/src/App.svelte`:
+Create `/src/locales/` (relative to the projects root) if it doesn't exist, and
+then set it up in your main component. Assuming `/src/App.svelte`:
 
 ```svelte
 <script>
@@ -107,9 +107,14 @@ component. Assuming `/src/App.svelte`:
     let locale = $state('en')
 
     $effect.pre(() => {
-        import(`../locales/${locale}.json`).then(mod => {
+        // IMPORTANT! The path should be relative to the current file (vite restriction).
+        // for the default sveltekit template for example, it's `../locales/${locale}.json`
+        // because the default main component is located at /src/routes/+page.svelte
+        import(`./locales/${locale}.json`).then(mod => {
             setTranslations(mod.default)
         })
+        // but this only applies if you want to do lazy loading.
+        // Otherwise you can do an absolute import
     })
 </script>
 ```
@@ -279,9 +284,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
@@ -347,7 +353,6 @@ export const defaultOptions = {
     sourceLocale: 'en',
     otherLocales: ['am'],
     localesDir: './locales',
-    importFrom: 'wuchale/runtime.svelte',
     heuristic: defaultHeuristic,
     geminiAPIKey: 'env',
 }
@@ -363,6 +368,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.2",
   "description": "i18n for svelte without turning your codebase upside down",
   "main": "index.js",
   "scripts": {

package/preprocess/index.js

@@ -9,8 +9,7 @@ import { normalize, relative } from "node:path"
 export const defaultOptions = {
     sourceLocale: 'en',
     otherLocales: ['am'],
-    localesDir: './locales',
-    importFrom: 'wuchale/runtime.svelte',
+    localesDir: './src/locales',
     heuristic: defaultHeuristic,
     geminiAPIKey: 'env',
 }
@@ -121,7 +120,7 @@ export default async function wuchale(options = defaultOptions) {
      * @param {string} filename
      */
     async function preprocess(content, ast, filename) {
-        const prep = new Preprocess(indexTracker, options.heuristic, options.importFrom)
+        const prep = new Preprocess(indexTracker, options.heuristic)
         const txts = prep.process(content, ast)
         if (!txts.length) {
             return {}

package/preprocess/prep.js

@@ -72,7 +72,7 @@ export default class Preprocess {
      * @param {HeuristicFunc} heuristic
      * @param {string} importFrom
      */
-    constructor(index, heuristic = defaultHeuristic, importFrom) {
+    constructor(index, heuristic = defaultHeuristic, importFrom = 'wuchale/runtime.svelte') {
         this.index = index
         this.importFrom = importFrom
         this.heuristic = heuristic