@codingame/json-schema-l10n

中文文档
1.0.2发布于 2024/02/15TypeScriptESM + CJS近 30 天下载 2438

Tool to handle localization in JSON schema

原始使用文档
文档目录4 节
  1. Installation
  2. Implementation
  3. Types
  4. Functions

json-schema-l10n

This library uses JSONSchema6 from the library json-schema.

It adds a localization object for the description of the JSON schema.

Installation

npm install @codingame/json-schema-l10n

Implementation

Types

The implemented types are:

  • Descriptions: an object that stores the localized descriptions by locale
  • LocalizedJSONSchema: an interface that extends JSONSchema6 with localized descriptions added

Functions

The implemented functions are:

  • getLocalizedDescription:
    • takes in parameters a schema with localized descriptions and the locale for which we want the description (default value is 'en')
    • returns the description for the wanted locale, or undefined if not found
  • renderJsonSchema:
    • takes in parameters the locale for which we want the description and a schema with localized descriptions
    • returns the JSONSchema6 equivalent with the selected locale

版本与发布记录

@codingame/json-schema-l10n 共发布 1 个版本,首次发布于 2024/02/15;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.0.2latest2024/02/152 年前

关于 @codingame/json-schema-l10n 的常见问题

@codingame/json-schema-l10n 是什么?

Tool to handle localization in JSON schema

如何安装 @codingame/json-schema-l10n?

在项目目录运行 npm install @codingame/json-schema-l10n,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(>=16.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@codingame/json-schema-l10n 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@codingame/json-schema-l10n 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@codingame/json-schema-l10n 可以商用吗?

@codingame/json-schema-l10n 使用 未声明 许可。package.json 没有声明许可证。没有许可证的代码默认保留全部权利,商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括,不构成法律意见,请以许可原文为准。

@codingame/json-schema-l10n 的下载量有多少?

根据 npm 官方下载统计,@codingame/json-schema-l10n 在 2026/10/10 – 2026/11/08 这 30 天内被下载 2,438 次,日均约 81 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@codingame/json-schema-l10n 还在维护吗?

最新版本 1.0.2 发布于 2024/02/15(2 年前);至今共发布 1 个版本,其中过去 12 个月发布了 0 个;首次发布于 2024/02/15。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。