rename bundle to key?

[samuelstroschein]

Proposal

Rename bundle to key to align with user expectations and reduce communication effort.

• (+) aligns with user expectations. users are referring to "bundles" as keys.
• (+) eases communication. we won't need to explain that bundles are "like keys"
• (+) aligns with the industry. other localization tooling refers to bundles as keys.
• (-) breaking change 💀

Context

Bundles are "breaking" the communication model of "messages" and will lead to confusion and higher effort of releasing the inlang sdk v2.

Example: Paraglide JS

1. Paraglide JS users import messages from paraglide-js/messages.

With the introduction of bundles, they import a bundle now though which is still a message. If that sentence confused you, that's the problem.

import * as m from "paraglide-j/messages/index.js" 

// this is referencing a bundle
const output = m.happy_elephant()

// but the output is a message
console.log(output) -> "You need to login!"

2. The term bundle clashes with compiling.

The output of compiling an app is a bundle. We will have to have warnings in the documentation to not confuse a message bundle and app bundle.

Example: Sherlock

Sherlock used to extract messages but now it's a bundle.

Example Fink

Fink allows adding a bundle. Every other CAT editor refers to this as adding a new key.

Screenshot from Lokalise

Screenshot from Tolgee