i18ntk 1.4.0 → 1.4.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.
- package/CHANGELOG.md +61 -1
- package/README.md +410 -20
- package/locales/de/common.json +17 -20
- package/locales/en/common.json +17 -20
- package/locales/es/common.json +17 -20
- package/locales/fr/common.json +17 -20
- package/locales/ru/common.json +17 -20
- package/main/i18ntk-manage.js +52 -24
- package/package.json +6 -8
- package/{dev → scripts}/debug/README.md +9 -5
- package/{dev → scripts}/debug/debugger.js +84 -4
- package/scripts/prepublish.js +2 -2
- package/scripts/validate-all-translations.js +2 -2
- package/ui-locales/de/debug.json +5 -5
- package/ui-locales/de/init.json +1 -0
- package/ui-locales/de/language.json +11 -2
- package/ui-locales/de/security.json +2 -1
- package/ui-locales/de/sizing.json +1 -0
- package/ui-locales/de/usage.json +1 -0
- package/ui-locales/en/debug.json +5 -5
- package/ui-locales/en/init.json +1 -0
- package/ui-locales/en/language.json +11 -2
- package/ui-locales/en/security.json +2 -1
- package/ui-locales/en/sizing.json +2 -0
- package/ui-locales/en/usage.json +1 -0
- package/ui-locales/es/debug.json +5 -5
- package/ui-locales/es/init.json +1 -0
- package/ui-locales/es/language.json +11 -2
- package/ui-locales/es/security.json +2 -1
- package/ui-locales/es/sizing.json +2 -0
- package/ui-locales/es/usage.json +1 -0
- package/ui-locales/fr/debug.json +5 -5
- package/ui-locales/fr/init.json +1 -0
- package/ui-locales/fr/language.json +11 -2
- package/ui-locales/fr/security.json +2 -1
- package/ui-locales/fr/sizing.json +2 -0
- package/ui-locales/fr/usage.json +1 -0
- package/ui-locales/ja/debug.json +5 -5
- package/ui-locales/ja/init.json +1 -0
- package/ui-locales/ja/language.json +11 -2
- package/ui-locales/ja/security.json +2 -1
- package/ui-locales/ja/sizing.json +3 -0
- package/ui-locales/ja/usage.json +1 -0
- package/ui-locales/pt/debug.json +5 -5
- package/ui-locales/pt/init.json +1 -0
- package/ui-locales/pt/language.json +11 -2
- package/ui-locales/pt/security.json +2 -1
- package/ui-locales/pt/sizing.json +2 -0
- package/ui-locales/pt/usage.json +1 -0
- package/ui-locales/ru/debug.json +5 -5
- package/ui-locales/ru/init.json +1 -0
- package/ui-locales/ru/language.json +11 -2
- package/ui-locales/ru/security.json +2 -1
- package/ui-locales/ru/sizing.json +2 -0
- package/ui-locales/ru/usage.json +1 -0
- package/ui-locales/zh/debug.json +5 -5
- package/ui-locales/zh/init.json +1 -0
- package/ui-locales/zh/language.json +11 -2
- package/ui-locales/zh/security.json +2 -1
- package/ui-locales/zh/sizing.json +2 -0
- package/ui-locales/zh/usage.json +1 -0
- package/utils/test-complete-system.js +1 -1
- package/dev/README.md +0 -37
- package/docs/INSTALLATION.md +0 -98
- package/docs/PIN_PROTECTION_GUIDE.md +0 -265
- package/docs/README.md +0 -111
- package/docs/SCRIPT_DIRECTORY_GUIDE.md +0 -278
- package/docs/TODO_ROADMAP.md +0 -279
- package/docs/TRANSLATION_STATUS.md +0 -67
- package/docs/api/API_REFERENCE.md +0 -258
- package/docs/api/COMPONENTS.md +0 -492
- package/docs/api/CONFIGURATION.md +0 -676
- package/docs/api/NPM_PUBLISHING_GUIDE.md +0 -426
- package/docs/debug/DEBUG_README.md +0 -30
- package/docs/debug/DEBUG_TOOLS.md +0 -152
- package/docs/development/AGENTS.md +0 -349
- package/docs/development/DEVELOPMENT_RULES.md +0 -165
- package/docs/development/DEV_README.md +0 -41
- package/docs/release-notes/RELEASE_NOTES_v1.0.0.md +0 -175
- package/docs/release-notes/RELEASE_NOTES_v1.0.4.md +0 -153
- package/docs/release-notes/RELEASE_NOTES_v1.1.2.md +0 -68
- package/docs/release-notes/RELEASE_NOTES_v1.1.5.md +0 -81
- package/docs/release-notes/RELEASE_NOTES_v1.4.0.md +0 -115
- package/docs/release-notes/RELEASE_NOTES_v1.6.0.md +0 -141
- package/docs/release-notes/RELEASE_NOTES_v1.6.1.md +0 -185
- package/docs/release-notes/RELEASE_NOTES_v1.6.3.md +0 -199
- package/docs/release-notes/v1.3.0.md +0 -162
- package/docs/release-notes/v1.3.1.md +0 -136
- package/docs/reports/ANALYSIS_README.md +0 -17
- package/docs/reports/CONSOLE_MISMATCH_BUG_REPORT_v1.5.0.md +0 -181
- package/docs/reports/SIZING_README.md +0 -18
- package/docs/reports/SUMMARY_README.md +0 -18
- package/docs/reports/TRANSLATION_BUG_REPORT_v1.5.0.md +0 -129
- package/docs/reports/USAGE_README.md +0 -18
- package/docs/reports/VALIDATION_README.md +0 -18
- /package/{dev → scripts}/debug/complete-console-translations.js +0 -0
- /package/{dev → scripts}/debug/console-key-checker.js +0 -0
- /package/{dev → scripts}/debug/console-translations.js +0 -0
- /package/{dev → scripts}/debug/debug-security.js +0 -0
- /package/{dev → scripts}/debug/debug-translation.js +0 -0
- /package/{dev → scripts}/debug/export-missing-keys.js +0 -0
- /package/{dev → scripts}/debug/final-normalize.js +0 -0
- /package/{dev → scripts}/debug/find-extra-keys.js +0 -0
- /package/{dev → scripts}/debug/normalize-locales.js +0 -0
- /package/{dev → scripts}/debug/refactor-locales.js +0 -0
- /package/{dev → scripts}/debug/reorder-locales.js +0 -0
- /package/{dev → scripts}/debug/replace-hardcoded-console.js +0 -0
package/docs/TODO_ROADMAP.md
DELETED
|
@@ -1,279 +0,0 @@
|
|
|
1
|
-
# i18ntk Development Roadmap & TODO
|
|
2
|
-
|
|
3
|
-
**Current Version:** 1.6.0
|
|
4
|
-
**Status:** 🚀 Public Release Ready
|
|
5
|
-
**Last Updated:** July 28, 2025
|
|
6
|
-
|
|
7
|
-
## 🎯 Immediate Priorities (v1.6.1 - v1.7.0)
|
|
8
|
-
|
|
9
|
-
### 🌍 Phase 1: Complete Console Internationalization
|
|
10
|
-
**Priority:** HIGH | **Target:** v1.6.1-1.6.3
|
|
11
|
-
|
|
12
|
-
#### Console Statement Translation Implementation
|
|
13
|
-
- [ ] **Systematic Translation Key Conversion** (200+ console.log statements)
|
|
14
|
-
- [ ] `utils/maintain-language-purity.js` (25+ statements)
|
|
15
|
-
- [ ] `settings/settings-cli.js` (50+ statements)
|
|
16
|
-
- [ ] `utils/validate-language-purity.js` (20+ statements)
|
|
17
|
-
- [ ] `main/i18ntk-manage.js` (30+ statements)
|
|
18
|
-
- [ ] `settings/settings-manager.js` (15+ statements)
|
|
19
|
-
- [ ] `main/i18ntk-usage.js` (15+ statements)
|
|
20
|
-
- [ ] `utils/translate-mismatches.js` (10+ statements)
|
|
21
|
-
- [ ] `main/i18ntk-autorun.js` (10+ statements)
|
|
22
|
-
- [ ] `utils/native-translations.js` (10+ statements)
|
|
23
|
-
- [ ] `main/ui-i18n.js` (8+ statements)
|
|
24
|
-
|
|
25
|
-
- [ ] **Error Message Translation** (50+ console.error statements)
|
|
26
|
-
- [ ] `settings/settings-manager.js` (15+ error messages)
|
|
27
|
-
- [ ] `scripts/verify-package.js` (12+ error messages)
|
|
28
|
-
- [ ] `main/ui-i18n.js` (4+ error messages)
|
|
29
|
-
- [ ] `utils/i18n-helper.js` (4+ error messages)
|
|
30
|
-
- [ ] `dev/debug/final-normalize.js` (3+ error messages)
|
|
31
|
-
- [ ] `utils/detect-language-mismatches.js` (3+ error messages)
|
|
32
|
-
|
|
33
|
-
- [ ] **Warning Message Translation** (30+ console.warn statements)
|
|
34
|
-
- [ ] `utils/security.js` (9+ warning messages)
|
|
35
|
-
- [ ] `utils/i18n-helper.js` (3+ warning messages)
|
|
36
|
-
- [ ] `main/ui-i18n.js` (3+ warning messages)
|
|
37
|
-
- [ ] `main/i18ntk-usage.js` (3+ warning messages)
|
|
38
|
-
- [ ] `main/i18ntk-init.js` (1+ warning messages)
|
|
39
|
-
|
|
40
|
-
#### Translation Key Structure
|
|
41
|
-
- [ ] **Create Comprehensive Translation Keys**
|
|
42
|
-
```json
|
|
43
|
-
{
|
|
44
|
-
"console": {
|
|
45
|
-
"status": {
|
|
46
|
-
"processing": "Processing {filename}...",
|
|
47
|
-
"completed": "✅ {operation} completed successfully",
|
|
48
|
-
"failed": "❌ {operation} failed: {error}"
|
|
49
|
-
},
|
|
50
|
-
"validation": {
|
|
51
|
-
"violations": "⚠️ {count} violations found",
|
|
52
|
-
"passed": "✅ Validation passed",
|
|
53
|
-
"summary": "📊 {valid}/{total} files valid"
|
|
54
|
-
},
|
|
55
|
-
"workflow": {
|
|
56
|
-
"starting": "🚀 Starting {workflow}...",
|
|
57
|
-
"step": "📋 Step {step}: {description}",
|
|
58
|
-
"report": "📄 Report saved to: {path}"
|
|
59
|
-
}
|
|
60
|
-
}
|
|
61
|
-
}
|
|
62
|
-
```
|
|
63
|
-
|
|
64
|
-
- [ ] **Update All Language Files** (de, es, fr, ja, ru, zh)
|
|
65
|
-
- [ ] Add console translation keys to all 7 language files
|
|
66
|
-
- [ ] Ensure consistent terminology across languages
|
|
67
|
-
- [ ] Validate translation quality and accuracy
|
|
68
|
-
|
|
69
|
-
### 🔧 Phase 2: UI Locales Refactoring
|
|
70
|
-
**Priority:** MEDIUM | **Target:** v1.7.0
|
|
71
|
-
|
|
72
|
-
#### Multi-Language Object Format Implementation
|
|
73
|
-
- [ ] **Refactor ui-locales Structure**
|
|
74
|
-
```json
|
|
75
|
-
{
|
|
76
|
-
"analyzeTranslations": {
|
|
77
|
-
"reportTitle": {
|
|
78
|
-
"en": "TRANSLATION ANALYSIS REPORT FOR {language}",
|
|
79
|
-
"de": "ÜBERSETZUNGSANALYSENBERICHT FÜR {language}",
|
|
80
|
-
"fr": "RAPPORT D'ANALYSE DE TRADUCTION POUR {language}",
|
|
81
|
-
"es": "INFORME DE ANÁLISIS DE TRADUCCIÓN PARA {language}",
|
|
82
|
-
"ru": "ОТЧЁТ О АНАЛИЗЕ ПЕРЕВОДА ДЛЯ {language}",
|
|
83
|
-
"ja": "{language} の翻訳分析レポート",
|
|
84
|
-
"zh": "{language} 翻译分析报告"
|
|
85
|
-
}
|
|
86
|
-
}
|
|
87
|
-
}
|
|
88
|
-
```
|
|
89
|
-
|
|
90
|
-
- [ ] **Migration Strategy**
|
|
91
|
-
- [ ] Create migration script for existing ui-locales
|
|
92
|
-
- [ ] Update ui-i18n.js to handle new format
|
|
93
|
-
- [ ] Maintain backward compatibility during transition
|
|
94
|
-
- [ ] Test all language switching functionality
|
|
95
|
-
|
|
96
|
-
- [ ] **Benefits Implementation**
|
|
97
|
-
- [ ] Single source of truth for all translations
|
|
98
|
-
- [ ] Easier maintenance and consistency checking
|
|
99
|
-
- [ ] Reduced file duplication
|
|
100
|
-
- [ ] Better translation management workflow
|
|
101
|
-
|
|
102
|
-
## 🚀 Medium-Term Goals (v1.7.0 - v2.0.0)
|
|
103
|
-
|
|
104
|
-
### 📊 Enhanced Reporting & Analytics
|
|
105
|
-
**Priority:** MEDIUM | **Target:** v1.8.0
|
|
106
|
-
|
|
107
|
-
- [ ] **Advanced Report Generation**
|
|
108
|
-
- [ ] Interactive HTML reports with charts and graphs
|
|
109
|
-
- [ ] Translation progress tracking over time
|
|
110
|
-
- [ ] Detailed usage analytics with heatmaps
|
|
111
|
-
- [ ] Export reports in multiple formats (PDF, CSV, JSON)
|
|
112
|
-
|
|
113
|
-
- [ ] **Performance Metrics**
|
|
114
|
-
- [ ] Translation loading performance analysis
|
|
115
|
-
- [ ] Memory usage optimization reports
|
|
116
|
-
- [ ] Large project scalability metrics
|
|
117
|
-
- [ ] Benchmark comparisons with other i18n tools
|
|
118
|
-
|
|
119
|
-
### 🔧 Developer Experience Improvements
|
|
120
|
-
**Priority:** MEDIUM | **Target:** v1.9.0
|
|
121
|
-
|
|
122
|
-
- [ ] **Enhanced Debug Tools**
|
|
123
|
-
- [ ] Real-time translation key usage monitoring
|
|
124
|
-
- [ ] Interactive debugging console
|
|
125
|
-
- [ ] Visual translation coverage maps
|
|
126
|
-
- [ ] Automated issue detection and suggestions
|
|
127
|
-
|
|
128
|
-
- [ ] **IDE Integration**
|
|
129
|
-
- [ ] VS Code extension for translation management
|
|
130
|
-
- [ ] IntelliSense support for translation keys
|
|
131
|
-
- [ ] Inline translation previews
|
|
132
|
-
- [ ] Quick actions for missing translations
|
|
133
|
-
|
|
134
|
-
### 🌐 Framework Integration Expansion
|
|
135
|
-
**Priority:** MEDIUM | **Target:** v1.10.0
|
|
136
|
-
|
|
137
|
-
- [ ] **Enhanced React Support**
|
|
138
|
-
- [ ] React hooks for translation management
|
|
139
|
-
- [ ] Component-level translation analysis
|
|
140
|
-
- [ ] Hot-reload translation updates
|
|
141
|
-
- [ ] React DevTools integration
|
|
142
|
-
|
|
143
|
-
- [ ] **Vue.js Integration**
|
|
144
|
-
- [ ] Vue 3 Composition API support
|
|
145
|
-
- [ ] Vue-specific translation components
|
|
146
|
-
- [ ] Vuex integration for translation state
|
|
147
|
-
- [ ] Vue CLI plugin
|
|
148
|
-
|
|
149
|
-
- [ ] **Angular Integration**
|
|
150
|
-
- [ ] Angular service for translation management
|
|
151
|
-
- [ ] Angular CLI schematics
|
|
152
|
-
- [ ] Ivy renderer optimization
|
|
153
|
-
- [ ] Angular Universal SSR support
|
|
154
|
-
|
|
155
|
-
## 🎯 Long-Term Vision (v2.0.0+)
|
|
156
|
-
|
|
157
|
-
### 🏢 Enterprise Features
|
|
158
|
-
**Priority:** LOW | **Target:** v2.0.0
|
|
159
|
-
|
|
160
|
-
- [ ] **Team Collaboration**
|
|
161
|
-
- [ ] Multi-user translation workflows
|
|
162
|
-
- [ ] Translation approval processes
|
|
163
|
-
- [ ] Conflict resolution for concurrent edits
|
|
164
|
-
- [ ] Role-based access control
|
|
165
|
-
|
|
166
|
-
- [ ] **Cloud Integration**
|
|
167
|
-
- [ ] Cloud-based translation storage
|
|
168
|
-
- [ ] Real-time synchronization across teams
|
|
169
|
-
- [ ] Translation memory and suggestions
|
|
170
|
-
- [ ] Professional translator integration
|
|
171
|
-
|
|
172
|
-
### 🤖 AI-Powered Features
|
|
173
|
-
**Priority:** LOW | **Target:** v2.1.0
|
|
174
|
-
|
|
175
|
-
- [ ] **Intelligent Translation Assistance**
|
|
176
|
-
- [ ] AI-powered translation suggestions
|
|
177
|
-
- [ ] Context-aware translation recommendations
|
|
178
|
-
- [ ] Automatic translation quality scoring
|
|
179
|
-
- [ ] Smart missing translation detection
|
|
180
|
-
|
|
181
|
-
- [ ] **Automated Optimization**
|
|
182
|
-
- [ ] Automatic code refactoring for i18n
|
|
183
|
-
- [ ] Smart key naming suggestions
|
|
184
|
-
- [ ] Performance optimization recommendations
|
|
185
|
-
- [ ] Automated testing for translation coverage
|
|
186
|
-
|
|
187
|
-
### 🌍 Global Expansion
|
|
188
|
-
**Priority:** LOW | **Target:** v2.2.0
|
|
189
|
-
|
|
190
|
-
- [ ] **Additional Language Support**
|
|
191
|
-
- [ ] Arabic (RTL support)
|
|
192
|
-
- [ ] Hindi
|
|
193
|
-
- [ ] Portuguese
|
|
194
|
-
- [ ] Korean
|
|
195
|
-
- [ ] Thai
|
|
196
|
-
- [ ] Hebrew (RTL support)
|
|
197
|
-
|
|
198
|
-
- [ ] **Cultural Adaptation**
|
|
199
|
-
- [ ] Date/time format localization
|
|
200
|
-
- [ ] Number format localization
|
|
201
|
-
- [ ] Currency format support
|
|
202
|
-
- [ ] Cultural color and symbol preferences
|
|
203
|
-
|
|
204
|
-
## 🔧 Technical Debt & Maintenance
|
|
205
|
-
|
|
206
|
-
### 📋 Ongoing Tasks
|
|
207
|
-
- [ ] **Code Quality**
|
|
208
|
-
- [ ] Increase test coverage to 95%+
|
|
209
|
-
- [ ] Implement comprehensive error handling
|
|
210
|
-
- [ ] Add TypeScript definitions
|
|
211
|
-
- [ ] Performance optimization for large projects
|
|
212
|
-
|
|
213
|
-
- [ ] **Documentation**
|
|
214
|
-
- [ ] Video tutorials for common workflows
|
|
215
|
-
- [ ] Interactive documentation with examples
|
|
216
|
-
- [ ] Migration guides for major versions
|
|
217
|
-
- [ ] Best practices documentation
|
|
218
|
-
|
|
219
|
-
- [ ] **Community**
|
|
220
|
-
- [ ] Contribution guidelines
|
|
221
|
-
- [ ] Code of conduct
|
|
222
|
-
- [ ] Issue templates
|
|
223
|
-
- [ ] Pull request templates
|
|
224
|
-
|
|
225
|
-
### 🐛 Known Issues to Address
|
|
226
|
-
- [ ] **Minor Translation Gaps**
|
|
227
|
-
- [ ] 30 non-critical missing translation keys
|
|
228
|
-
- [ ] Inconsistent terminology in some languages
|
|
229
|
-
- [ ] Missing context for some translation keys
|
|
230
|
-
|
|
231
|
-
- [ ] **Performance Optimizations**
|
|
232
|
-
- [ ] Large file processing optimization
|
|
233
|
-
- [ ] Memory usage reduction for big projects
|
|
234
|
-
- [ ] Faster translation key lookup
|
|
235
|
-
|
|
236
|
-
## 📊 Success Metrics
|
|
237
|
-
|
|
238
|
-
### 📈 Version 1.6.x Goals
|
|
239
|
-
- [ ] **Translation Coverage:** 100% of console output internationalized
|
|
240
|
-
- [ ] **Test Coverage:** Maintain 100% test pass rate
|
|
241
|
-
- [ ] **Documentation:** Complete API documentation
|
|
242
|
-
- [ ] **Community:** 50+ GitHub stars, 10+ contributors
|
|
243
|
-
|
|
244
|
-
### 📈 Version 1.7.x Goals
|
|
245
|
-
- [ ] **Performance:** 50% faster processing for large projects
|
|
246
|
-
- [ ] **Features:** UI locales refactoring completed
|
|
247
|
-
- [ ] **Adoption:** 100+ npm downloads per week
|
|
248
|
-
- [ ] **Quality:** Zero critical bugs reported
|
|
249
|
-
|
|
250
|
-
### 📈 Version 2.0.x Goals
|
|
251
|
-
- [ ] **Enterprise Ready:** Full team collaboration features
|
|
252
|
-
- [ ] **Market Position:** Top 3 i18n tools on npm
|
|
253
|
-
- [ ] **Community:** 500+ GitHub stars, 50+ contributors
|
|
254
|
-
- [ ] **Integration:** Official framework partnerships
|
|
255
|
-
|
|
256
|
-
## 🤝 Contributing Guidelines
|
|
257
|
-
|
|
258
|
-
### 🎯 How to Contribute
|
|
259
|
-
1. **Pick a Task:** Choose from the TODO items above
|
|
260
|
-
2. **Create Issue:** Discuss the implementation approach
|
|
261
|
-
3. **Fork & Branch:** Create a feature branch
|
|
262
|
-
4. **Implement:** Follow coding standards and add tests
|
|
263
|
-
5. **Test:** Ensure all tests pass
|
|
264
|
-
6. **Document:** Update relevant documentation
|
|
265
|
-
7. **Pull Request:** Submit for review
|
|
266
|
-
|
|
267
|
-
### 📋 Priority Labels
|
|
268
|
-
- **🔥 Critical:** Security issues, major bugs
|
|
269
|
-
- **⚡ High:** Core functionality, user experience
|
|
270
|
-
- **📋 Medium:** New features, improvements
|
|
271
|
-
- **🔧 Low:** Nice-to-have, future enhancements
|
|
272
|
-
|
|
273
|
-
---
|
|
274
|
-
|
|
275
|
-
**This roadmap is a living document and will be updated regularly based on community feedback, user needs, and project evolution.**
|
|
276
|
-
|
|
277
|
-
**Last Updated:** July 28, 2025
|
|
278
|
-
**Next Review:** August 15, 2025
|
|
279
|
-
**Maintainer:** Vladimir Noskov
|
|
@@ -1,67 +0,0 @@
|
|
|
1
|
-
# Translation Status - v1.1.4
|
|
2
|
-
|
|
3
|
-
## 🌍 Current Status: # Translation Status - v1.1.5
|
|
4
|
-
|
|
5
|
-
**i18ntk v1.1.5** is **production-ready** with complete documentation updates and npm metadata cleanup. All previous versions are deprecated - please upgrade immediately.
|
|
6
|
-
|
|
7
|
-
## ✅ Completed
|
|
8
|
-
|
|
9
|
-
### Core Functionality
|
|
10
|
-
- ✅ All core features work without issues
|
|
11
|
-
- ✅ JSON parsing errors fixed
|
|
12
|
-
- ✅ Debug tools operational
|
|
13
|
-
- ✅ File path issues resolved
|
|
14
|
-
- ✅ SecurityUtils configuration validation fixed
|
|
15
|
-
|
|
16
|
-
### Translation Infrastructure
|
|
17
|
-
- ✅ All missing translation keys added to English locale files
|
|
18
|
-
- ✅ Translation system architecture complete
|
|
19
|
-
- ✅ English fallback mechanism implemented
|
|
20
|
-
- ✅ Multi-language support framework established
|
|
21
|
-
|
|
22
|
-
### Language Files Status
|
|
23
|
-
- ✅ **English (en)**: 100% complete - all keys present
|
|
24
|
-
- ✅ **Chinese (zh)**: Partial completion - core UI elements translated
|
|
25
|
-
- ✅ **German (de)**: Framework ready, uses English fallback
|
|
26
|
-
- ✅ **Spanish (es)**: Framework ready, uses English fallback
|
|
27
|
-
- ✅ **French (fr)**: Framework ready, uses English fallback
|
|
28
|
-
- ✅ **Japanese (ja)**: Framework ready, uses English fallback
|
|
29
|
-
|
|
30
|
-
## 🔄 In Progress
|
|
31
|
-
|
|
32
|
-
### Translation Completion
|
|
33
|
-
- 🔄 **Chinese**: Additional UI text translation ongoing
|
|
34
|
-
- 🔄 **All other languages**: Awaiting full translation from community contributions
|
|
35
|
-
|
|
36
|
-
### Remaining Tasks
|
|
37
|
-
- 🔄 Complete translation of UI locale strings for non-English languages
|
|
38
|
-
- 🔄 Review and refine existing translations for consistency
|
|
39
|
-
- 🔄 Add language-specific formatting rules where needed
|
|
40
|
-
|
|
41
|
-
## 📊 Translation Coverage
|
|
42
|
-
|
|
43
|
-
| Language | Core Functionality | UI Text | Overall Status |
|
|
44
|
-
|----------|-------------------|----------|----------------|
|
|
45
|
-
| English | 100% | 100% | ✅ Complete |
|
|
46
|
-
| Chinese | 100% | ~75% | 🔄 In Progress |
|
|
47
|
-
| German | 100% | 0% | 🔄 Pending |
|
|
48
|
-
| Spanish | 100% | 0% | 🔄 Pending |
|
|
49
|
-
| French | 100% | 0% | 🔄 Pending |
|
|
50
|
-
| Japanese | 100% | 0% | 🔄 Pending |
|
|
51
|
-
|
|
52
|
-
## 🚀 Impact on Usage
|
|
53
|
-
|
|
54
|
-
**Zero Impact**: All core functionality works perfectly regardless of translation completion status. English fallback ensures seamless operation while translations are being completed.
|
|
55
|
-
|
|
56
|
-
## 🤝 Contributing
|
|
57
|
-
|
|
58
|
-
Community contributions for translations are welcome! The framework is ready - only the actual translation strings need completion.
|
|
59
|
-
|
|
60
|
-
## 📅 Timeline
|
|
61
|
-
|
|
62
|
-
- **v1.1.5**: Production-ready release with documentation and metadata cleanup
|
|
63
|
-
- **v1.1.5**: Target for complete translation completion across all supported languages
|
|
64
|
-
|
|
65
|
-
---
|
|
66
|
-
|
|
67
|
-
*Last updated: 02/08/2025 - i18ntk v1.1.5 Release*
|
|
@@ -1,258 +0,0 @@
|
|
|
1
|
-
# i18ntk API Reference
|
|
2
|
-
|
|
3
|
-
**Version:** 1.4.0 (04/08/2025)
|
|
4
|
-
|
|
5
|
-
## Overview
|
|
6
|
-
|
|
7
|
-
Complete API documentation for i18ntk - the comprehensive internationalization toolkit for JavaScript/TypeScript projects.
|
|
8
|
-
|
|
9
|
-
## CLI Commands
|
|
10
|
-
|
|
11
|
-
### Core Commands
|
|
12
|
-
|
|
13
|
-
#### `i18ntk` or `npx i18ntk`
|
|
14
|
-
Interactive management menu
|
|
15
|
-
```bash
|
|
16
|
-
npx i18ntk
|
|
17
|
-
```
|
|
18
|
-
|
|
19
|
-
#### `i18ntk init`
|
|
20
|
-
Initialize i18n structure
|
|
21
|
-
```bash
|
|
22
|
-
npx i18ntk init --source-dir ./src --locales-dir ./locales --languages en,es,fr
|
|
23
|
-
```
|
|
24
|
-
|
|
25
|
-
**Options:**
|
|
26
|
-
- `--source-dir <path>` - Source directory (default: ./src)
|
|
27
|
-
- `--locales-dir <path>` - Locales directory (default: ./locales)
|
|
28
|
-
- `--languages <codes>` - Comma-separated language codes
|
|
29
|
-
- `--framework <name>` - Framework type (react-i18next, vue-i18n, i18next)
|
|
30
|
-
- `--no-prompt` - Skip interactive prompts (CI/CD mode)
|
|
31
|
-
|
|
32
|
-
#### `i18ntk analyze`
|
|
33
|
-
Analyze translation completeness
|
|
34
|
-
```bash
|
|
35
|
-
npx i18ntk analyze --detailed --output json
|
|
36
|
-
```
|
|
37
|
-
|
|
38
|
-
**Options:**
|
|
39
|
-
- `--detailed` - Show detailed analysis
|
|
40
|
-
- `--output <format>` - Output format (json, csv, html)
|
|
41
|
-
- `--threshold <number>` - Completion threshold percentage
|
|
42
|
-
- `--no-prompt` - Skip interactive prompts (CI/CD mode)
|
|
43
|
-
|
|
44
|
-
#### `i18ntk validate`
|
|
45
|
-
Validate translation files
|
|
46
|
-
```bash
|
|
47
|
-
npx i18ntk validate --strict --fix
|
|
48
|
-
```
|
|
49
|
-
|
|
50
|
-
**Options:**
|
|
51
|
-
- `--strict` - Enable strict validation
|
|
52
|
-
- `--fix` - Auto-fix common issues
|
|
53
|
-
- `--format <type>` - Validation format (json, yaml)
|
|
54
|
-
- `--no-prompt` - Skip interactive prompts (CI/CD mode)
|
|
55
|
-
|
|
56
|
-
#### `i18ntk usage`
|
|
57
|
-
Check translation key usage
|
|
58
|
-
```bash
|
|
59
|
-
npx i18ntk usage --unused --missing
|
|
60
|
-
```
|
|
61
|
-
|
|
62
|
-
**Options:**
|
|
63
|
-
- `--unused` - Show only unused keys
|
|
64
|
-
- `--missing` - Show only missing keys
|
|
65
|
-
- `--source-dir <path>` - Source directory to scan
|
|
66
|
-
- `--no-prompt` - Skip interactive prompts (CI/CD mode)
|
|
67
|
-
|
|
68
|
-
#### `i18ntk complete`
|
|
69
|
-
Complete missing translations
|
|
70
|
-
```bash
|
|
71
|
-
npx i18ntk complete --auto --language es --provider google
|
|
72
|
-
```
|
|
73
|
-
|
|
74
|
-
**Options:**
|
|
75
|
-
- `--auto` - Use automatic translation
|
|
76
|
-
- `--language <code>` - Target specific language
|
|
77
|
-
- `--provider <name>` - Translation provider (google, deepl, openai)
|
|
78
|
-
- `--no-prompt` - Skip interactive prompts (CI/CD mode)
|
|
79
|
-
|
|
80
|
-
#### `i18ntk sizing`
|
|
81
|
-
Analyze file sizes and performance
|
|
82
|
-
```bash
|
|
83
|
-
npx i18ntk sizing --detailed --format json
|
|
84
|
-
```
|
|
85
|
-
|
|
86
|
-
**Options:**
|
|
87
|
-
- `--detailed` - Show detailed sizing analysis
|
|
88
|
-
- `--format <type>` - Output format (json, table)
|
|
89
|
-
- `--threshold <size>` - Size threshold in bytes
|
|
90
|
-
- `--no-prompt` - Skip interactive prompts (CI/CD mode)
|
|
91
|
-
|
|
92
|
-
#### `i18ntk summary`
|
|
93
|
-
Generate comprehensive reports
|
|
94
|
-
```bash
|
|
95
|
-
npx i18ntk summary --format html --include analysis,validation
|
|
96
|
-
```
|
|
97
|
-
|
|
98
|
-
**Options:**
|
|
99
|
-
- `--format <type>` - Report format (html, pdf, json)
|
|
100
|
-
- `--include <sections>` - Comma-separated sections
|
|
101
|
-
- `--no-prompt` - Skip interactive prompts (CI/CD mode)
|
|
102
|
-
|
|
103
|
-
#### `i18ntk autorun`
|
|
104
|
-
Run complete workflow automation
|
|
105
|
-
```bash
|
|
106
|
-
npx i18ntk autorun --config custom-config.json --skip sizing
|
|
107
|
-
```
|
|
108
|
-
|
|
109
|
-
**Options:**
|
|
110
|
-
- `--config <path>` - Configuration file path
|
|
111
|
-
- `--skip <steps>` - Comma-separated steps to skip
|
|
112
|
-
- `--no-prompt` - Skip interactive prompts (CI/CD mode)
|
|
113
|
-
|
|
114
|
-
### Debug Commands
|
|
115
|
-
|
|
116
|
-
#### `i18ntk debug`
|
|
117
|
-
Run diagnostics
|
|
118
|
-
```bash
|
|
119
|
-
npx i18ntk debug --verbose
|
|
120
|
-
```
|
|
121
|
-
|
|
122
|
-
#### `i18ntk settings`
|
|
123
|
-
Manage configuration
|
|
124
|
-
```bash
|
|
125
|
-
npx i18ntk settings --reset --export settings.json
|
|
126
|
-
```
|
|
127
|
-
|
|
128
|
-
## Configuration
|
|
129
|
-
|
|
130
|
-
### i18ntk-config.json
|
|
131
|
-
|
|
132
|
-
```json
|
|
133
|
-
{
|
|
134
|
-
"defaultLanguage": "en",
|
|
135
|
-
"supportedLanguages": ["en", "es", "fr", "de", "pt", "ja", "ru", "zh"],
|
|
136
|
-
"sourceDirectory": "./src",
|
|
137
|
-
"localesDirectory": "./locales",
|
|
138
|
-
"framework": "react-i18next",
|
|
139
|
-
"autoTranslate": false,
|
|
140
|
-
"translationProvider": "google",
|
|
141
|
-
"validationStrict": true,
|
|
142
|
-
"reportFormat": "html"
|
|
143
|
-
}
|
|
144
|
-
```
|
|
145
|
-
|
|
146
|
-
### Environment Variables
|
|
147
|
-
|
|
148
|
-
| Variable | Description | Default |
|
|
149
|
-
|----------|-------------|---------|
|
|
150
|
-
| `I18N_SOURCE_DIR` | Source directory | `./src` |
|
|
151
|
-
| `I18N_LOCALES_DIR` | Locales directory | `./locales` |
|
|
152
|
-
| `I18N_DEFAULT_LANG` | Default language | `en` |
|
|
153
|
-
| `I18N_FRAMEWORK` | Framework type | `react-i18next` |
|
|
154
|
-
| `I18N_AUTO_TRANSLATE` | Enable auto-translation | `false` |
|
|
155
|
-
| `GOOGLE_TRANSLATE_API_KEY` | Google API key | - |
|
|
156
|
-
| `DEEPL_API_KEY` | DeepL API key | - |
|
|
157
|
-
| `OPENAI_API_KEY` | OpenAI API key | - |
|
|
158
|
-
|
|
159
|
-
## Programmatic API
|
|
160
|
-
|
|
161
|
-
### Basic Usage
|
|
162
|
-
|
|
163
|
-
```javascript
|
|
164
|
-
const { I18nManager } = require('i18n-management-toolkit');
|
|
165
|
-
|
|
166
|
-
const manager = new I18nManager({
|
|
167
|
-
sourceDir: './src',
|
|
168
|
-
localesDir: './locales',
|
|
169
|
-
defaultLanguage: 'en'
|
|
170
|
-
});
|
|
171
|
-
|
|
172
|
-
// Initialize project
|
|
173
|
-
await manager.initialize();
|
|
174
|
-
|
|
175
|
-
// Analyze translations
|
|
176
|
-
const analysis = await manager.analyze();
|
|
177
|
-
|
|
178
|
-
// Validate translations
|
|
179
|
-
const validation = await manager.validate();
|
|
180
|
-
|
|
181
|
-
// Complete missing translations
|
|
182
|
-
await manager.completeMissingTranslations();
|
|
183
|
-
```
|
|
184
|
-
|
|
185
|
-
### Advanced Usage
|
|
186
|
-
|
|
187
|
-
```javascript
|
|
188
|
-
const { I18nAnalyzer, I18nValidator } = require('i18n-management-toolkit');
|
|
189
|
-
|
|
190
|
-
// Analyze specific languages
|
|
191
|
-
const analyzer = new I18nAnalyzer(config);
|
|
192
|
-
const report = await analyzer.analyzeLanguages(['es', 'fr']);
|
|
193
|
-
|
|
194
|
-
// Validate with custom rules
|
|
195
|
-
const validator = new I18nValidator(config);
|
|
196
|
-
const results = await validator.validateFiles({
|
|
197
|
-
strict: true,
|
|
198
|
-
autoFix: true
|
|
199
|
-
});
|
|
200
|
-
```
|
|
201
|
-
|
|
202
|
-
## Framework Integration
|
|
203
|
-
|
|
204
|
-
### React i18next
|
|
205
|
-
```bash
|
|
206
|
-
npx i18ntk init --framework react-i18next
|
|
207
|
-
```
|
|
208
|
-
|
|
209
|
-
### Vue i18n
|
|
210
|
-
```bash
|
|
211
|
-
npx i18ntk init --framework vue-i18n
|
|
212
|
-
```
|
|
213
|
-
|
|
214
|
-
### Angular i18n
|
|
215
|
-
```bash
|
|
216
|
-
npx i18ntk init --framework angular
|
|
217
|
-
```
|
|
218
|
-
|
|
219
|
-
### Next.js
|
|
220
|
-
```bash
|
|
221
|
-
npx i18ntk init --framework next-i18next
|
|
222
|
-
```
|
|
223
|
-
|
|
224
|
-
## Reports
|
|
225
|
-
|
|
226
|
-
Generated in `i18ntk-reports/`:
|
|
227
|
-
- `analysis-report.html` - Translation completeness
|
|
228
|
-
- `validation-report.html` - File integrity
|
|
229
|
-
- `usage-report.html` - Key utilization
|
|
230
|
-
- `sizing-report.html` - Performance metrics
|
|
231
|
-
- `summary-report.html` - Project overview
|
|
232
|
-
|
|
233
|
-
## Security Features
|
|
234
|
-
|
|
235
|
-
### PIN Protection
|
|
236
|
-
- Script-level authentication with AES-256 encryption
|
|
237
|
-
- 30-minute session timeout
|
|
238
|
-
- Lockout protection after failed attempts
|
|
239
|
-
- Complete audit logging
|
|
240
|
-
|
|
241
|
-
### Configuration Security
|
|
242
|
-
- Encrypted storage of sensitive data
|
|
243
|
-
- Environment variable support for API keys
|
|
244
|
-
- No hardcoded credentials
|
|
245
|
-
- Secure backup retention
|
|
246
|
-
|
|
247
|
-
## Language Support
|
|
248
|
-
|
|
249
|
-
- English (en)
|
|
250
|
-
- German (de)
|
|
251
|
-
- Spanish (es)
|
|
252
|
-
- French (fr)
|
|
253
|
-
- Portuguese (pt)
|
|
254
|
-
- Japanese (ja)
|
|
255
|
-
- Russian (ru)
|
|
256
|
-
- Chinese (zh)
|
|
257
|
-
|
|
258
|
-
All languages maintain 100% translation coverage.
|