i18ntk 1.1.4 → 1.2.0

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 CHANGED
@@ -2,10 +2,67 @@
2
2
 
3
3
  All notable changes to the I18N Management Toolkit are documented here. This project follows [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) and [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
4
4
 
5
- **Current Version:** 1.1.4 (2025-08-01) - **INTERNATIONALIZATION COMPLETION RELEASE** 🌍
5
+ **Current Version:** 1.2.0 (2025-08-02) - **UI SIMPLIFICATION & ORGANIZATION RELEASE** 🧹
6
+
7
+ ## [1.2.0] - 2025-08-02
8
+
9
+ ### 🧹 Code Cleanup & Simplification
10
+ - **Removed**: UI language switching option (option 10) from main menu to focus on English core functionality
11
+ - **Updated**: Menu numbering adjusted to reflect removal of option 10 (Settings now option 10, Help option 11, Debug option 12)
12
+ - **Simplified**: User interface now defaults to English only for improved stability
13
+ - **Enhanced**: Project organization with centralized reports in `i18ntk-reports/` directory
14
+ - **Enhanced**: Configuration files now organized in `settings/` directory
15
+
16
+ ### 🌐 Translation Updates
17
+ - **Added**: "Coming Soon" messages to German, Spanish, French, Russian, Japanese, and Chinese locale files for language switching feature
18
+ - **Status**: All non-English locales updated to indicate language switching will be available in next update
19
+ - **Focus**: English-only interface for v1.2.0 to ensure core functionality stability
20
+
21
+ ### 📊 Project Organization
22
+ - **Centralized**: All reports now saved to `i18ntk-reports/` directory for better file management
23
+ - **Organized**: Configuration files moved to `settings/` directory for cleaner project structure
24
+ - **Cleaned**: Removed duplicate configuration files and streamlined project layout
25
+
26
+ ### 🔄 Version Updates
27
+ - **Bumped**: Package version to 1.2.0 with breaking change notice for menu option removal
28
+ - **Updated**: All documentation to reflect new project organization and version changes
29
+ - **Enhanced**: Version info with new features and breaking changes documentation
30
+
31
+ ### 🛡️ Stability Improvements
32
+ - **Fixed**: Menu option handling after removal of language switching
33
+ - **Enhanced**: Non-interactive mode menu display updated to match new numbering
34
+ - **Improved**: Overall system stability by reducing complexity
35
+
36
+ ## [1.1.5] - 2025-08-02
37
+
38
+ ### 🧹 Documentation & Metadata Enhancement
39
+ - **Enhanced**: Updated all documentation files to reflect v1.1.5 standards
40
+ - **Improved**: Cleaned up npm package metadata and repository links
41
+ - **Fixed**: Repository URLs pointing to correct GitHub location
42
+ - **Updated**: Installation instructions and version references throughout documentation
43
+ - **Standardized**: All version strings now consistently reference v1.1.5
44
+
45
+ ### 🐛 Previous Version Deprecation
46
+ - **Critical**: All versions < 1.1.5 are now deprecated due to critical bugs and functional issues
47
+ - **Migration**: Zero-breaking-changes upgrade path from any 1.x version
48
+ - **Recommendation**: Immediate upgrade to v1.1.5 for stable functionality
49
+ - **Support**: No further updates or fixes will be provided for deprecated versions
50
+
51
+ ### 🎉 Community Appreciation
52
+ - **Milestone**: 200+ downloads achieved in the first week
53
+ - **Gratitude**: Thank you to the community for patience during bug resolution
54
+ - **Commitment**: Continued focus on stability and user experience improvements
55
+
56
+ ### 📋 Package Metadata Updates
57
+ - **Fixed**: Homepage URL updated to `https://github.com/vladnoskv/i18n-management-toolkit-main`
58
+ - **Fixed**: Repository URL updated to `git+https://github.com/vladnoskv/i18n-management-toolkit-main.git`
59
+ - **Enhanced**: Keywords and description refined for better discoverability
60
+ - **Updated**: All internal version references to 1.1.5
6
61
 
7
62
  ## [1.1.4] - 2025-08-01
8
63
 
64
+ **⚠️ DEPRECATED:** This version is deprecated. Please upgrade to v1.2.0 for critical bug fixes and stability improvements.
65
+
9
66
  ### 🌍 Core Plugin Functionality - **COMPLETE**
10
67
  - **Achieved**: All core functionality now works without issues
11
68
  - **Fixed**: JSON parsing errors in analysis reports ("Failed to parse source file JSON")
@@ -39,6 +96,8 @@ All notable changes to the I18N Management Toolkit are documented here. This pro
39
96
 
40
97
  ## [1.1.3] - 2025-07-29
41
98
 
99
+ **⚠️ DEPRECATED:** This version is deprecated. Please upgrade to v1.2.0 for critical bug fixes and stability improvements.
100
+
42
101
  ### 🌐 Translation System Enhancement
43
102
  - **Added**: Translation keys for workflow step names in `autorun.json` files across all supported languages
44
103
  - **Improved**: Replaced hardcoded step names in `i18ntk-autorun.js` with internationalized translation keys
@@ -56,6 +115,8 @@ All notable changes to the I18N Management Toolkit are documented here. This pro
56
115
 
57
116
  ## [1.1.2] - 2025-07-27
58
117
 
118
+ **⚠️ DEPRECATED:** This version is deprecated. Please upgrade to v1.2.0 for critical bug fixes and stability improvements.
119
+
59
120
  ### 🚀 Enhanced CLI Experience
60
121
  - **Improved**: Enabled direct execution of commands (e.g., `i18ntk usage`, `i18ntk workflow`) from the command line, bypassing the interactive menu for specified commands.
61
122
 
@@ -69,6 +130,8 @@ All notable changes to the I18N Management Toolkit are documented here. This pro
69
130
 
70
131
  ## [1.1.1] - 2025-07-27
71
132
 
133
+ **⚠️ DEPRECATED:** This version is deprecated. Please upgrade to v1.1.5 for critical bug fixes and stability improvements.
134
+
72
135
  ### 🐛 Bug Fixes & Improvements
73
136
  - **Fixed**: Interactive menu 'Help' option (option 12) now correctly waits for user input before returning to the main menu.
74
137
  - **Improved**: `executeCommand` function now properly handles the 'help' command within the interactive menu, ensuring a smooth user experience.
@@ -80,6 +143,8 @@ All notable changes to the I18N Management Toolkit are documented here. This pro
80
143
 
81
144
  ## [1.1.0] - 2025-07-27
82
145
 
146
+ **⚠️ DEPRECATED:** This version is deprecated. Please upgrade to v1.1.5 for critical bug fixes and stability improvements.
147
+
83
148
  ### 🚀 Enhanced CLI Experience
84
149
  - **Fixed**: `i18ntk --version` and `i18ntk -v` now properly display version information instead of loading the management menu
85
150
  - **Enhanced**: Version command shows comprehensive information including toolkit name, version, release date, maintainer, Node.js compatibility, license, and recent changes
@@ -121,6 +186,8 @@ All notable changes to the I18N Management Toolkit are documented here. This pro
121
186
 
122
187
  ## [1.0.5] - 2025-07-27
123
188
 
189
+ **⚠️ DEPRECATED:** This version is deprecated. Please upgrade to v1.1.5 for critical bug fixes and stability improvements.
190
+
124
191
  ### 🧹 System Cleanup and Organization
125
192
  - **Cleaned**: Removed test-specific translation files (validationStep.json, reportGenerator.json) from user locale directories
126
193
  - **Fixed**: Removed hardcoded validationStep and reportGenerator keys from i18ntk-complete.js
@@ -148,6 +215,8 @@ All notable changes to the I18N Management Toolkit are documented here. This pro
148
215
 
149
216
  ## [1.0.4] - 2025-07-27
150
217
 
218
+ **⚠️ DEPRECATED:** This version is deprecated. Please upgrade to v1.1.5 for critical bug fixes and stability improvements.
219
+
151
220
  ### 🔧 Critical Translation System Fixes
152
221
  - **Fixed**: Translation system initialization issues causing "Translation not found" errors
153
222
  - **Fixed**: Dynamic value replacement in validation summary ({{langs}}, {{lang}}, {count}, {{percentage}})
@@ -172,6 +241,8 @@ All notable changes to the I18N Management Toolkit are documented here. This pro
172
241
 
173
242
  ## [1.0.3] - 2025-07-27
174
243
 
244
+ **⚠️ DEPRECATED:** This version is deprecated. Please upgrade to v1.1.5 for critical bug fixes and stability improvements.
245
+
175
246
  ### 🔧 Patch Release
176
247
  - **Fixed**: CLI `--help` command hanging issue - now properly exits after displaying help
177
248
  - **Updated**: README.md to be more accurate, concise, and informative
@@ -180,6 +251,8 @@ All notable changes to the I18N Management Toolkit are documented here. This pro
180
251
 
181
252
  ## [1.0.2] - 2025-07-27
182
253
 
254
+ **⚠️ DEPRECATED:** This version is deprecated. Please upgrade to v1.1.5 for critical bug fixes and stability improvements.
255
+
183
256
  ### 🔧 Patch Release
184
257
  - **Fixed**: Added missing `settings/` directory to package files
185
258
  - **Fixed**: Resolved "Cannot find module '../settings/settings-manager'" error
@@ -188,6 +261,8 @@ All notable changes to the I18N Management Toolkit are documented here. This pro
188
261
 
189
262
  ## [1.0.1] - 2025-07-27
190
263
 
264
+ **⚠️ DEPRECATED:** This version is deprecated. Please upgrade to v1.1.5 for critical bug fixes and stability improvements.
265
+
191
266
  ### 🔧 Patch Release
192
267
  - **Fixed**: Added main `i18ntk` command to bin configuration for easier CLI access
193
268
  - **Improved**: Users can now run `i18ntk --version` and `i18ntk --help` directly
@@ -195,6 +270,8 @@ All notable changes to the I18N Management Toolkit are documented here. This pro
195
270
 
196
271
  ## [1.0.0] - 2025-07-27 - 🎉 FIRST STABLE RELEASE
197
272
 
273
+ **⚠️ DEPRECATED:** This version is deprecated. Please upgrade to v1.1.5 for critical bug fixes and stability improvements.
274
+
198
275
  ### 🚀 Welcome to i18ntk v1.0.0!
199
276
 
200
277
  After extensive development and testing, we're proud to announce the first stable release of **i18ntk** - the comprehensive, enterprise-grade internationalization management toolkit for JavaScript/TypeScript projects.
package/README.md CHANGED
@@ -1,14 +1,29 @@
1
1
  # i18ntk - Enterprise i18n Management Toolkit
2
2
 
3
- **Version:** 1.1.4 – **PRODUCTION READY** with complete core functionality and enhanced internationalization! 🌍
3
+ **Version:** 1.2 – **PRODUCTION READY** with enhanced documentation and npm metadata cleanup! 🌍
4
4
 
5
- **Important Note on Versions:** We strongly recommend using the latest stable version (currently 1.1.4) of i18ntk. This version represents full production readiness with all core features working flawlessly. Internationalization completion is the only remaining task. Older versions may contain known bugs that have been resolved in v1.1.4.
5
+ **⚠️ Important Notice:** All previous versions (< 1.2) are now deprecated due to critical bugs and issues. Please upgrade to v1.1.5 for the most stable experience. We recommend backing up your project before upgrading.
6
6
 
7
- [![1.1.0](https://badge.fury.io/js/i18ntk.svg)](https://badge.fury.io/js/i18ntk)
7
+ **🎉 Thank You:** 200+ downloads in the first week! Thank you for your support and patience as we resolved the functional issues. My First Published Project.
8
+
9
+ [![version](https://badge.fury.io/js/i18ntk.svg)](https://badge.fury.io/js/i18ntk)
10
+ [![npm](https://img.shields.io/npm/dt/i18ntk.svg)](https://www.npmjs.com/package/i18ntk)
8
11
  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
9
12
  [![Node.js Version](https://img.shields.io/badge/node-%3E%3D16.0.0-brightgreen.svg)](https://nodejs.org/)
10
13
 
11
- **i18ntk** (i18n Toolkit) is a comprehensive, enterprise-grade internationalization management toolkit for JavaScript/TypeScript projects. It provides a complete CLI suite with multi-language support and advanced analysis capabilities for managing translations efficiently.
14
+ **i18ntk** (i18n Toolkit) is a comprehensive, internationalization management toolkit for JavaScript/TypeScript projects. It provides a complete CLI suite with multi-language support and advanced analysis capabilities for managing translations efficiently.
15
+
16
+ ## ⚠️ Important Disclaimer
17
+
18
+ **Important: This is an independent, community-driven toolkit** - not affiliated with any official i18n organization or team. Originally developed as a personal solution for translation management, i18ntk has evolved into a feature-rich internationalization toolkit available to the broader development community. The toolkit is designed to be framework-agnostic and highly adaptable:
19
+
20
+ - Works with any translation file format configured in the settings
21
+ - Operates independently (no i18n framework required)
22
+ - Provides extensive customization options
23
+ - Easily extensible through code modifications or AI-assisted configuration
24
+ - Flexible enough to accommodate diverse project requirements
25
+
26
+ While maintaining its independence, i18ntk strives to follow i18n best practices and standards to ensure compatibility with existing workflows. Although we test thoroughly, we cannot guarantee 100% compatibility with all i18n frameworks or systems. Users are encouraged to test i18ntk with their specific setup and adjust settings as needed or find an alternative solution.
12
27
 
13
28
  ## 🚀 Quick Start
14
29
 
@@ -68,83 +83,29 @@ npx i18ntk -v # 📋 Show detailed version information (short flag)
68
83
 
69
84
  **Important:** Direct command execution (e.g., `npx i18ntk usage`) now bypasses the interactive menu, allowing for more streamlined workflows and scripting.
70
85
 
71
- ## ✨ What's New in v1.1.4
72
-
73
- ### 🌍 **PRODUCTION READY** - Core Plugin Complete
74
- - **Achieved**: All core functionality now works without issues
75
- - **Fixed**: JSON parsing errors in analysis reports ("Failed to parse source file JSON")
76
- - **Fixed**: Debug tools "Unknown config key" warnings and errors
77
- - **Fixed**: File path issues in debug tools causing missing file errors
78
- - **Enhanced**: Translation system stability and reliability
79
-
80
- ### 🌐 Translation System Completion
81
- - **Added**: All missing translation keys to English locale files
82
- - **Improved**: Chinese translations for core UI elements (partial completion)
83
- - **Enhanced**: English fallback mechanism for incomplete translations
84
- - **Status**: Core functionality 100% translated, UI locales pending completion
85
-
86
- ### 🐛 Critical Bug Fixes
87
- - **Fixed**: SecurityUtils.validateConfig missing configuration keys
88
- - **Fixed**: Analysis tool failing to parse JSON files
89
- - **Fixed**: Debug tools unable to locate core files
90
- - **Fixed**: Export Missing Keys tool failing to load reference files
91
-
92
- ## What's New in v1.1.2
93
-
94
- ### 🚀 Enhanced CLI Experience
95
- - **Improved**: Enabled direct execution of commands (e.g., `i18ntk usage`, `i18ntk workflow`) from the command line, bypassing the interactive menu for specified commands.
96
-
97
- ### 🐛 Bug Fixes & Improvements
98
- - **Fixed**: Resolved "Missing required file/directory: ./settings/user-config.json" error by removing outdated global `i18ntk` installation, ensuring the local, up-to-date version is used.
99
-
100
- ## ✨ What's New in v1.1.1
101
-
102
- ### 🐛 Bug Fixes & Improvements
103
- - **Fixed**: Interactive menu 'Help' option (option 12) now correctly waits for user input before returning to the main menu.
104
- - **Improved**: `executeCommand` function now properly handles the 'help' command within the interactive menu, ensuring a smooth user experience.
105
- - **Fixed**: Resolved issue where internal JSON files (`auth.json`, `pagination.json`, `reportGenerator.json`, `validationStep.json`) were incorrectly included in locale processing. These files are now properly excluded via `settings-manager.js`.
106
-
107
- ### ✅ Validation Results
108
- - **Interactive Help**: Confirmed that the "Press Enter to return to menu." prompt is now correctly displayed and waits for user input after showing help.
109
- - **Locale File Exclusion**: Verified that specified internal JSON files are no longer processed as user locales, ensuring a cleaner and more accurate translation environment.
110
-
111
- ## ✨ What's New in v1.1.0
112
-
113
- ### 🚀 Enhanced CLI Experience
114
-
115
- #### 🔧 Major Improvements
116
- - **Fixed Version Command**: `i18ntk --version` and `i18ntk -v` now properly display version information instead of loading the management menu
117
- - **Detailed Version Info**: Version command shows comprehensive information including toolkit name, version, release date, maintainer, Node.js compatibility, license, and recent changes
118
- - **Improved Documentation**: Comprehensive README update with current standards and best practices
119
- - **Better CLI UX**: Enhanced command-line interface with proper argument handling
120
- - **Clean Output**: Version and help commands now execute cleanly without triggering other initialization processes
121
-
122
- #### 🔧 Critical Non-Interactive Mode Fixes
123
- - **Fixed Infinite Loop**: Resolved critical infinite loop issue when using piped input (e.g., `echo 0 | i18ntk-manage`)
124
- - **Enhanced Detection**: Added robust `isNonInteractiveMode()` method for reliable detection of non-interactive scenarios
125
- - **Graceful Exit**: Improved handling of non-interactive environments with proper user guidance
126
- - **Direct Command Support**: Fixed multiple menu display issues in direct command execution mode
127
- - **Automation Ready**: Better support for automated scripts and CI/CD pipelines
128
- - **Clean Execution**: Commands now execute without redundant menu displays or infinite loops
129
-
130
- #### 🎯 Documentation Excellence
131
- - **Updated Standards**: README follows current documentation standards and best practices
132
- - **Comprehensive Coverage**: All sections updated to reflect current functionality and features
133
- - **Better Organization**: Improved structure and navigation throughout documentation
134
- - **Version Consistency**: All version references updated to maintain consistency across the project
135
-
136
- #### 🛡️ Quality Improvements
137
- - **Proper CLI Behavior**: Commands now behave as expected without unintended side effects
138
- - **Enhanced Reliability**: Improved argument parsing and command execution flow
139
- - **Better User Experience**: Cleaner, more intuitive command-line interactions
140
- - **Production Ready**: Enhanced stability and professional CLI experience
141
- - **Automation Support**: Robust handling of various input scenarios including automated scripts and CI/CD environments
142
-
143
- ### 🧹 Previous Improvements (v1.0.5)
144
- - **System Cleanup**: Removed test-specific translation files and fixed hardcoded keys
145
- - **Better Organization**: Moved test reports to proper directories
146
- - **Production Safety**: Eliminated test artifacts from production deployments
147
- - **Enhanced Stability**: Improved file management and error handling
86
+ ## ✨ What's New in v1.1.5
87
+
88
+ ### 🧹 Documentation & Metadata Cleanup
89
+ - **Enhanced**: Updated all documentation to reflect current version and best practices
90
+ - **Improved**: Cleaned up npm package metadata for better clarity
91
+ - **Fixed**: Repository URLs and homepage links in package configuration
92
+ - **Updated**: Installation instructions and version references throughout documentation
93
+
94
+ ### 🐛 Previous Version Deprecation
95
+ - **Status**: All versions < 1.1.5 are now deprecated due to critical bugs
96
+ - **Recommendation**: Immediate upgrade to v1.1.5 for stable functionality
97
+ - **Migration**: Major-breaking-changes upgrading from any 1.0.x version. Uninstall, and reinstall and rerun initilization.
98
+
99
+ ### 📁 Enhanced Project Organization
100
+ - **Improved**: Configuration files now properly organized in `settings/` directory
101
+ - **Enhanced**: All reports centralized in `i18ntk-reports/` directory for better organization
102
+ - **Cleaned**: Removed duplicate configuration files from root directory
103
+ - **Updated**: Documentation reflects new file structure and locations
104
+
105
+ ### 🎉 Community Milestone
106
+ - **Achievement**: 200+ downloads in the first week
107
+ - **Gratitude**: Thank you for your patience as we resolved functional issues
108
+ - **Commitment**: Continued focus on stability and user experience
148
109
 
149
110
  ## 📚 Documentation
150
111
 
@@ -183,156 +144,6 @@ npx i18ntk -v # 📋 Show detailed version information (short flag)
183
144
  - **💾 Backup System**: Automatic configuration backups
184
145
  - **⚡ Reliability**: Advanced error handling and graceful degradation for non-interactive environments
185
146
 
186
- ## 📁 Project Structure
187
-
188
- ```
189
- i18n-management-toolkit/
190
- ├── main/ # Core i18ntk scripts
191
- │ ├── i18ntk-analyze.js # Translation analysis
192
- │ ├── i18ntk-autorun.js # Automated workflow execution
193
- │ ├── i18ntk-complete.js # Complete missing translations
194
- │ ├── i18ntk-init.js # Initialize i18n setup
195
- │ ├── i18ntk-manage.js # Main management interface
196
- │ ├── i18ntk-sizing.js # Generate sizing reports
197
- │ ├── i18ntk-summary.js # Generate summary reports
198
- │ ├── i18ntk-usage.js # Analyze translation usage
199
- │ ├── i18ntk-validate.js # Validate translations
200
- │ └── i18ntk-ui.js # UI internationalization
201
- ├── utils/ # Utility scripts and helpers
202
- │ ├── admin-auth.js # Admin authentication
203
- │ ├── admin-cli.js # Admin command-line interface
204
- │ ├── admin-pin.js # PIN management
205
- │ ├── i18n-helper.js # i18n utility functions
206
- │ ├── security.js # Security utilities
207
- │ ├── detect-language-mismatches.js # Language validation
208
- │ ├── maintain-language-purity.js # Language purity tools
209
- │ ├── native-translations.js # Native translation helpers
210
- │ ├── translate-mismatches.js # Translation mismatch tools
211
- │ ├── validate-language-purity.js # Language purity validation
212
- │ ├── test-complete-system.js # System testing
213
- │ └── test-console-i18n.js # Console i18n testing
214
- ├── dev/ # Development and debugging tools
215
- │ ├── debug/ # Debug utilities and analyzers
216
- │ │ ├── debugger.js # Main debugger
217
- │ │ ├── console-translations.js # Console translation tools
218
- │ │ ├── complete-console-translations.js # Console completion
219
- │ │ ├── console-key-checker.js # Console key validation
220
- │ │ ├── export-missing-keys.js # Missing key export
221
- │ │ ├── find-extra-keys.js # Extra key detection
222
- │ │ ├── normalize-locales.js # Locale normalization
223
- │ │ ├── refactor-locales.js # Locale refactoring
224
- │ │ ├── reorder-locales.js # Locale reordering
225
- │ │ └── replace-hardcoded-console.js # Console replacement
226
- │ └── tests/ # Test suite
227
- │ ├── test-complete-system.js # Complete system tests
228
- │ ├── test-console-i18n.js # Console i18n tests
229
- │ ├── test-features.js # Feature tests
230
- │ └── test-report.json # Test reports
231
- ├── docs/ # Comprehensive documentation
232
- │ ├── api/ # API documentation
233
- │ │ ├── API_REFERENCE.md # Complete API reference
234
- │ │ ├── COMPONENTS.md # Component documentation
235
- │ │ ├── CONFIGURATION.md # Configuration guide
236
- │ │ └── NPM_PUBLISHING_GUIDE.md # NPM publishing guide
237
- │ ├── debug/ # Debug documentation
238
- │ │ ├── DEBUG_README.md # Debug overview
239
- │ │ └── DEBUG_TOOLS.md # Debug tools guide
240
- │ ├── development/ # Development documentation
241
- │ │ ├── AGENTS.md # AI agent guidelines
242
- │ │ ├── DEVELOPMENT_RULES.md # Development rules
243
- │ │ └── DEV_README.md # Development overview
244
- │ ├── release-notes/ # Release documentation
245
- │ │ ├── RELEASE_NOTES_v1.6.0.md # v1.6.0 release notes
246
- │ │ ├── RELEASE_NOTES_v1.6.1.md # v1.6.1 release notes
247
- │ │ └── RELEASE_NOTES_v1.0.0.md # v1.0.0 release notes
248
- │ ├── reports/ # Report documentation
249
- │ │ ├── ANALYSIS_README.md # Analysis reports
250
- │ │ ├── SIZING_README.md # Sizing reports
251
- │ │ ├── SUMMARY_README.md # Summary reports
252
- │ │ ├── USAGE_README.md # Usage reports
253
- │ │ └── VALIDATION_README.md # Validation reports
254
- │ ├── INSTALLATION.md # Installation guide
255
- │ ├── README.md # Documentation overview
256
- │ └── TODO_ROADMAP.md # Future roadmap
257
- ├── scripts/ # Utility scripts
258
- │ ├── fix-missing-translation-keys.js # Translation key fixes
259
- │ └── verify-package.js # Package verification
260
- ├── settings/ # Configuration management
261
- │ ├── admin-config.json # Admin configuration
262
- │ ├── i18ntk-config.json # User configuration
263
- │ ├── settings-cli.js # Settings CLI
264
- │ ├── settings-manager.js # Settings management
265
- │ └── backups/ # Configuration backups
266
- ├── locales/ # Sample project translation files
267
- │ ├── en/ # English translations
268
- │ ├── de/ # German translations
269
- │ ├── es/ # Spanish translations
270
- │ ├── fr/ # French translations
271
- │ └── ru/ # Russian translations
272
- ├── ui-locales/ # Toolkit's UI translations (7 languages)
273
- │ ├── en.json # English UI
274
- │ ├── de.json # German UI
275
- │ ├── es.json # Spanish UI
276
- │ ├── fr.json # French UI
277
- │ ├── ja.json # Japanese UI
278
- │ ├── ru.json # Russian UI
279
- │ └── zh.json # Chinese UI
280
- ├── i18ntk-reports/ # Generated analysis reports
281
- │ ├── analysis/ # Translation analysis
282
- │ ├── validation/ # Validation reports
283
- │ ├── usage/ # Usage analysis
284
- │ ├── sizing/ # Sizing reports
285
- │ ├── summary/ # Summary reports
286
- │ └── workflow/ # Workflow reports
287
- ├── package.json # NPM package configuration
288
- ├── CHANGELOG.md # Version history
289
- ├── INDEX.md # Documentation index
290
- └── README.md # This file
291
- ```
292
-
293
-
294
- ### 📋 TODO
295
-
296
- - **🔍 Enhanced Debug Tools**: Expand debugging capabilities with more comprehensive analysis tools
297
- - **📊 Advanced Reporting**: Improve report generation with more detailed analytics
298
- - **🚀 Performance Optimization**: Further optimize translation processing for large projects
299
- - **🌍 Additional Language Support**: Expand UI language support beyond current 6 languages
300
- - **📝 UI-Locales Structure Refactor (Planned)**: Refactor `ui-locales/*.json` to use a multi-language object format for each key, e.g.:
301
-
302
- ```json
303
- {
304
- "analyzeTranslations": {
305
- "reportTitle": {
306
- "en": "TRANSLATION ANALYSIS REPORT FOR {language}",
307
- "de": "ÜBERSETZUNGSANALYSENBERICHT FÜR {language}",
308
- "fr": "RAPPORT D'ANALYSE DE TRADUCTION POUR {language}",
309
- "es": "INFORME DE ANÁLISIS DE TRADUCCIÓN PARA {language}",
310
- "ru": "ОТЧЁТ О АНАЛИЗЕ ПЕРЕВОДА ДЛЯ {language}",
311
- "ja": "{language} の翻訳分析レポート",
312
- "zh": "{language} 翻译分析报告"
313
- },
314
- "generated": {
315
- "en": "Generated: {timestamp}",
316
- "de": "Erstellt: {timestamp}",
317
- "fr": "Généré : {timestamp}",
318
- "es": "Generado: {timestamp}",
319
- "ru": "Сгенерировано: {timestamp}",
320
- "ja": "生成日時: {timestamp}",
321
- "zh": "生成时间: {timestamp}"
322
- },
323
- "status": {
324
- "en": "Status: {translated}/{total} translated ({percentage}%)",
325
- "de": "Status: {translated}/{total} übersetzt ({percentage}%)",
326
- "fr": "Statut : {translated}/{total} traduit ({percentage}%)",
327
- "es": "Estado: {translated}/{total} traducido ({percentage}%)",
328
- "ru": "Статус: переведено {translated}/{total} ({percentage}%)",
329
- "ja": "状況: {total}中{translated}件翻訳済み ({percentage}%)",
330
- "zh": "状态:{translated}/{total} 已翻译 ({percentage}%)"
331
- }
332
- }
333
- }
334
- ```
335
-
336
147
  > **📖 For detailed setup and usage instructions, see [Documentation](./docs/README.md)**
337
148
 
338
149
  ## 🛠️ Core Commands
@@ -352,37 +163,8 @@ i18n-management-toolkit/
352
163
  | `npm run i18ntk:summary` | Generate summary reports | `node main/i18ntk-summary.js` |
353
164
  | `npm run i18ntk:debug` | Debug and diagnostics | `node dev/debug/debugger.js` |
354
165
 
355
- ### Utility Scripts
356
-
357
- | Script | Description | Usage |
358
- |--------|-------------|-------|
359
- | `settings-cli.js` | Configure toolkit settings | `node settings-cli.js` |
360
- | `utils/admin-cli.js` | Admin operations | `node utils/admin-cli.js` |
361
-
362
166
  > **📖 For complete command reference, see [API Documentation](./docs/api/API_REFERENCE.md)**
363
167
 
364
- ## 🔧 Configuration
365
-
366
- ### User Configuration (`i18ntk-config.json`)
367
- ```json
368
- {
369
- "localesPath": "./locales",
370
- "supportedLanguages": ["en", "es", "fr", "de", "ru"],
371
- "defaultLanguage": "en",
372
- "excludePatterns": ["node_modules", ".git"],
373
- "includePatterns": ["**/*.js", "**/*.jsx", "**/*.ts", "**/*.tsx"]
374
- }
375
- ```
376
-
377
- ### Admin Configuration (`admin-config.json`)
378
- ```json
379
- {
380
- "adminPasswordHash": "...",
381
- "securityEnabled": true,
382
- "backupEnabled": true
383
- }
384
- ```
385
-
386
168
  ## 📊 Reports and Analysis
387
169
 
388
170
  The toolkit generates comprehensive reports in the `i18ntk-reports/` directory:
@@ -399,26 +181,9 @@ The toolkit generates comprehensive reports in the `i18ntk-reports/` directory:
399
181
 
400
182
  ## 🌍 Supported Languages
401
183
 
402
- The toolkit UI supports **7 languages** with complete internationalization:
184
+ The toolkit UI supports **7 languages** with partial internationalization:
403
185
 
404
- | Language | Code | Status | Coverage |
405
- |----------|------|--------|----------|
406
- | 🇺🇸 English | `en` | ✅ Complete | 573/573 keys (100%) |
407
- | 🇩🇪 German | `de` | ✅ Complete | 573/573 keys (100%) |
408
- | 🇪🇸 Spanish | `es` | ✅ Complete | 573/573 keys (100%) |
409
- | 🇫🇷 French | `fr` | ✅ Complete | 573/573 keys (100%) |
410
- | 🇯🇵 Japanese | `ja` | ✅ Complete | 573/573 keys (100%) |
411
- | 🇷🇺 Russian | `ru` | ✅ Complete | 573/573 keys (100%) |
412
- | 🇨🇳 Chinese | `zh` | ✅ Complete | 573/573 keys (100%) |
413
-
414
- **Features:**
415
- - 100% console output internationalization
416
- - Complete UI element translation
417
- - Dynamic placeholder support (`{language}`, `{fileName}`, etc.)
418
- - Zero missing or extra translation keys
419
- - Verified translation patterns across all languages
420
-
421
- Contributions for additional languages are welcome!
186
+ Requests for additional languages are welcome!
422
187
 
423
188
  ## 🧪 Development and Testing
424
189
 
@@ -427,36 +192,8 @@ Contributions for additional languages are welcome!
427
192
  # Main debug interface
428
193
  npm run i18ntk:debug
429
194
 
430
- # Check console translations
431
- node dev/debug/console-translations.js
432
-
433
- # Complete console translations
434
- node dev/debug/complete-console-translations.js
435
-
436
- # Replace hardcoded console messages
437
- node dev/debug/replace-hardcoded-console.js
438
- ```
439
-
440
- ### Testing
441
- ```bash
442
- # Run complete system test
443
- node dev/tests/test-complete-system.js
444
-
445
- # Test console i18n
446
- node dev/tests/test-console-i18n.js
447
-
448
- # Test all features
449
- node dev/tests/test-features.js
450
- ```
451
-
452
195
  > **📖 For comprehensive debug tools documentation, see [Debug Tools](./docs/debug/DEBUG_TOOLS.md)**
453
196
 
454
- ## 🔒 Security Features
455
-
456
- - Admin authentication for sensitive operations
457
- - Secure password hashing
458
- - Configuration backup system
459
- - Input validation and sanitization
460
197
 
461
198
  ## 📝 Best Practices
462
199
 
@@ -483,7 +220,7 @@ node dev/tests/test-features.js
483
220
 
484
221
  ---
485
222
 
486
- **Version:** 1.1.0 – Enhanced CLI experience with proper version command and improved documentation! 🚀
223
+ **Version:** 1.2.0 – Enhanced CLI experience with proper version command and improved documentation! 🚀
487
224
  ## 📄 License
488
225
 
489
226
  This project is licensed under the MIT License - see the `LICENSE` file for details.
@@ -1,14 +1,18 @@
1
1
  # I18N Management Toolkit - Installation Guide
2
2
 
3
- **Version:** 1.1.2
4
- **Release Date:** July 27, 2024
5
- **Status:** Stable Release - Enhanced CLI & Local Usage
3
+ **Version:** 1.1.5
4
+ **Release Date:** August 2, 2025
5
+ **Status:** Stable Release - Documentation & Metadata Cleanup
6
+
7
+ ## ⚠️ Important Disclaimer
8
+
9
+ **This is NOT an official i18n team product or affiliated with any i18n organization.** This toolkit was originally created as a personal project to help manage my own translation files, which was then enhanced with additional features, internationalization support, and made available to the community. It should work with any `en.json` translation files, even without i18n installed, and includes custom logic and settings that can be customized to fit your specific project needs. With simple code modifications or AI-assisted edits, you can easily adapt it to your project's requirements.
6
10
 
7
11
  ## 📦 Installation Options
8
12
 
9
13
  ### 📁 Local Project Installation (Recommended)
10
14
 
11
- Install i18ntk globally to use it across all your projects:
15
+ Install i18ntk locally for your project (recommended approach):
12
16
 
13
17
  #### NPM
14
18
  ```bash
@@ -209,7 +213,7 @@ When you run `i18ntk-init`, it automatically creates:
209
213
 
210
214
  ```
211
215
  your-project/
212
- ├── i18ntk-config.json # User preferences
216
+ ├── settings/i18ntk-config.json # User preferences (main configuration file)
213
217
  ├── admin-config.json # Admin settings (if needed)
214
218
  ├── locales/ # Translation files
215
219
  │ ├── en/
@@ -219,7 +223,7 @@ your-project/
219
223
  ```
220
224
 
221
225
  ### Manual Configuration
222
- If you prefer manual setup, create `i18ntk-config.json`:
226
+ If you prefer manual setup, create `settings/i18ntk-config.json`:
223
227
 
224
228
  ```json
225
229
  {