wuchale

0.19.4

Patch Changes

• Fix possible type error on generated compiled catalogs when using plural functions (324fb80)

0.19.3

Patch Changes

• Fix multiple issues revealed in #234 (2966ded)

0.19.2

Patch Changes

• Allow return outside function for astro frontmatter (823f78e)

0.19.1

Patch Changes

• Fix possible infinite retries on ai translate error/mistake (2b9a61a)

0.19.0

Minor Changes

• 3ca7aac: Accept .ts and .mts config files because node 22+ supports them

• 9de6b79: Make it easier to choose non-reactive runtime function

  by setting runtime.useReactive in the adapter config.

• fad845d: Add a flag --log-level to the CLI and use it for all outputs when extracting

• 197bb11: Accept Gemini model code as config

• 64f7485: BREAKING: Update locales config to support for 3rd party component libraries

  The sourceLocale is now configured on a per-adapter basis, and on the top level, all desired locales have to be specified.

  You have to make some changes to your config:

  {
      sourceLocale: 'en',
      otherLocales: ['es', 'fr'],
      locales: ['en', 'es', 'fr'],
      adapters: {
          main: svelte({
              sourceLocale: 'en',
              // ...
          })
      }
  }

  Additionally, the sourceLocale on the adapter defaults to the first locale in the main locales array.

  This allows the use of multiple languages in the source code, which may be necessary when you are trying to write the source in another language and you want to use a 3rd party lib written in English for example.

  And now to use 3rd party component libraries, you can specify the file locations in the package dir under node_modules:

  wuchale.config.js

  {
    //...
    adapters: {
      lib: svelte({
        files: "node_modules/foo-lib/dist/*.svelte",
      });
    }
  }

  And additionally, to make sure that Vite doesn’t interfere during dev, you can exclude the library from startup optimization:

  vite.config.js

  export default defineConfig({
    optimizeDeps: {
      exclude: ["foo-lib"],
    },
  });

