Skip to content

CHANGELOG.md

Latest commit

 

History

History
442 lines (284 loc) · 17 KB

CHANGELOG.md

File metadata and controls

442 lines (284 loc) · 17 KB
Raw

Changelog

0.12.2

Patch Changes

0.12.1

Patch Changes

  • #4326 75943d95 - Loosen type for the @localized() decorator to be able to decorate any ReactiveControllerHost which also alleviates type errors that could arise with multiple copies of @lit/reactive-element present in the project. Also remove dependency on @lit/reactive-element as it is already covered by the lit dependency.

  • #4299 fffa4406 - Update version range for lit dependency to include v2 (and/or @lit/reactive-element v1). This allows projects still on lit v2 to use this package without being forced to install lit v3.

0.12.0

Minor Changes

  • #4159 d1e126c4 - Add support for standard decorators to the @localize decorator.

Patch Changes

  • #4141 6b515e43 - Update TypeScript to ~5.2.0

  • Updated dependencies:

    • @lit/reactive-element@2.0.0
    • lit@3.0.0

0.12.0-pre.1

Minor Changes

  • #4159 d1e126c4 - Add support for standard decorators to the @localize decorator.

Patch Changes

0.11.5-pre.0

Patch Changes

0.11.4

Patch Changes

0.11.3

Patch Changes

  • #2972 ee864b6d - Fix multiple runtime msg call with same template but different expressions

0.11.2

Patch Changes

0.11.1

Patch Changes

  • #2286 52c4f32e - Update README to point to new full docs at lit.dev

0.11.0

Minor Changes

  • #2188 9fc5a039 - Support emitting generated modules as .js files. Adds a new output.language setting for runtime mode locale generation, and automatically detects the filetype based on the file extension when using output.localeCodesModule.

Patch Changes

0.10.4

Patch Changes

  • #2113 5b2f3642 - Dependency upgrades including TypeScript 4.4.2

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[0.10.3] - 2021-07-14

Added

  • Added configureReentrantLocalization in init/reentrant.js which allows for safe concurrent rendering across multiple locales by asynchronous tasks, such as in an SSR context.

    In this configuration, there is no global setLocale function. Instead, the caller provides a getLocale function, which is then called by every msg invocation.

    This pairs well with an asynchronous storage manager like AsyncLocalStorage. See configureSsrLocalization from @lit/localize-tools/lib/ssr.js which does exactly this.

Fixed

  • Removed accidental export of _msg (use msg instead).

[0.10.2] - 2021-05-18

Fixed

  • Internal refactoring.

[0.10.1] - 2021-04-20

Changed

  • Bumped versions of deps

[0.10.0] - 2021-04-19

Changed

  • [BREAKING] Lit dependency upgraded to v2.

  • [BREAKING] The Localized mixin has been replaced with the @localized decorator and the updateWhenLocaleChanges function. These APIs register a Lit 2 controller that serves the same purpose as the removed mixin.

    Before

    import {LitElement} from 'lit-element';
import {Localized} from '@lit/localize/localized-element.js';

class MyElement extends Localized(LitElement) {}

    After

    With decorators
    import {LitElement, customElement} from 'lit';
import {localized} from '@lit/localize';

@localized()
@customElement('my-element');
class MyElement extends LitElement {}
    Without decorators
    import {LitElement} from 'lit';
import {updateWhenLocaleChanges} from '@lit/localize';

class MyElement extends LitElement {
  constructor() {
    super();
    updateWhenLocaleChanges(this);
  }
}

[0.9.0] - 2021-03-30

