next-intl plugin

Plugin

@inlang/plugin-next-intl

2.4.3

Patch Changes

Updated dependencies [9725173]
- @inlang/sdk@4.0.4

2.4.2

Patch Changes

Updated dependencies [77e4888]
- @inlang/sdk@4.0.3

2.4.1

Patch Changes

ee8b10d: Exports of plurals nested in selects and selects nested in plurals are valid ICU that displays what the source displays, e.g. no select without other in a case of a plural and no '#' in a select nested in a plural. See @inlang/plugin-icu1.

2.4.0

Minor Changes

83903d8: Analyze where a next-intl app uses messages (analyzeUsage), so that the SDK's unused-message check and findUsages, inlang check --unused-messages and Fink work for next-intl projects. No other plugin is needed.

A message such as Home.title is used by useTranslations("Home") or getTranslations("Home") (also getTranslations({ locale, namespace }) and createTranslator({ namespace })) followed by t("title"), t.rich("title") or t.markup("title"), or by t("Home.title") without a namespace. Aliases, renamed and namespace imports, constant keys, ternaries and arrays of keys that are only iterated (keys.map((key) => t(key))) resolve. Server and Client Components in .ts, .tsx, .js, .jsx, .mjs, .cjs and .mdx files are read.

Anything that can't be resolved makes the analysis incomplete, with the file, line and column: then no message is reported unused or deleted. That includes dynamic keys and namespaces (t(`items.${id}`), t(key)), a translator passed to a function or component, returned from a custom hook or exported, next-intl functions imported from a wrapper module or package, t.raw() and t.has() of a key that could be a namespace, useMessages() and getMessages() other than for NextIntlClientProvider, message files read directly or nested where the plugin doesn't put them, re-exports of next-intl, useExtracted(), and types derived from the message keys (MessageKeys, keyof Messages, keyof IntlMessages["Nav"], Parameters<typeof t>). Passing all messages to NextIntlClientProvider or getRequestConfig, and typing next-intl with Messages: typeof messages, keep the analysis complete.

Patch Changes

c13aa24: Messages with a select or plural nested in a case ahead of the selector it is nested in, e.g. {gender, select, female {She} other {{count, plural, one {one item} other {{gender, select, male {his items} other {their items}}}}}}, now import with variants that select what next-intl displays: for gender=male, count=1 "one item" instead of "his items". See @inlang/plugin-icu1.
Updated dependencies [6e2c188]
- @inlang/sdk@4.0.2

2.3.0

Minor Changes

