@localey/react 0.1.2 → 0.1.3

package/README.md

@@ -1,22 +1,28 @@
-# @localey/adapter-react
+# @localey/react
 
-React adapter for Localey. Uses Babel AST traversal to identify hardcoded strings in JSX and component props.
+React and JSX adapter for Localey.
 
-## Supported Patterns
+This package provides the logic necessary for Localey to understand and manipulate React source code. It utilizes high-precision Abstract Syntax Tree (AST) traversal to identify hardcoded strings within JSX elements and component properties.
 
-### JSX Text
+## Detection Logic
 
-```tsx
-<div>Hello World</div> -> <div>{t("hello.world")}</div>
-```
+The adapter utilizes the `@babel/parser` and `@babel/traverse` packages to analyze source code. It targets specific nodes within the AST that predominantly contain user-facing text.
 
-### Component Props
+### Supported Patterns
 
-```tsx
-<Button label="Save" /> -> <Button label={t("save")} />
-```
+- **JSX Text Nodes**: Standard text content between opening and closing JSX tags.
+- **Component Attributes**: String literals passed to props (e.g., `label`, `title`, `placeholder`).
+- **Conditional Strings**: Support for strings within ternary operators and template literals is currently handled via AST inspection.
 
-## Internal Tools
+### Code Transformation
 
-- **Babel Parser**: Supports TypeScript and JSX.
-- **AST Visitor**: Framework-aware detection logic.
+During the `extract` process, this adapter replaces string literals with JSX expression containers.
+
+- **Pattern**: `text` -> `{t("key")}`
+- **Attribute Pattern**: `attr="value"` -> `attr={t("key")}`
+
+## Technical Implementation
+
+- **Parser Configuration**: The adapter is configured to support both `.js`/`.jsx` and `.ts`/`.tsx` files by enabling the `jsx` and `typescript` Babel plugins.
+- **AST Visitor**: Implementation of the Visitor pattern to efficiently navigate the tree and identify candidates for localization.
+- **Generator**: Uses `@babel/generator` to reconstruct the source code from the modified AST, ensuring syntactic correctness.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@localey/react",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "type": "module",
   "main": "./dist/index.js",
   "dependencies": {