@ankhorage/orchestrator-module-expo-localization 0.1.1 → 0.1.2

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.
Files changed (3) hide show
  1. package/CHANGELOG.md +6 -0
  2. package/README.md +10 -72
  3. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -1,5 +1,11 @@
1
1
  # @ankhorage/orchestrator-module-expo-localization
2
2
 
3
+ ## 0.1.2
4
+
5
+ ### Patch Changes
6
+
7
+ - Refresh the README copy so the published module overview and install usage stay aligned with the current messaging.
8
+
3
9
  ## 0.1.1
4
10
 
5
11
  ### Patch Changes
package/README.md CHANGED
@@ -1,78 +1,16 @@
1
- # @ankhorage/orchestrator-module-expo-localization
1
+ # orchestrator-module-expo-localization
2
2
 
3
- `@ankhorage/orchestrator-module-expo-localization` is the first standalone module extracted for `@ankhorage/orchestrator`. It replaces the old localization plugin contract from `ankhorage4/packages/plugin-kit` with a pure module that only returns supported orchestrator actions.
3
+ Adds localization support to Expo apps.
4
4
 
5
- The repo follows the module-owned template pattern: generated runtime files come from checked-in [`templates/*.tpl`](./templates) assets that the module reads and materializes into orchestrator `write-files` actions.
6
-
7
- ## What it does
8
-
9
- - ensures `i18next`, `react-i18next`, and `expo-localization`
10
- - writes localization runtime files into `src/plugins/localization`
11
- - patches `src/app/_layout.tsx` to wrap the generated app shell with `LocalizationPluginProvider`
12
- - patches `app.config.ts` to register the Expo localization config plugin
13
- - keeps `ankh.config.json` aligned at `settings.localization`
14
-
15
- The module does not implement or depend on executor behavior outside the orchestrator contract. It only emits `ensure-packages`, `write-files`, `patch-text-block`, and `json-set`.
16
-
17
- ## Install
18
-
19
- ```sh
20
- bun add @ankhorage/orchestrator @ankhorage/orchestrator-module-expo-localization
21
- ```
22
-
23
- ## Usage
24
-
25
- ```ts
26
- import { createOrchestrator } from '@ankhorage/orchestrator';
27
- import { expoLocalizationModule } from '@ankhorage/orchestrator-module-expo-localization';
28
-
29
- const orchestrator = createOrchestrator({
30
- modules: [expoLocalizationModule],
31
- projectRoot: '/absolute/path/to/project',
32
- });
33
-
34
- await orchestrator.installModule('expo-localization', {
35
- config: {
36
- defaultLocale: 'en',
37
- locales: ['en', 'de'],
38
- translations: {
39
- en: { hello: 'Hello' },
40
- de: { hello: 'Hallo' },
41
- },
42
- },
43
- });
44
- ```
45
-
46
- ## Config
5
+ ## 🎯 What you get
6
+ - Localization setup instantly
7
+ - No boilerplate
8
+ - Fully reversible
47
9
 
10
+ ## 📦 Usage
48
11
  ```ts
49
- {
50
- defaultLocale?: string;
51
- locales?: string[];
52
- translations?: Record<string, Record<string, string>>;
53
- }
12
+ orchestrator.install('expo-localization')
54
13
  ```
55
14
 
56
- Defaults:
57
-
58
- - `defaultLocale`: `"en"`
59
- - `locales`: `["en"]`
60
- - `translations`: `{}`
61
-
62
- ## Assumptions
63
-
64
- - The target app already has a generated `src/app/_layout.tsx`.
65
- - The target app uses the standard `@/` alias layout generated by the surrounding Ankhorage toolchain.
66
-
67
- This package is meant for the newer `@ankhorage/orchestrator` stack and supersedes the old `@ankh/plugin-kit` localization plugin path that is planned for removal.
68
-
69
- ## Development
70
-
71
- ```sh
72
- bun install
73
- bun run format:check
74
- bun run lint
75
- bun run test
76
- bun run build
77
- bun run knip
78
- ```
15
+ ## 🧠 Why this exists
16
+ Standardizes localization setup across apps.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ankhorage/orchestrator-module-expo-localization",
3
- "version": "0.1.1",
3
+ "version": "0.1.2",
4
4
  "description": "Expo localization module for @ankhorage/orchestrator.",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",