Backstage Catalog Helper 0.2.0

Backstage Catalog Helper是一款专门为Visual Studio Code设计的扩展工具，旨在简化和优化您在处理Backstage目录YAML文件时的工作流程。无论您是新手还是经验丰富的开发者，这个扩展都将成为您不可或缺的助手。

功能亮点：

• 智能自动完成： 为系统、组（所有者）、组件、资源、类型、生命周期和API提供自动完成建议，让您轻松填写catalog-info.yaml文件。
• 部分匹配： 只需开始输入，扩展就会根据您的输入提供过滤后的建议，提高编辑效率。
• 描述显示： 在自动完成建议中查看实体描述，帮助您更好地理解和选择。

安装指南：

1. 打开Visual Studio Code。
2. 进入扩展视图（Ctrl Shift X或macOS上的Cmd Shift X）。
3. 搜索"Backstage Catalog Helper"。
4. 点击安装。

您也可以从Visual Studio Code Marketplace直接安装此扩展。

配置设置：

在使用扩展之前，您需要设置您的Backstage API URL：

1. 打开VS Code设置（文件 > 首选项 > 设置）。
2. 搜索"Backstage Catalog Helper"。
3. 在"Backstage Catalog Helper: Base Url"字段中输入您的Backstage API URL。

认证方式：

扩展支持从Backstage获取实体时的认证，支持两种认证方法：

• Bearer Token认证
• 基本认证

Bearer Token认证：

1. 在VS Code设置中将认证方法设置为Bearer Token：
   • 打开VS Code设置（文件 > 首选项 > 设置）。
   • 搜索backstageCatalogHelper.authMethod。
   • 从下拉菜单中选择Bearer Token。
2. 扩展将在首次尝试获取实体时提示您输入您的Backstage API令牌。
3. 配置您的Backstage服务器以支持Bearer Token认证。在app-config.production.yaml文件中添加静态令牌，如下所示：

   backend:
     auth:
       externalAccess:
         - type: static
           options:
             token: ${VS_CODE_TOKEN}
             subject: vs-code-extension
           accessRestrictions:
             - plugin: catalog

   将${VS_CODE_TOKEN}替换为您的实际令牌值。请参考Backstage文档以获取更多关于静态令牌设置的详细信息。

基本认证：

基本认证允许使用用户名和密码进行认证。要使用基本认证：

1. 在VS Code设置中将认证方法设置为Basic Auth：
   • 打开VS Code设置（文件 > 首选项 > 设置）。
   • 搜索backstageCatalogHelper.authMethod。
   • 从下拉菜单中选择Basic Auth。
2. 在扩展首次尝试获取实体时，您将被提示输入您的Backstage用户名和密码。这些凭证将被安全地存储在VS Code的秘密存储中。

切换认证方法：

您可以随时在认证方法之间切换：

• 打开VS Code设置并将backstageCatalogHelper.authMethod的值更改为Basic Auth或Bearer Token。
• 在下次尝试获取实体时，扩展将提示您提供新认证方法所需的凭证。

使用方法：

1. 在VS Code中打开catalog-info.yaml文件。
2. 从命令面板（Ctrl Shift P或macOS上的Cmd Shift P）运行"Fetch Backstage Entities"命令。
3. 在YAML文件中开始输入以下字段之一：
   • system:
   • owner:
   • kind:
   • type:
   • lifecycle:
   • component:
   • resource:
   • api:
4. 扩展将根据您的Backstage目录提供自动完成建议。
5. 您还可以在冒号后开始输入实体名称（例如，owner: tea）以获取过滤后的建议。

示例：

apiVersion: backstage.io/v1alpha1
kind: Com  # 在此处开始输入并获取建议
metadata:
  name: example-component
  description: An example component
spec:
  type: ser  # 在此处开始输入并获取建议
  lifecycle: pr  # 在此处开始输入并获取建议
  owner: tea  # 在此处开始输入并获取建议
  system: pub  # 在此处开始输入并获取建议
  api: pub  # 在此处开始输入并获取建议

故障排除：

如果您没有看到任何建议：

1. 确保您在扩展设置中设置了正确的Backstage API URL。
2. 运行"Fetch Backstage Entities"命令以刷新实体数据。
3. 确保您的YAML文件被识别为Backstage目录文件（通常应命名为catalog-info.yaml）。

贡献：

我们欢迎您为改进Backstage Catalog Helper扩展做出贡献！请随时在我们的GitHub存储库上提交问题或拉取请求。

许可证：

此项目根据MIT许可证授权 - 请查看LICENSE文件以获取详细信息。

支持：

如果您遇到任何问题或有任何疑问，请在我们的GitHub问题跟踪器上提交问题。