• 63fb176: Add support for delaying setting the current locale after loading the catalogs (#163)

  You can now use commitLocale after loadLocale(locale, false) to separate loading from rendering. This can solve SvelteKit rendering the other locale on hover over the language link when preloading is on, by using it in $effect.pre. Previously loadLocale accepted key as the second argument to selectively load catalogs by adapter key. It will now load all available catalogs.

• f92c641: Use _w_runtime_(...) instead of _w_runtime_.t(...) to further reduce bundle size

0.18.11

Patch Changes

• ae355a5: Fix windows file path difference preventing hot reload on edit po files

0.18.10

Patch Changes

• 3b0e87b: Update Gemini default version to 2.5 (for #218)

0.18.9

Patch Changes

• 67655b3: Fix messages belonging to files matched by removed patterns surviving --clean #200

0.18.8

Patch Changes

• 926aa60: Fix type error on proxies when noUncheckedIndexedAccess is true #202
• 7471ce3: Fix translation not showing when writing po file after adding new message in source #204

0.18.7

Patch Changes

• 82c4cf9: Fix <style lang="scss"> causing problems in Svelte

0.18.6

Patch Changes

• 6af0d52: Fix error on for loops with some conditions missing #197
• 0a4e3df: Remove surrounding unnecessary quotes when transforming attributes #191
• 1b511c3: Fix parsing crashing on TS abstract class declarations #189
• 5ce8212: Fix switch and try statements not being visited #198
• 885c131: Fix type errors because of generated compiled catalogs not being typed

0.18.5

Patch Changes

• 44a6d24: Fix ... as type and <type>... expressions in TS not visited sometimes
• f861f78: Use proper hook name to get reactive runtime in React #181

0.18.4

Patch Changes

• ff87ab3: Don’t update PO-Revision-Date header on extract, should be set by translation tool/platform

0.18.3

Patch Changes

• a1a31f9: Fix errors during build due to granular load IDs and TS types

0.18.2

Patch Changes

• 4a8ba3d: Fix runtime initialization sometimes after early exits in functions

  Causing errors in React apps

• db45dff: Fix default loader templates, remove obsolete comments

• 5b0a570: Fix custom loader in config causing errors

0.18.1

Patch Changes

• 978aaa4: Fix compiled catalogs not written on build

0.18.0

Minor Changes

• 37deb80: Always use physical files, change catalog config to localesDir

  Previusly virtual modules offered by Vite made it possible to keep the file system clean and a slight performance advantage when building, but they had disadvantages:

  • Inspecting what Wuchale generates was not possible unless the writeFiles config was enabled
  • They don’t work outside of Vite
  • Supporting physical files was therefore unavoidable and that meant supporting two different systems to export the same things

  Now everything is written to disk, including proxies, compiled catalogs, and locales data too. And writeFiles has been removed. In cases where writing the transformed code is desired, the destination can be provided to the outDir adapter config.

  The second thing is that the location of the catalog files was previusly specified using the catalog adapter config, which accepted a substitution parameter, {locale} but it’s an unnecessary complexity that can lead to problems, and it’s not just catalogs that’s stored in that location. Therefore, it has been replaced by the self descriptive config, localesDir.

• 37deb80: Improve base heuristic to avoid ALLCAPS like POST and EUR, with no lowercase like “M 0,0” in script and attributes

• 37deb80: Removed the init CLI command. Loaders are now specified in the config. And they have to export getRuntime and getRuntimeRx.

  The interactive init command was mainly created to scaffold loaders. But since most devs don’t touch the loaders and since updates to what the loaders are expected to export and their locations is not that straightforward to keep up with the package updates, the command has been removed, and the loaders can be specified in the adapter configuration using the key loader.

  The loader config can take some default included loaders and additionally custom as a value. For example, the Svelte adapter can accept the values svelte, sveltekit and custom.

  Specifying the included loaders (svelte or sveltekit in the example case) means you don’t want to control their content and want to use the default. And so the loader(s) contents are (over)written at dev server startup or the extract command. That way, they are automatically kept up to date with the package. But if you want to do custom stuff with the loaders, and don’t want them to be overwritten, you can specify custom.

  The location of the loaders is next to the catalogs, and follows this naming convention:

  {adapter key}.loader[.server].{loader extension}

  For example, for a SvelteKit project, it can be: main.loader.svelte.js (client) and main.loader.server.svelte.js (server). Therefore, if you take ownership of these files and do custom stuff, you can specify custom in the adapter config.

  And next, the (custom) loaders have to export functions getRuntime and getRuntimeRx after wrapping the loaded catalogs with toRuntime from wuchale/runtime.

• 37deb80: Provide locale as an rgument option for patterns for easy l10n

  You can now use pure functions for l10n like currency and date, etc.

  For example, you can define the function:

  function currency(num, loc = "en") {
    return new Intl.NumberFormat(loc, {
      style: "currency",
      currency: "EUR",
    }).format(num);
  }

  And specify the pattern in the config:

  // ...
      adapters: {
          main: svelte({
              loader: 'sveltekit',
              patterns: [
                  {name: 'currency', args: ['other', 'locale']},
              ]
          }),
  // ...

  And when you use it like normal:

  <p>{currency(123456.789)}</p>

  It will produce localized variants based on the locale:

  • en: €123,456.79
  • es: 123.456,79 €
  • fr: 123 456,79 €

  You can use it with ANY l10n approach, you just have to specify the pattern.

• 37deb80: Run a pre scan and compile catalogs before build to prevent race conditions

  This solves the problem where you start the build process with some messages in the code not yet extracted to the PO files, and are discovered during the build process, which causes the PO file and subsequently the compiled catalogs to be modified, during build. That causes a race condition and makes the build process fail because of a syntax error (the compiled catalog is read while only half of it is written.)

  Additionally, with the new URL handling, links are not directly translated, their translation is derived from the URL pattern translations. That removes the need to store them in the PO files, just the patterns. But that also means they are not known at the start of the build process, which causes the above problem.

  Now all extraction and compilation of messages is performed prior to the build, during build, no PO file writes or compiles are performed, only code transformations happen. This makes builds deterministic.

• 9d1dff8: Add support for translating URL paths!

  This is the biggest addition on this release. Internationalizing URL paths is now possible, with the same conveniences of no/minimal code changes, while respecting the fact that URLs are to be handled carefully.

  There are two parts to this:

  • Translation: e.g. /about to /uber-uns
  • Localization: e.g. /about to /en/about

  Full guide coming soon in the docs!

0.17.5

Patch Changes

• 5c8cea6: Fix chain expressions (JS) and render tags (Svelte) not being visited

0.17.4

Patch Changes

• a955579: Visit @const declarations in svelte, more compatibility

0.17.3

Patch Changes

• 280ad8d: Fix tagged template strings not extracted

0.17.2

Patch Changes

• 51778eb: Fix patterns not working for template literals

0.17.1

Patch Changes

• 6a9b651: Fix config with files: {include: ..., ignore: ...} not working, and improve verbose output
• 8e2611d: Export and document all default heuristic functions

0.17.0

Minor Changes

• 5a221a2: Expose interface to make AI translator customizable

  You can now use a custom translator model other than Gemini by supplying the info in the config:

  export default {
    //...
    ai: {
      name: "ChatGPT", // e.g.
      batchSize: 50,
      parallel: 10,
      translate: (content, instruction) => {
        // logic
        return translatedContent;
      },
    },
    //...
  };

  Gemini is still the default, but now it’s separated out and was made customizable:

  import { gemini } from "wuchale";
  
  export default {
    //...
    ai: gemini({
      batchSize: 40,
      parallel: 5,
      think: true, // default: false
    }),
    //...
  };

• 15cf377: Pass whole message to heuristic function, with context

• 0b5c207: Svelte: auto wrap variable declarations by $derived as needed instead of requiring it in the code

• 16b116c: Customizable log levels, add verbose level where all extracted messages are shown

• 22198c1: Redesign status command output with tables

• d531bcc: Add support for multiple custom patterns to support full l10n

  For example, if you want to use Intl.MessageFormat for everything it supports including plurals, you add a signature pattern for a utility function in the config:

  // ...
  adapters: js({
    patterns: [
      {
        name: "formatMsg",
        args: ["message", "other"],
      },
    ],
  });
  //...

  Then you create your reusable utility function with that name:

  // where you get the locale
  let locale = "en";
  
  export function formatMsg(msg, args) {
    return new IntlMessageFormat(msg, locale).format(args);
  }

  And use it anywhere:

  const msg = formatMsg(
    `{numPhotos, plural,
        =0 {You have no photos.}
        =1 {You have one photo.}
        other {You have # photos.}
      }`,
    { numPhotos: 1000 }
  );

  Then wuchale will extract and transform it into:

  const msg = formatMsg(_w_runtime_.t(0), { numPhotos: 1000 });

• 9f997c2: Add --sync flag for the CLI command to process files sequentially

Patch Changes

• 6d0a4d3: Make wuchale --clean idempotent and write once at the end

0.16.5

Patch Changes

• 1d57789: Fix locales not separate when written to proxy

0.16.4

Patch Changes

• 5aa768a: Ignore form method attribute and fetch calls

• 0352c60: Fix issues around arrow functions and function expressions

  These are technically functions but their bodies are not block statement bodies, but expressions. For this reason, they were ignored when they are defined at the top level and when they are inside functions, they would use the runtime instance of their parent. Now their own bodies are tuned into block statement bodies:

  const foo = () => "Hello";

  Now becomes:

  const foo = () => {
    const _w_runtime_ = _w_to_rt_(_w_load_("main"));
    return _w_runtime_.t(0);
  };

  This allows them to be defined at the top level and they should still get their contents properly extracted.

• 04e28a3: Fix initialization outside <script> when the <script> is empty

0.16.3

Patch Changes

• 4210ee1: Fix error on empty body content when trying to get body start (e.g. in empty <script>)

0.16.2

Patch Changes

• f7c0225: Fix class declarations not visited

0.16.1

Patch Changes

• 973848b: Fix HMR having problems with lazy loaded files

0.16.0

Minor Changes

• fef0d11: Add the @wc-ignore-file comment directive

  As an alternative to ignoring a file in the files config value, you can now ignore a whole file by putting this directive at the beginning of the file, before any extractable messages. The advantage is that it doesn’t need a restart of the dev server and if you rename/move the file it will always be ignored.

• 4fcf264: Add support for .mjs config as default

• 46aa3f2: Export locales from proxy when writeFiles is enabled for server to not need tweaking the default loader

• 37367ca: Add placeholder context comments into PO file

• f07d484: Gemini: translate in batches of 50 max, auto retry with status messages

  This is useful for one off translation, usually just after adding wuchale to a big project. Gemini sometimes doesn’t translate all messages when it’s given too many, so this update batches the messages into groups of ~50, and when not all of them are translated, shows a message and tries again, until all of them are translated.

0.15.8

Patch Changes

• 3d5d73a: Solve issues with paths on windows

0.15.7

Patch Changes

• 957574f: Fix sequence expressions not visited
• 0223e40: Fix cli with —clean removing all messages not belonging to the last adapter out of those sharing a catalog

0.15.6

Patch Changes

• 485f5fe: Fix .svelte files with

0.15.5

Patch Changes

• f698c89: Fix init command ENOENT error when dir doesn’t exist

0.15.4

Patch Changes

• 5ec75dc: Use component in components to preserve non string types

  This is mainly relevant to the JSX adapter, where components themselves can be passed around as values and props, and previously, if they are in expressions like this:

  const msg = <b>Hello</b>;
  return <p>{msg} and welcome</p>;

  The msg would be converted into a string and it would become [object Object].

  Now this has been fixed.

0.15.3

Patch Changes

• 076dbbc: Fix broken HMR after splitting reactive vs plain

0.15.2

Patch Changes

• bc8a734: Add ssr default loader for vite

0.15.1

Patch Changes

• d03dfa1: Fix error when runtime initialized after non literal expressions
• 2a74da7: Fix not all loaders updated for two exports

0.15.0

Minor Changes

• af21188: Optional support for separate loader for SSR

• 26ce0c3: Separate reactive and plain loader functions

  This is to fix errors happening specifically with React as it doesn’t allow using hooks inside non hooks or components. But it opens up finer configurations for Svelte and SolidJS as well for which the defaults have been adjusted as well.

  You can now export different functions from the loader files for reactive (e.g. using hooks) and non reactive (e.g. just simple object lookup) and tell wuchale their names using configuration options, and also adjust which one is used when.

  If you want to update your loader(s), you can do npx wuchale init and select another one than existing.

0.14.6

Patch Changes

• 53ee835: Surround object keys only if not computed
• d67de40: Fix error when extracting quoted object key strings

0.14.5

Patch Changes

• 6604274: Fix destructuring assignment default values not extracted

0.14.4

Patch Changes

• 7d8f079: Fix ternary expressions not extracted

0.14.3

Patch Changes

• e7928e9: Fix multiline messages possibly missing catalog checks

0.14.2

Patch Changes

• 2c09872: Trim multiline messages to remove indentation
• f5cf428: Fix svelte mixed attributes not handled correctly

0.14.1

Patch Changes

• 6c459fa: Prevent errors on SSR loading in some cases

  Like with SvelteKit on StackBlitz, it seems it loses the AsyncLocalStorage context inside the request. But this should’t affect normal usage.

0.14.0

Minor Changes

• 5600e3b: Rename the NestText class to Message and its text attribute to msgStr.

• cf92cb5: Make runtime error message configurable

  You can now configure the message shown when the message index is not found in the compiled catalog array. By default, it is something like [i18n-404:0] during dev mode and empty '' in production. You can use the static method at startup (anywhere in your app) to override it. It applies globally.

  import { Runtime } from "wuchale/runtime";
  
  Runtime.onInvalid((i, arr) =>
    arr[i] == null ? `not-found:${i}` : `bad:${arr[i]}`
  );

• c79ae56: Move runtime initialization into the transformed code, framework agnostic HMR

  The Runtime instance is now initialized inside the transformed code and now loaders are required to always return a catalog module. This makes all loaders consistent and makes the Runtime an implementation detail. If your loaders return new Runtime(catalog), you have to unwrap it and return just catalog (or undefined in the case of new Runtime()). The default loaders are updated to return the catalog module. If you haven’t modified them and want to use the new ones, you can overwrite them by running npx wuchale init and selecting a loader different from existing.

  This also solves the problem where HMR may sometimes not work depending on the method of loading the catalog modules, by avoiding HMR events and the reactivity from the framework, and just embedding the catalog updates in the transformed code itself. This also makes it fast as it now doesn’t have to wait for an event from the Vite dev server to update the state. This is only for dev mode so the production builds still stay lean.

  The downside of avoiding using HMR events is that it’s now unable to make the updates from editing the PO files granular and has to do a full reload. But this is a reasonable tradeoff as editing PO files is not done continuously, but editing code is.

• e29bca7: Enable sharing catalogs between adapters

  Now you can use the same catalogs with different catalogs and they will work with each other on the same file. But they still need different loader files. Therefore, A new adapter config option loaderPath was added so that different loaders can be specified.

• 01af763: Make keeping the existing loader an option instead of a cli flag

  Instead of specifying --force in the cli on npx wuchale init, if there is an existing loader, make it the first option. This makes it easier to update the loader if it was the default when a new version comes out.

0.13.2

Patch Changes

• 44b35ac: Fix error for svelte adapter not getting new currentRT

0.13.1

Patch Changes

• e29e69b: Fix errors on vanilla adapter transform and loading

0.13.0

Minor Changes

• 9fff745: Add force flag to init command

• 8ac94b4: Add importName option to adapters

  You can also specify in what name the default export of the loader files is imported.

• d131ebe: Iron out universal HMR, update loaders, organize exports, improve loading reactivity

  This change fixes every small issue with HMR, like editing a file and changing the locale, editing the PO file and then the loader file, etc… it should always work as expected now.

  Another thing is that most exports are now from the base wuchale package except those that may be included in the build outputs of applications which should be selectively loaded to improve tree shaking. Most importantly, the loading utilities are now in:

  • wuchale/load-utils for client loading
  • wuchale/load-utils/server for server loading
  • wuchale/load-utils/pure for side effect-free loading

  All of these are optional and if you don’t use them, they will not be included in your build.

  The client utility registerLoaders function’s optional fourth argument is now an object with get and set methods. This allows more control over the state of the catalogs for use with the reactivity patterns of any library.

• 5531f84: Add more adapter config options to control runtime

  This brings more options to configure how exactly the runtime instance is initialized and used. You can now choose where to initialize it (top level or only inside function definitions with certain names), and you can also wrap the initialization expression so that you can, for example, put it inside something else other than $derived in svelte.

0.12.1

Patch Changes

• 430a801: Fix default loaders not included in package

0.12.0

Minor Changes

• dcabbe5: Make HMR and common logic universal across adapters

0.11.5

Patch Changes

• a6746e0: Fix and improve default loaders and loader selection

  The default suggested loader for the svelte adapter was not reactive to locale changes, now fixed. Moreover, the default loader selection experience has been improved by removing unnecessary interations and removing irrelevant choices. For example, there is no need to suggest importing from a file proxy instead of a virtual module while using the svelte adapter, because vite will be there anyway because of svelte.

0.11.4

Patch Changes

• a773137: Read package.json to accurately suggest default loaders

0.11.3

Patch Changes

• a367485: Fix error on init loaders

0.11.2

Patch Changes

• 3f4ca05: Fix comments sticking once set

0.11.1

Patch Changes

• e2eb7f4: Fix comments in script not processed correctly

0.11.0

Minor Changes

• 6cbece0: Improve CLI status command and structure

  The CLI command npx wuchale status is now more powerful and shows more information. Also, the stats message printed at dev startup and everytime the .po files change has now been removed. Use the CLI to get the status along with numbers.

• 56a350f: Add support for watch mode to CLI

0.10.1

Patch Changes

• 0de92c4: Fix unnecessary ‘false’ in compiled catalogs when plural rule not included

0.10.0

Minor Changes

• 830aa1e: Add status command, shorten default command to just wuchale

  You can get the new usage by running npx wuchale --help.

• 84452f2: Omit plural rules from compiled catalogs if not used

• 6d37525: Show messages in color, improve stats message

• dd4c602: Use consistent name for proxy modules

  You will have to update the imports in your loaders from:

  import ... from 'virtual:wuchale/loader'
  // or
  import ... from 'virtual:wuchale/loader/sync'

  To:

  import ... from 'virtual:wuchale/proxy'
  // or
  import ... from 'virtual:wuchale/proxy/sync'

• 3533ac1: Separate vite plugin into @wuchale/vite-plugin

  You have install the new plugin package:

  npm install -D @wuchale/vite-plugin

  And import the vite plugin from the new package in your vite.config.*

• d35224f: Allow manually selecting loaders on wuchale init

  You can now select which default loader you want on init. Moreover, it will put the detected one as the first option.

• 1d565b4: Make bundleLoad and initInsideFunc common options for adapters

• a240836: Enforce BCP 47 standard locale identifiers

  If you use simple two-letter identifiers like en, this shouldn’t make any difference. But if you want to use more specific identifiers, you now have to use BCP 47 standard. That means, en-US and zh-Hant are valid while en_US and cn-simplified are not valid. The validation is done using Intl.DisplayNames.

• a6012be: Export adapter key for use in loaders

  You can now import the adapter key you set in the config from the proxies so that you don’t have to manually update them if you change them in the config

  import { key } from "virtual:wuchale/proxy";

• e9d1817: Move the storage of plural rules to PO files and simplify config

  This makes sure that the po files are the single source of truth for translations as well as plural rules. The translator can update the rules as well. And for the language names, Intl.DisplayNames can be used and is more versatile. Then the only thing that needs to be specified in the config is the codes of the locales, nothing else. This makes the config simpler. To update your config, you have to have an array of the other locales’ codes instead of an object for all locales. English will continue to be the sourceLocale.

  export default {
    otherLocales: ['es', 'fr'],
    adapters: ...
  }

• 3847bc1: Add loadLocaleSync to run-client

  In addition to loadLocale, there is now loadLocaleSync that can be used with synchronous loaders avoiding await.

• c0a307d: Make config path configurable at plugin and cli

  You can now specify another config file you want to use instead of wuchale.config.js. It still has to be a JavaScript module, but it can be in another directory too.

  And the relative paths specified in the config are relative to the directory you run the command from, NOT relative to the file.

Patch Changes

• 1d565b4: Fix new references not triggering catalog write
• 9a9aad7: Fix errors on immediate access translations after extract during dev

0.9.7

Patch Changes

• f16ea73: Fix loading not working in vanilla projects

0.9.6

Patch Changes

• 74f50c8: Extract from exprs inside non eligible template strings
• 79fb374: Default heuri: extract non top level expression strings
• b350b49: Fix cli init failing with ENOENT
• 613f6e7: - Make vanilla adapter loader conditional on vite for init
  • Import from loader on disk when writing transformed files to disk
• 2312975: Ignore all generated files for extract

0.9.5

Patch Changes

• a109011: Fix error on sveltekit projects, *.t not function

0.9.4

Patch Changes

• a86f197: fix header rev date updated even when no changes

0.9.3

Patch Changes

• 209fb51: Fix locale changes not being reactive in .svelte.js/ts files

0.9.2

Patch Changes

• 7ef6ea5: Fix bare strings in the top level being extracted

0.9.1

Patch Changes

• 3cb0541: Fix wrong default loader contents for vanilla adapter

0.9.0

Minor Changes

• • Non-Vite normal Node.js javascript usage with just CLI, like a compiler
  • Write transformed files to file
  • Multiple adapter specifications with different configurations
    • Enabled full client and server messages i18n support
  • Can now specify different loading behaviours for compiled catalogs
    • Lazy, shared between files
    • Granular, loaded in groups
    • Granular, loaded separately
    • Granular, bundled
    • Custom (with provided primitives)
  • Support custom ID generator for granular loading to enable selective grouping
  • More information provided to heuristic function