hitf-cli-md
hitf-cli translation toolkit configuration file
.hias-hitf.json.hias-hitf.jsonc
Validate
Check your file against this schema
Opens the validator with this schema already loaded. Paste your
.hias-hitf.json and it validates in your browser — nothing is uploaded.
Reference
Fields
Generated directly from the schema, following local
$refs, to two levels of nesting.
| Field | Type | Description |
|---|---|---|
translationSetting | object | Translation service and locale configuration |
translationSetting.locales | array<string> | RFC 5646 language codes. First element is source language, rest are target languages. Examples: "zh-CN" (Chinese Simplified), "zh-TW" (Chinese Traditional), "en-US" (English US), "en-GB" (English UK), "ja-JP" (Japanese), "ko-KR" (Korean) default: ["zh-CN", "en-US"] |
translationSetting.outDir | oneOf | — default: ".hitf/lang" |
translationSetting.fallbackToKey | boolean | When true, use i18n key as fallback text if translation is unavailable. When false, keep original source text default: true |
translationSetting.replaceOriginalFile | boolean | When true, replace source text in original files with $t() calls. When false, generate translated files in outDir only default: false |
translationSetting.i18nCallTemplate | oneOf | — default: "$t" |
translationSetting.i18nImport | oneOf | — default: "" |
translationSetting.extensions | array<string> | Custom file extensions to process. Empty array uses defaults: .vue, .nvue, .uvue, .js, .ts, .jsx, .tsx, .json default: [] |
translationSetting.capitalizeTranslations | boolean | Capitalize first letter of each word in English translations (e.g., 'save success' → 'Save Success') default: false |
translationSetting.capitalizeMaxWords | number | Maximum word count to apply capitalization. 0 = capitalize all words regardless of count default: 0 |
translationSetting.pruneUnusedKeys | boolean | Remove keys from locale files that are no longer referenced in source code default: false |
translationSetting.keyStrategy | object | Key generation strategy for i18n keys |
translationSetting.keyStrategy.maxLength | number | Maximum key length. Longer keys will be truncated default: 40 |
translationSetting.keyStrategy.collision | string | Strategy for handling key collisions: 'number' appends _1, _2, etc. 'hash' appends short hash suffix default: "number"one of: "number", "hash" |
translationSetting.keyStrategy.hashLength | number | Length of hash suffix when collision strategy is 'hash' (4-8 chars recommended) default: 6 |
translationSetting.translationService | string | Primary translation service provider. Supported: 'baidu' (Baidu Translate), 'tencent' (Tencent Cloud), 'openai' (OpenAI GPT), 'google' (Google Cloud Translation) default: "tencent"one of: "baidu", "tencent", "openai", "google" |
translationSetting.servicePriority | array<string> | Fallback order when primary translation service fails. Services are tried in order default: ["tencent", "baidu", "openai", "google"] |
translationSetting.services | object | Translation service credentials and configuration options |
translationSetting.services.openai | object | OpenAI / compatible API configuration |
translationSetting.services.google | object | Google Cloud Translation API configuration |
translationSetting.services.baidu | object | Baidu Translate API configuration |
translationSetting.services.tencent | object | Tencent Cloud Translation API configuration |
gitRepoSetting | object | Git repository sync configuration for shared translation resources |
gitRepoSetting.gitRepoAutoUpdate | boolean | Auto-pull latest changes from git repositories before translation default: false |
gitRepoSetting.gitRepoMode | string | Sync conflict resolution: 'merge' keeps local changes, 'overwrite' replaces with remote default: "merge"one of: "merge", "overwrite" |
gitRepoSetting.gitRepo | object | Map project name to git repository URL for shared translation resources |
language | string | CLI interface display language (global config only, not project config) default: "zh-CN"one of: "zh-CN", "en-US" |
Audit
What we found in this schema
- Declared draft: draft-07
- Validates cleanly against its own meta-schema.
- 36 properties, 92% carrying a description, max nesting depth 9.
Standards
Specification sections for the keywords in this schema
| Keyword | Document | Section |
|---|---|---|
$id | JSON Schema Core, draft 2020-12 | §8.2.1 — The "$id" Keyword |
$schema | JSON Schema Core, draft 2020-12 | §8.1.1 — "$schema" |
additionalProperties | JSON Schema Core, draft 2020-12 | §10.3.2.3 — "additionalProperties" |
default | JSON Schema Validation, draft 2020-12 | §9.2 — "default" |
description | JSON Schema Validation, draft 2020-12 | §9.1 — "title" and "description" |
enum | JSON Schema Validation, draft 2020-12 | §6.1.2 — "enum" |
examples | JSON Schema Validation, draft 2020-12 | §9.5 — "examples" |
items | JSON Schema Core, draft 2020-12 | §10.3.1.2 — "items" |
maxLength | JSON Schema Validation, draft 2020-12 | §6.3.1 — "maxLength" |
minItems | JSON Schema Validation, draft 2020-12 | §6.4.2 — "minItems" |
minimum | JSON Schema Validation, draft 2020-12 | §6.2.4 — "minimum" |
oneOf | JSON Schema Core, draft 2020-12 | §10.2.1.3 — "oneOf" |
properties | JSON Schema Core, draft 2020-12 | §10.3.2.1 — "properties" |
type | JSON Schema Validation, draft 2020-12 | §6.1.1 — "type" |
Documents
- JSON Schema Core, draft 2020-12 — JSON Schema: A Media Type for Describing JSON Documents, A. Wright, H. Andrews, B. Hutton, G. Dennis, Eds., 2022. draft-bhutton-json-schema-01. An expired Internet-Draft with no formal standing in the IETF standards process; it is nonetheless the specification of record for JSON Schema 2020-12, published by json-schema.org.
- JSON Schema Validation, draft 2020-12 — JSON Schema Validation: A Vocabulary for Structural Validation of JSON, A. Wright, H. Andrews, B. Hutton, Eds., 2022.
- RFC 8259 (STD 90) — The JavaScript Object Notation (JSON) Data Interchange Format, T. Bray, Ed., 2017. The format a schema describes.
- RFC 6901 — JavaScript Object Notation (JSON) Pointer. Defines the pointer syntax used by $ref fragments and the ~0 / ~1 escapes.
Source
Attribution
This schema comes from SchemaStore, distributed under the Apache License 2.0. Copyright 2015–present Mads Kristensen and contributors. View the original file. The field table and audit on this page are generated by JSONTools.tools; the schema itself is unmodified.