cbfce83: Read and write next-intl messages as ICU MessageFormat, with the parser next-intl uses (intl-messageformat). Plurals (=0, one, #, offset), selects, selectordinals and nested ones import as selectors and variants, rich text tags (<b>…</b>, <link>…</link>) as markup, and number, date and time formats as annotated arguments. Editors can edit plural forms and add an exact =0, and the checks of checkProject and checkBundle compare the variants and tags of translations.

Before, the plugin split messages at braces, so {count, plural, =0 {none} one {# item} other {# items}} imported as the variables count, plural, =0 {none, # item and # items, which every check of a translation reported as missing and unknown variables, and messages with variants (e.g. a plural added in an editor) were written as one of their variants.

Also fixed:
- A new message is nested at the dots of its key (Checkout.Summary.total goes to "Checkout": { "Summary": { "total": … } }). Before, it was written as the flat key "Checkout.Summary.total", which next-intl can't read: it shows the key instead. A new translation of an existing message goes where the message's other translations are, e.g. to a key with a dot.
- Literal {, } and tags in edited text are quoted ('{'beta'}', '<'b>). Before, Start {beta} was written as is, and next-intl read {beta} as an argument.
- Quoted ICU ('{name}', it''s) imports as the text next-intl displays.
Unchanged messages keep their text, so files only change where messages were edited. A message that isn't valid ICU is read as text and keeps its text. Projects that set a custom variableReferencePattern (e.g. ["{{", "}}"]) keep reading messages as text with variables.

Patch Changes

Updated dependencies [1c1913c]
Updated dependencies [d04deba]
- @inlang/sdk@4.0.1

2.2.2

Patch Changes

8b7cf25: Saving a project only changes the entries of the message files that were edited. Unchanged entries keep their text, and the files keep their key order, nesting, indentation and line endings, also with namespaced pathPatterns and sourceLanguageFilePath. Exporting large files is also faster.
4ecf2bd: Deleting every message of a translation file now persists. If all messages of a locale (or of an i18next namespace of a locale) were deleted, the export had nothing to write for that file, so saveProjectToDirectory left it on disk as it was, and the deleted messages came back on the next load.

The plugin contract of exportFiles with files is extended: a plugin also returns a file for every previous file that the project read, that holds messages the project no longer has and that the export doesn't otherwise write, without those messages. Whether the project read a file is the new ExistingFile.imported: saveProjectToDirectory sets it for files whose content is what loadProjectFromDirectory imported or what a save wrote. A file the project never read (e.g. of a locale added to the settings after loading, or changed on disk since) is never emptied; hosts that can't tell leave imported out. keepUnchangedJsonEntries does this for the JSON plugins (message-format, i18next, json, next-intl, icu1, apple-xcstrings): every key that imports to a message is removed (walking into objects that hold messages), everything else ($schema, keys the plugin doesn't read) and the formatting stay, so a file whose messages were all deleted becomes {}, or { "$schema": … }. The file is kept, not deleted: the plugin still lists it for the locale, the next message of the locale goes there, and tools may expect it. The previous file's path is the exported file's name and its metadata.pathPattern, so saveProjectToDirectory writes it to exactly that file, also one of a pathPattern array; other hosts that pass files should write a file with a metadata.pathPattern there too. Files that hold no deleted message (e.g. an empty file, or an i18next namespace whose messages another namespace overrides) stay byte-identical.

@inlang/plugin-apple-strings writes the .strings file of such a locale without its entries and their comments; other comments (e.g. a license header) stay. @inlang/plugin-android writes the strings.xml of such a locale without its messages; elements it doesn't import (non-translatable strings, <string-array>s, …) and heading comments stay. This includes the base locale's values/strings.xml: deleting every message of the base locale removes Android's default strings, so the app needs other default resources. If such a file can't be written without removing elements the plugin doesn't import, it is left as it is instead of failing the export.

A file counts as read only as the locale (and namespace) it was read or written as, so a file that a settings change assigns to another locale (e.g. a new base locale for values/) is not emptied.
abfd521: keepUnchangedJsonEntries now checks the kept files in the order a project load reads them. Its safety net re-imports the files as they will be on disk and only keeps their text if they read like the full export, but it read the exported files in the order the plugin returned them and the files the export doesn't replace after them. When two files have the same message (e.g. overlapping i18next namespaces), the file read last wins, so a different order could accept kept text with a stale copy of an edited message, and the edit was lost on the next load. The files are now read in the order of files (toBeImportedFiles, like loadProjectFromDirectory), an exported file at the place of the file it replaces (at every place for several files of a pathPattern array, which the host writes it to); a new file (no place known yet) before the next exported file of its locale that has a place, so plugins that export in load order like i18next keep their order, else last. The JSON plugins bundle the helper.
Updated dependencies [5c0a84b]
Updated dependencies [2390c5a]
Updated dependencies [f45a761]
Updated dependencies [356a50a]
Updated dependencies [ad469a7]
Updated dependencies [fa0777c]
Updated dependencies [94cf565]
Updated dependencies [691caec]
Updated dependencies [4ecf2bd]
Updated dependencies [b38facf]
Updated dependencies [abfd521]
Updated dependencies [56923c5]
Updated dependencies [b0d8a4f]
Updated dependencies [fb83c18]
Updated dependencies [3e9bd54]
- @inlang/sdk@4.0.0

2.2.1

Patch Changes

3502588: Publish TypeScript declarations and explicit type exports for all official plugins. Keep declaration dependencies available to consumers and exclude test declarations from production builds. Fix the message-format file-schema export to reference published JavaScript and declarations.
56891d6: Remove deprecated dependencies so installing the JSON and next-intl plugins no longer pulls in legacy inlang and Lix packages. JSON formatting and existing plugin behavior are preserved.
Updated dependencies [68eefaf]
Updated dependencies [56891d6]
Updated dependencies [5df91b6]
- @inlang/sdk@3.1.0

2.2.0

Minor Changes

25747cd: Improve Sherlock message reference matching for next-intl translator aliases and quoted object namespace assignments.

The matcher now resolves simple aliases like const translate = t, chained aliases, renamed destructured translation functions, and direct getTranslations({ namespace }) assignments with single- or double-quoted namespace values.

2.1.0

Minor Changes

bf2af52: Add new import/export API support with namespace path patterns while keeping legacy next-intl project settings and {languageTag} path patterns compatible.

Allow export files to override the configured path pattern via metadata so plugins can safely route individual files without mutating project settings.

2.0.1

Patch Changes

a410265: Added support for multiple useTranslations function names

2.0.0

Major Changes

75de822: # Update plugins to support Sherlock v2 & SDK v2 compatibility

The plugin now uses the new API for message extraction (bundleId instead of messageId).

Upgrading to Sherlock v2

There is no action needed to upgrade to Sherlock v2. The plugin is now compatible with the new version and if you linked the plugin with @latestas we advise in the documentation.

You should be able to use the plugin with Sherlock v2 without any issues. If there are any issues, please let us know via Discord/GitHub.

Want to keep Sherlock v1 and the old plugin version?

If you still want to use Sherlock v1, please use the previous major version of the plugin. For Sherlock itself, please pin the version to 1.x.x in the VS Code extension settings.

Breaking changes
- Lint rules are now polyfilled (and therefore may work different), as we are currently reworking how lint rules are working with Lix Validation Rules.
- The messageId parameter in the extractMessages function has been renamed to bundleId. This change is due to the new API in Sherlock v2. If you are using the extractMessages function, please update the parameter name to bundleId.

1.4.0

Minor Changes

default to {} single brackets

1.3.49

Patch Changes

c26aac4: refactor icon

1.3.48

Patch Changes

@inlang/sdk@0.36.3

1.3.47

Patch Changes

Updated dependencies [2fc5feb]
- @inlang/sdk@0.36.2

1.3.46

Patch Changes

Updated dependencies [1077e06]
- @inlang/sdk@0.36.1

1.3.45

Patch Changes

Updated dependencies [8ec7b34]
Updated dependencies [05f9282]
- @inlang/sdk@0.36.0

1.3.44

Patch Changes

Updated dependencies [8e9fc0f]
- @inlang/sdk@0.35.9

1.3.43

Patch Changes

04e804b: add human readble id tests to plugins
aa91877: add more extract options

1.3.42

Patch Changes

Updated dependencies [da7c207]
- @inlang/sdk@0.35.8

1.3.41

Patch Changes

2b36271: add changeset

1.3.40

Patch Changes

Updated dependencies [2a5645c]
- @inlang/sdk@0.35.7

1.3.39

Patch Changes

Updated dependencies [9d2aa1a]
- @inlang/sdk@0.35.6

1.3.38

Patch Changes

6a37426: support more flexible hooks argument passing
c780d2f: improve namespace parser to catch hooks sequentially

1.3.37

Patch Changes

Updated dependencies [64e30ee]
- @inlang/sdk@0.35.5

1.3.36

Patch Changes

@inlang/sdk@0.35.4

1.3.35

Patch Changes

@inlang/sdk@0.35.3

1.3.34

Patch Changes

@inlang/sdk@0.35.2

1.3.33

Patch Changes

@inlang/sdk@0.35.1

1.3.32

Patch Changes

Updated dependencies [ae47203]
- @inlang/sdk@0.35.0

1.3.31

Patch Changes

Updated dependencies [d27a983]
Updated dependencies [a27b7a4]
- @inlang/sdk@0.34.10

1.3.30

Patch Changes

Updated dependencies [a958d91]
- @inlang/sdk@0.34.9

1.3.29

Patch Changes

Updated dependencies [10dbd02]
- @inlang/sdk@0.34.8

1.3.28

Patch Changes

Updated dependencies [5209b81]
- @inlang/sdk@0.34.7

1.3.27

Patch Changes

Updated dependencies [f38536e]
- @inlang/sdk@0.34.6

1.3.26

Patch Changes

Updated dependencies [b9eccb7]
- @inlang/sdk@0.34.5

1.3.25

Patch Changes

Updated dependencies [2a90116]
- @inlang/sdk@0.34.4

1.3.24

Patch Changes

f37599b: change README

1.3.23

Patch Changes

Updated dependencies [bc17d0c]
- @inlang/sdk@0.34.3

1.3.22

Patch Changes

1abcc3f: update docs

1.3.21

Patch Changes

Updated dependencies [3c959bc]
- @inlang/sdk@0.34.2

1.3.20

Patch Changes

@inlang/sdk@0.34.1

1.3.19

Patch Changes

Updated dependencies [5b8c053]
- @inlang/sdk@0.34.0

1.3.18

Patch Changes

@inlang/sdk@0.33.1

1.3.17

Patch Changes

Updated dependencies [d573ab8]
- @inlang/sdk@0.33.0

1.3.16

Patch Changes

bc00427: fix typo
Updated dependencies [bc9875d]
- @inlang/sdk@0.32.0

1.3.15

Patch Changes

Updated dependencies [c068dd2]
- @inlang/sdk@0.31.0

1.3.14

Patch Changes

Updated dependencies [9b26a31]
- @inlang/sdk@0.30.0

1.3.13

Patch Changes

Updated dependencies [62dfa26]
- @inlang/sdk@0.29.0

1.3.12

Patch Changes

@inlang/sdk@0.28.3

1.3.11

Patch Changes

923a4bb: fix discord link

1.3.10

Patch Changes

@inlang/sdk@0.28.2

1.3.9

Patch Changes

@inlang/sdk@0.28.1

1.3.8

Patch Changes

Updated dependencies [1e43ae4]
- @inlang/sdk@0.28.0

1.3.7

Patch Changes

f3b0489: fix typo

1.3.6

Patch Changes

4837297: File locking for concurrent message updates through the load/store plugin api Auto-generated human-IDs and aliases - only with experimental: { aliases: true }
Updated dependencies [4837297]
- @inlang/sdk@0.27.0