# @bitnami/readme-generator-for-helm 中文文档 规范地址：https://npmcn.com/package/%40bitnami/readme-generator-for-helm/ 版本：2\.7\.2 npm 元数据更新时间：2025-07-14T07:13:33.950Z 中文译文更新时间：2026-11-08T04:35:55.374Z 软件包许可：Apache-2\.0 本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。 原始 npm 页面：https://www.npmjs.com/package/%40bitnami/readme-generator-for-helm 原文对照：https://npmcn.com/package/%40bitnami/readme-generator-for-helm/?lang=original 项目主页：https://github.com/bitnami/readme-generator-for-helm#readme 源码仓库：https://github.com/bitnami/readme-generator-for-helm ## 关键信息（来自 npm 元数据） - 包体积（解压后）：387 kB，48 个文件 - 模块格式：CommonJS - TypeScript 类型：未声明 - 运行依赖：5 个 - 首次发布：2022-10-19T12:24:36.882Z - 最新版本发布：2025-07-14T07:13:33.748Z - 近 30 天下载量：27599（2026-10-08 至 2026-11-06，npm 官方下载统计） - 已发布版本数：10（近 12 个月 0 个） ## 中文简介 自动生成 READMEs 表格和 Helm 图表的 OpenAPI 方案 ## 安装 ```sh npm install @bitnami/readme-generator-for-helm ``` 也可以使用：`pnpm add @bitnami/readme-generator-for-helm`、`yarn add @bitnami/readme-generator-for-helm`、`bun add @bitnami/readme-generator-for-helm` ## README # Helm 读取生成器 - 基于值YAML文件元数据自动生成Helm Charts READMEs的表格. - 自动生成一个符合 OpenAPI 的 JSON 计划, 定义 `values.yaml` helm图的结构。 生成的文件将是一个 JSON 文件, 格式化为 [打开APIv3 Schema 对象](https://spec.openapis.org/oas/v3.1.0#schema-object) 定义. ## 如何运作 该工具期望在所提供数据中描述一些元数据 `values.yaml` 文档。 它将分析并检查元数据与真实值. 如果元数据与实际值一致,它将生成数值表并插入所提供的数值表 `README.md` 文档. 如果元数据不正确,它会打印出完整的出错列表. 它检查是否存在已存在的值的元数据,或者是否存在已存在的值的元数据缺失. 将插入 `readme.md` 将具有以下结构: ```markdown ## Parameters ### Section 1 title | Name | Description | Default | |:----------|:------------------------|:---------------| | `value_1` | Description for value 1 | `defaultValue` | | `value_2` | Description for value 2 | `defaultValue` | | `value_3` | Description for value 3 | `defaultValue` | ### Section 2 title | Name | Description | Default | |:----------|:------------------------|:---------------| | `value_1` | Description for value 1 | `defaultValue` | | `value_2` | Description for value 2 | `defaultValue` | | `value_3` | Description for value 3 | `defaultValue` | ... ``` 数目 `#` 区域标题所需的字符是动态计算,标题是 `Parameters` 区域可以通过 [配置文件](https://npmcn.com/package/%40bitnami/readme-generator-for-helm/#readme-configuration-file)编辑 `README.md` 带有一个文件 `## Parameters` 区域在运行工具前必须创建 `Parameters` 区应该有两个 `#` 或更多符号. ## 所需资源 该项目已经开发并测试了节点版本 `22.x`。 。 。 . ## 安装 执行以下安装工具的命令 : ```console git clone https://github.com/bitnami/readme-generator-for-helm npm install ./readme-generator-for-helm ``` 取决于您如何在您的系统中安装节点JS, 您可能需要修改您 `PATH` 能够执行该工具的环境变量. ## 单二进制 执行以下命令以创建工具的单一可执行二进制 : ```console git clone https://github.com/bitnami/readme-generator-for-helm cd ./readme-generator-for-helm npm install npm install -g @yao-pkg/pkg pkg . -o readme-generator-for-helm ``` ## 测试 我们用 [欢乐](https://jestjs.io/) 实施测试。 为了测试您的更改, 请执行以下命令 : ```console npm run-script test ``` ### 林特 修改代码后执行以下命令来通过linter: ```console npm run-script lint ``` ## 基本用途 ```console Usage: readme-generator [options] Options: -v, --values Path to the values.yaml file -r, --readme Path to the README.md file -c, --config Path to the config file -s, --schema Path for the OpenAPI Schema output file --version Show Readme Generator version -h, --help display help for command ``` ## 数值.yaml 元数据 要使用工具, 您需要添加一些元数据 `values.yaml` 文档. 默认情况下,我们使用类似于Javadoc的格式,使用 `@xxx` 标记结构. 以下是在此时刻支持的标记 : - 参数: `## @param fullKeyPath [modifier?] Description`。 。 。 . - 一节: `## @section Section Title"`。 。 。 . - 跳过一个物体及其所有的孩子: `## @skip fullKeyPath Description?`。 。 。 . - 添加中间对象的描述( 即在 YAML 树上不是最后的) : `## @extra fullkeyPath Description`。 。 。 . 所有标记以及两个开头 `#` 注释样式的字符可以在 [配置文件](https://npmcn.com/package/%40bitnami/readme-generator-for-helm/#readme-configuration-file)。 。 。 . > \[大 标签在文件中的顺序或位置并不重要,除了@section tag 。 在找到新区域或文件结束之前, @ section 将包含其后的所有参数 . 这个 `modifier` 是可选的,它将改变参数的处理方式. 通过使用逗号将其相分离,可以应用几个修饰符(`,`) (中文(简体) ). 当影响值时,最后一个值优先. 目前支持的修改符 : - `[array]` 表示参数的值必须设置为 `[]`。 。 。 . - `[object]` 表示参数的值必须设置为 `{}`。 。 。 . - `[string]` 表示参数的值必须设置为 `""`。 。 。 . - `[nullable]` 表示参数值可以设定为 `null`。 。 。 . - `[default: DEFAULT_VALUE]` 设定默认值为 `DEFAULT_VALUE`。 。 。 . 修饰者也可以通过 [配置文件](https://npmcn.com/package/%40bitnami/readme-generator-for-helm/#readme-configuration-file)。 。 。 . 如果你要加一个 `custom modifier` 到数值文件中没有值的参数 您必须添加一个 `supported modifiers` 作为最后一个修饰符. 示例 值文件 ```yaml # @param noDefaultValue [number, nullable] Description # noDefaultValue: 1 ``` 自定义配置片段 : ```json { ... "modifiers": { "array": "array", "object": "object" "string": "string" "nullable": "nullable", "number": "number" }, ... } ``` ## 配置文件 配置文件的结构如下: ```json { "comments": { "format": "##" <-- Which is the comments format in the values YAML }, "tags": { "param": "@param", <-- Tag that indicates a parameter "section": "@section", <-- Tag that indicates a section "descriptionStart": "@descriptionStart", <-- Tag that indicates the beginning of a section description "descriptionEnd": "@descriptionEnd", <-- Tag that indicates the end of a section description "skip": "@skip", <-- Tag that indicates the object must be skipped "extra": "@extra" <-- Tag to add a description for an intermediate object }, "modifiers": { "array": "array", <-- Modifier that indicates an array type "object": "object" <-- Modifier that indicates an object type "string": "string" <-- Modifier that indicates a string type "nullable": "nullable" <-- Modifier that indicates a parameter that can be set to null }, "regexp": { "paramsSectionTitle": "Parameters" <-- Title of the parameters section to replace in the README.md } } ``` ## 承诺前 将此添加到您的 `.pre-commit-config.yaml`数字 : ```yaml - repo: https://github.com/bitnami/readme-generator-for-helm rev: "main" hooks: - id: helm-readme-generator # in order to run helm-readme-generator only once pass_filenames: false always_run: true # default args are [--readme=chart/README.md, --values=chart/values.yaml] args: [--readme=path/to/README.md, --values=path/to/values.yaml] ``` ## 版本数 ### 2.8.0 (中文(简体) ) 描述现在只丢弃一个白色空间 。 这样,代码块可以使用适当的缩进. ### 2.4.0 (中文(简体) ) 添加 `descriptionStart` 财务报告和审定财务报表 `descriptionEnd` 配置选项( 默认标签 : `@descriptionStart` 财务报告和审定财务报表 `@descriptionEnd`(中文(简体) ) 在 README.md 中允许文本块前方的每个区块。 更改这些标记值时, 确保不发生冲突 与 `section` 配置选项 . 如果你使用定制的 [配置文件](https://npmcn.com/package/%40bitnami/readme-generator-for-helm/#readme-configuration-file),请添加新的默认标记,以防止任何错误的行为. ### 2.0.0 (韩语) 这个 `-m (--metadata)` 选项已更名为 `-s (--schema)` 以正确识别它产生的东西. ## 许可证 版权:"2025 Broadcom". "Broadcom"一词指Broadcom Inc.和/或其子公司. 根据Apache许可证第2.0版("License"); 您不得使用此文件,除非符合许可证. 您可在下列地点获得许可证副本: [http://www.apache.org/licenses/LICENSE-2.0 (中文(简体) )](http://www.apache.org/licenses/LICENSE-2.0) 除非适用的法律要求或书面同意,否则软件 根据许可证发放的是在“AS IS”BASIS上发放的, 没有任何明示或暗示的警告或条件. 有关许可的特定语言的许可证 许可证的限制. ## 常见问题 ### @bitnami/readme-generator-for-helm 是什么？ 自动生成 READMEs 表格和 Helm 图表的 OpenAPI 方案 ### 如何安装 @bitnami/readme-generator-for-helm？ 在项目目录运行 npm install @bitnami/readme-generator-for-helm，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 readme-generator，可以用 npx readme-generator 直接运行。 ### @bitnami/readme-generator-for-helm 支持 TypeScript 吗？ 该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/bitnami\_\_readme-generator-for-helm 是否存在。 ### @bitnami/readme-generator-for-helm 支持 ESM 还是 CommonJS？ 以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。 ### @bitnami/readme-generator-for-helm 可以商用吗？ @bitnami/readme-generator-for-helm 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。 ### @bitnami/readme-generator-for-helm 的下载量有多少？ 根据 npm 官方下载统计，@bitnami/readme-generator-for-helm 在 2026/10/08 – 2026/11/06 这 30 天内被下载 27,599 次，日均约 920 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。 ### @bitnami/readme-generator-for-helm 还在维护吗？ 最新版本 2\.7\.2 发布于 2025/07/14（1\.3 年前）；至今共发布 10 个版本，其中过去 12 个月发布了 0 个；首次发布于 2022/10/19。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。