babelize 1.0.0 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +70 -5
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,14 +1,79 @@
|
|
|
1
1
|
# babelize
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
**Ship your app in every language, with one command.**
|
|
4
|
+
|
|
5
|
+
[](https://www.npmjs.com/package/babelize)
|
|
6
|
+
[](https://github.com/babelize/babelize-dashboard/blob/main/packages/babelize/LICENSE)
|
|
7
|
+
[](https://nodejs.org)
|
|
8
|
+
|
|
9
|
+
Babelize finds the hardcoded text in your app, wraps it in translation calls, translates it, and writes the locale files into your project. You review the result with `git diff`, like any other change.
|
|
4
10
|
|
|
5
11
|
```bash
|
|
6
12
|
npx babelize
|
|
7
13
|
```
|
|
8
14
|
|
|
9
|
-
Run it in your project's folder.
|
|
15
|
+
Run it in your project's folder. That's all: no config file and no API key.
|
|
16
|
+
|
|
17
|
+
## What happens
|
|
18
|
+
|
|
19
|
+
1. **Git.** Babelize checks that your project is in git, so every change can be reviewed and undone. If it isn't, it offers to set git up for you.
|
|
20
|
+
2. **Your app.** It detects the framework, any i18n library you already use, and the language your app is written in.
|
|
21
|
+
3. **Sign in.** Your browser opens to sign in with GitHub, Google or email. Translation uses your plan's credits, and the free plan includes some.
|
|
22
|
+
4. **Languages.** Pick the languages you want. Babelize remembers them for next time.
|
|
23
|
+
5. **Translate.** Locale files and i18n code are written into your project. Review them with `git diff`, then commit.
|
|
24
|
+
|
|
25
|
+
Run `npx babelize` again whenever your app changes. Only new or changed text is translated.
|
|
26
|
+
|
|
27
|
+
## Works with
|
|
28
|
+
|
|
29
|
+
| Framework | Status |
|
|
30
|
+
| --- | --- |
|
|
31
|
+
| Next.js (App Router) | ✓ with next-intl |
|
|
32
|
+
| React (Vite, CRA and similar) | ✓ with react-i18next |
|
|
33
|
+
| Django | ✓ with gettext `.po` files |
|
|
34
|
+
| Static HTML | ✓ |
|
|
35
|
+
| Vue | Beta |
|
|
36
|
+
| React Native (Expo and bare) | Beta |
|
|
37
|
+
|
|
38
|
+
Translates into 90+ languages.
|
|
39
|
+
|
|
40
|
+
## More commands
|
|
41
|
+
|
|
42
|
+
All the commands of the [Babelize CLI](https://www.npmjs.com/package/@babelize/cli) work through `babelize`:
|
|
43
|
+
|
|
44
|
+
```bash
|
|
45
|
+
npx babelize translate --to fr,de,ja # translate without the questions
|
|
46
|
+
npx babelize check # QA your locale files (missing keys, placeholders, ICU)
|
|
47
|
+
npx babelize auth login # sign in
|
|
48
|
+
npx babelize --help # everything else
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
### Your own LLM key
|
|
52
|
+
|
|
53
|
+
Set a key and Babelize translates with it instead of your credits. No account is needed:
|
|
54
|
+
|
|
55
|
+
```bash
|
|
56
|
+
export ANTHROPIC_API_KEY=sk-ant-... # or OPENAI_API_KEY, GEMINI_API_KEY, GROQ_API_KEY, OPENROUTER_API_KEY
|
|
57
|
+
npx babelize translate --to fr,de
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
### In CI
|
|
61
|
+
|
|
62
|
+
```bash
|
|
63
|
+
export BABELIZE_API_KEY=bblz_sk_... # create one at app.babelize.co/api-keys
|
|
64
|
+
npx babelize start --to fr,de --yes
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
## Pull requests instead
|
|
68
|
+
|
|
69
|
+
Prefer Babelize to open pull requests on your GitHub repo, and keep them up to date as you push? Connect the repo at [app.babelize.co](https://app.babelize.co).
|
|
70
|
+
|
|
71
|
+
## Links
|
|
72
|
+
|
|
73
|
+
- [Docs](https://docs.babelize.co/cli)
|
|
74
|
+
- [Dashboard](https://app.babelize.co)
|
|
75
|
+
- [babelize.co](https://babelize.co)
|
|
10
76
|
|
|
11
|
-
|
|
77
|
+
---
|
|
12
78
|
|
|
13
|
-
|
|
14
|
-
- Dashboard: https://app.babelize.co
|
|
79
|
+
`babelize` is the short name for [`@babelize/cli`](https://www.npmjs.com/package/@babelize/cli). Each release is pinned to an exact CLI version. Licensed under Apache-2.0.
|