lingo-guardian 0.1.0 → 0.1.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 +64 -5
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,23 +4,61 @@
|
|
|
4
4
|
|
|
5
5
|
Powered by [Lingo.dev](https://lingo.dev)
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## 📦 Installation
|
|
8
10
|
|
|
9
11
|
```bash
|
|
10
12
|
npm install -g lingo-guardian
|
|
11
13
|
```
|
|
12
14
|
|
|
13
|
-
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
## 🔑 API Key Setup
|
|
18
|
+
|
|
19
|
+
Lingo-Guardian uses **Lingo.dev** for AI-powered translations.
|
|
20
|
+
|
|
21
|
+
### Step 1: Get Your API Key
|
|
22
|
+
1. Go to [lingo.dev](https://lingo.dev)
|
|
23
|
+
2. Sign up or log in
|
|
24
|
+
3. Navigate to **Settings → API Keys**
|
|
25
|
+
4. Create a new API key
|
|
26
|
+
|
|
27
|
+
### Step 2: Set Your API Key
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
# Option A: Environment variable (recommended)
|
|
31
|
+
export LINGODOTDEV_API_KEY="your-api-key-here"
|
|
32
|
+
|
|
33
|
+
# Option B: .env file in your project
|
|
34
|
+
echo "LINGODOTDEV_API_KEY=your-api-key" > .env
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### Step 3: Initialize Lingo.dev
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
cd your-project
|
|
41
|
+
npx lingo.dev@latest init
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
---
|
|
45
|
+
|
|
46
|
+
## 🚀 Quick Start
|
|
14
47
|
|
|
15
48
|
```bash
|
|
16
49
|
# Initialize Lingo.dev in your project
|
|
17
50
|
npx lingo.dev@latest init
|
|
18
51
|
|
|
52
|
+
# Start your dev server
|
|
53
|
+
npm run dev
|
|
54
|
+
|
|
19
55
|
# Run the audit
|
|
20
56
|
lingo-guardian lint http://localhost:3000
|
|
21
57
|
```
|
|
22
58
|
|
|
23
|
-
|
|
59
|
+
---
|
|
60
|
+
|
|
61
|
+
## ✨ Features
|
|
24
62
|
|
|
25
63
|
- 🔍 CSS overflow detection (`scrollWidth > offsetWidth`)
|
|
26
64
|
- 🌍 Pseudo-locale text expansion testing
|
|
@@ -28,18 +66,39 @@ lingo-guardian lint http://localhost:3000
|
|
|
28
66
|
- 📊 Table, JSON, and HTML reports
|
|
29
67
|
- 🖥️ Cross-platform (Mac, Windows, Linux)
|
|
30
68
|
|
|
31
|
-
|
|
69
|
+
---
|
|
70
|
+
|
|
71
|
+
## 📖 Usage
|
|
32
72
|
|
|
33
73
|
```bash
|
|
34
74
|
lingo-guardian lint <url> [options]
|
|
35
75
|
|
|
36
76
|
Options:
|
|
77
|
+
-p, --project <path> Project with i18n.json (default: cwd)
|
|
37
78
|
-l, --locale <locales...> Locales to test (default: ["en", "pseudo"])
|
|
38
79
|
-f, --format <format> Output format: table, json, html
|
|
39
80
|
--fail-on-error Exit with error code if issues found
|
|
40
81
|
-v, --verbose Enable verbose logging
|
|
41
82
|
```
|
|
42
83
|
|
|
43
|
-
|
|
84
|
+
### Examples
|
|
85
|
+
|
|
86
|
+
```bash
|
|
87
|
+
# Basic audit
|
|
88
|
+
lingo-guardian lint http://localhost:3000
|
|
89
|
+
|
|
90
|
+
# Test multiple locales
|
|
91
|
+
lingo-guardian lint http://localhost:3000 --locale en pseudo ar de
|
|
92
|
+
|
|
93
|
+
# CI mode with exit code
|
|
94
|
+
lingo-guardian lint http://localhost:3000 --fail-on-error
|
|
95
|
+
|
|
96
|
+
# HTML report
|
|
97
|
+
lingo-guardian lint http://localhost:3000 --format html -o ./reports
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
---
|
|
101
|
+
|
|
102
|
+
## 📄 License
|
|
44
103
|
|
|
45
104
|
MIT
|
package/package.json
CHANGED