Changed

  • [BREAKING] Description comments (// msgdesc:) have been removed in favor of the desc option.

Before:

// msgdesc: Home page
class HomePage {
  hello() {
    // msgdesc: Greeting to Earth
    return msg(html`Hello World`);
  }
  goodbye() {
    // msgdesc: Farewell to Earth
    return msg(html`Goodbye World`);
  }
}

After:

class HomePage {
  hello() {
    return msg(html`Hello World`, {
      desc: 'Home page / Greeting to Earth',
    });
  }
  goodbye() {
    return msg(html`Goodbye World`, {
      desc: 'Home page / Farewell to Earth',
    });
  }
}

[0.8.0] - 2021-03-24

Changed

  • [BREAKING] Lit Localize is now distributed as two packages:
    • @lit/localize provides the browser library (msg, LocalizedElement, etc.)
    • @lit/localize-tools provides the lit-localize CLI.

[0.7.0] - 2021-03-12

  • [BREAKING] Templates can now contain arbitrary expressions, and no longer need to be wrapped in a function.

    Before:

    msg((name) => html`Hello <b>${name}</b>!`, {args: [getUsername()]});

    After:

    msg(html`Hello <b>${getUsername()}</b>!`);

    Plain strings containing expressions must now be tagged with the new str tag. This allows lit-localize to access dynamic values at runtime.

    import {msg, str} from 'lit-localize';
msg(str`Hello ${name}`);

  • [BREAKING] The lit-localize CLI now must always take one of two commands: extract or build. Previously, both of these steps were always performed.

Added

  • Added @lit/localize/lib/rollup.js module that exports a localeTransformers function that can be used to integrate locale transformation into a Rollup build.

[0.6.1] - 2020-12-09

Fixed

  • Fixed missing .js files from NPM package.

[0.6.0] - 2020-12-09

Changed

  • [BREAKING] The signature for the msg function has changed:

    Before:

    msg(id: string, template: string|TemplateResult|Function, ...args: any[])

    After:

    msg(template: string|TemplateResult|Function, options?: {id?: string: args?: any[]})

  • It is no longer necessary to provide a message id. When omitted, an id will be automatically generated from the string contents of the template.

Fixed

  • // msgdesc descriptions are now correctly emitted as XLIFF <note> elements, instead of crashing.

[0.5.1] - 2020-11-09

Fixed

  • Fixed missing localized-element.js and config.schema.json NPM files.

[0.5.0] - 2020-11-09

Changed

  • [BREAKING] NPM package moved from lit-localize to @lit/localize.

Fixed

  • Fixed main field of package.json so that it resolves to lit-localize.js instead of nonexistent file.

[0.4.0] - 2020-09-08

Added

  • Add optional output.localeCodesModule config file setting which generates a TypeScript module that exports sourceLocale, targetLocales, and allLocales using the locale codes from your config file. Use for keeping your config file and client config in sync.

Changed

  • [BREAKING] Published module paths have changed: lib_client/index.js -> lit-localize.js lib_client/localized-element.js -> localized-element.js

  • When writing TypeScript, XLIFF, and XLB files, parent directories will now be created automatically, instead of erroring.

[0.3.0] - 2020-08-25

Changed

  • [BREAKING] The msg function has moved from the generated localization.ts module to the static lit-localize module. localization.ts is no longer generated, and all of its exports have been replaced by a substantially different API (see the README).

  • [BREAKING] The initial locale is no longer automatically initialized from the locale URL parameter. Initializing/changing locales is now user-controlled.

  • [BREAKING] The tsOut config file option is replaced by the new output object, with mode: "runtime"|"transform".

Added

  • Add transform output mode, which emits an entire copy of the program in each locale, where all msg calls have been replaced with the raw translated template for that locale.

  • Add configureLocalization function, which returns a setLocale and getLocale object.

  • Add lit-localize-status event, which is dispatched to window whenever a locale change starts, completes, or fails.

  • Add Localized mixin for LitElement components, which automatically re-renders whenever the locale changes in runtime mode.

Fixed

  • Fix incorrect JSON schema error about targetLocales field not being a string[].

  • Fix bug where htmltemplates could not contain<!-- comments -->. HTML comments are now preserved as placeholders, similar to other HTML markup.

[0.2.3] - 2020-05-13

  • Fix missing <xliff> element in XLIFF output.
  • Formatting change to XML output (e.g. fewer line breaks).

[0.2.2] - 2020-05-13

  • Fix incorrect path resolution when loading XLB files.
  • Fix errors relating to prettier xml plugin resolution.

[0.2.1] - 2020-05-13

  • Add missing dependencies (fs-extra, typescript, prettier).

[0.2.0] - 2020-05-13

  • Add support for the XLIFF localization interchange format: https://docs.oasis-open.org/xliff/v1.2/os/xliff-core.html

  • [BREAKING] Replaced xlbDir config file property with interchange property. The interchange format is set with interchange.format (currently xliff or xlb), and other format-specific configuration is set in that object.

  • Fix code generation bug where having more than one targetLocale would compile to invalid TypeScript (extra commas).

  • Disable eslint warnings about camelcase for locale module imports like zh_CN.ts.

[0.1.2] - 2020-05-09

  • Add support for variables:

    msg(
  'hello',
  (url: string, name: string) =>
    html`Hello ${name}, click <a href="${url}">here</a>!`,
  'World',
  'https://www.example.com/'
);

[0.1.1] - 2020-05-05

  • Interpret paths as relative to the location of the config file, instead of relative to the current working directory.

  • Move @types packages from dependencies to devDependencies if they aren't part of any API. In particular, this fixes an error where any package that depended on lit-localize would need to add DOM to their TypeScript lib settings for compatibility with @types/xmldom.

  • Publish .d.ts files.

[0.1.0] - 2020-05-05

  • Initial release of lit-localize.