pubspec 文件

目录 keyboard_arrow_down keyboard_arrow_up

支持的字段
示例
详情

more_horiz

每个 pub 包都需要一些元数据，以便它可以指定其依赖项。与他人共享的 Pub 包还需要提供一些其他信息，以便用户可以发现它们。所有这些元数据都放在包的 pubspec: 中，这是一个名为 pubspec.yaml 的文件，用 YAML 语言编写。

pubspec 可以包含以下字段

name: 每个包都必需。 了解更多。
version: 托管在 pub.dev 站点上的包必需。 了解更多。
description: 托管在 pub.dev 站点上的包必需。 了解更多。
homepage: 可选。指向包主页（或源代码仓库）的 URL。 了解更多。
repository: 可选。指向包源代码仓库的 URL。 了解更多。
issue_tracker: 可选。指向包的问题跟踪器的 URL。 了解更多。
documentation: 可选。指向包文档的 URL。 了解更多。
dependencies: 如果您的包没有依赖项，则可以省略。 了解更多。
dev_dependencies: 如果您的包没有开发依赖项，则可以省略。 了解更多。
dependency_overrides: 如果您不需要覆盖任何依赖项，则可以省略。 了解更多。
environment: Dart 2 及更高版本必需。 了解更多。
executables: 可选。用于将包的可执行文件放在您的 PATH 中。 了解更多。
platforms: 可选。用于在 pub.dev 站点上显式声明支持的平台。 了解更多。
publish_to: 可选。指定发布包的位置。 了解更多。
funding: 可选。用户可以赞助包开发的 URL 列表。 了解更多。
false_secrets: 可选。指定在发布前搜索潜在密钥泄漏时要忽略的文件。 了解更多。
screenshots: 可选。指定要在 pub.dev 站点上显示的屏幕截图文件列表。 了解更多。
topics: 可选。包的主题列表。 了解更多。
ignored_advisories: 可选。忽略的安全公告列表。 了解更多。

Pub 忽略所有其他字段。

如果您添加自定义字段，请为其指定一个唯一的名称，该名称不会与将来的 pubspec 字段冲突。例如，与其添加 bugs，不如添加一个名为 my_pkg_bugs 的字段。

一个简单但完整的 pubspec 如下所示

yamlname: newtify
description: >-
  Have you been turned into a newt?  Would you like to be?
  This package can help. It has all of the
  newt-transmogrification functionality you have been looking
  for.
version: 1.2.3
homepage: https://example-pet-store.com/newtify
documentation: https://example-pet-store.com/newtify/docs

environment:
  sdk: '^3.2.0'
  
dependencies:
  efts: ^2.0.4
  transmogrify: ^0.4.0
  
dev_dependencies:
  test: '>=1.15.0 <2.0.0'

本节包含有关每个 pubspec 字段的更多信息。

每个包都需要一个名称。这是其他包引用您的包的方式，也是如果您发布它，它在世界上的显示方式。

名称应全部小写，用下划线分隔单词，例如 just_like_this。仅使用基本拉丁字母和阿拉伯数字：[a-z0-9_]。此外，请确保名称是有效的 Dart 标识符——它不以数字开头，也不是保留字。

尝试选择一个清晰、简洁且尚未使用过的名称。建议在 pub.dev 站点上快速搜索软件包，以确保没有其他软件包正在使用您的名称。

每个包都有一个版本。在 pub.dev 站点上托管您的包需要版本号，但对于仅限本地的包可以省略。如果省略，您的包将隐式版本化为 0.0.0。

版本控制对于重用代码同时使其快速发展是必要的。版本号是三个数字，用点分隔，例如 0.2.43。它也可以选择具有构建版本（+1、+2、+hotfix.oopsie）或预发布版本（-dev.4、-alpha.12、-beta.7、-rc.5）后缀。

每次发布您的包时，您都以特定版本发布它。完成后，将其视为密封的：您无法再对其进行修改。要进行更多更改，您需要一个新版本。

选择版本时，请遵循语义版本控制。

对于您自己的个人包，这是可选的，但是如果您打算发布您的包，则必须提供描述，该描述应为英文。描述应相对简短——60 到 180 个字符——并告诉普通读者他们可能想了解您的包的内容。

将描述视为您的包的推销。用户在浏览包时会看到它。描述是纯文本：没有 markdown 或 HTML。

这应该是指向您的包网站的 URL。对于托管包，此 URL 从包的页面链接。虽然提供 homepage 是可选的，但请提供它或 repository（或两者）。这有助于用户了解您的包来自哪里。

可选的 repository 字段应包含您的包源代码仓库的 URL，例如 https://github.com/<user>/<repository>。如果您将您的包发布到 pub.dev 站点，则您的包页面会显示仓库 URL。虽然提供 repository 是可选的，但请提供它或 homepage（或两者）。这有助于用户了解您的包来自哪里。

可选的 issue_tracker 字段应包含包的问题跟踪器的 URL，可以在其中查看现有错误并提交新错误。 pub.dev 站点尝试使用此字段的值显示指向每个包的问题跟踪器的链接。如果缺少 issue_tracker，但存在 repository 并且指向 GitHub，则 pub.dev 站点使用默认问题跟踪器 (https://github.com/<user>/<repository>/issues)。

某些包有一个站点托管文档，该文档与主页和 Pub 生成的 API 参考分开。如果您的包有其他文档，请添加带有该 URL 的 documentation: 字段； pub 会在您的包页面上显示指向此文档的链接。

依赖项是 pubspec 的存在理由。在本节中，您列出您的包工作所需的每个包。

依赖项分为两种类型。 常规依赖项 列在 dependencies: 下——这些是任何使用您的包的人也需要的包。仅在包本身的开发阶段需要的依赖项列在 dev_dependencies 下。

在开发过程中，您可能需要临时覆盖依赖项。您可以使用 dependency_overrides 来做到这一点。

有关更多信息，请参阅包依赖项。

一个包可能会将其一个或多个脚本公开为可直接从命令行运行的可执行文件。要使脚本公开可用，请将其列在 executables 字段下。条目以键/值对的形式列出

<name-of-executable>: <Dart-script-from-bin>

例如，以下 pubspec 条目列出了两个脚本

yamlexecutables:
  slidy: main
  fvm:

一旦使用 dart pub global activate 激活包，输入 slidy 将执行 bin/main.dart。输入 fvm 将执行 bin/fvm.dart。如果您未指定值，则会从键中推断出来。

有关更多信息，请参阅 pub global。

当您发布包时，pub.dev 会自动检测包支持的平台。如果此平台支持列表不正确，请使用 platforms 显式声明您的包支持哪些平台。

例如，以下 platforms 条目使 pub.dev 将包列为支持 Android、iOS、Linux、macOS、Web 和 Windows

yaml# This package supports all platforms listed below.
platforms:
  android:
  ios:
  linux:
  macos:
  web:
  windows:

这是一个声明包仅支持 Linux 和 macOS（例如，不支持 Windows）的示例

yaml# This package supports only Linux and macOS.
platforms:
  linux:
  macos:

默认使用 pub.dev 站点。指定 none 以阻止发布包。此设置可用于指定要发布的自定义 pub 包服务器。

yaml

publish_to: none

包作者可以使用 funding 属性来指定 URL 列表，这些 URL 提供有关用户如何帮助资助包开发的信息。例如

yamlfunding:
 - https://www.buymeacoffee.com/example_user
 - https://www.patreon.com/some-account

如果发布到 pub.dev，链接将显示在包页面上。这旨在帮助用户资助其依赖项的开发。

当您尝试发布包时，pub 会搜索潜在的密钥凭据、API 密钥或加密密钥泄漏。如果 pub 在要发布的文件中检测到潜在泄漏，则 pub 会警告您并拒绝发布包。

泄漏检测并不完美。为了避免误报，您可以告诉 pub 不要搜索某些文件中的泄漏，方法是在 pubspec 中的 false_secrets 下使用 gitignore 模式创建允许列表。

例如，以下条目使 pub 不会在文件 lib/src/hardcoded_api_key.dart 和 test/localhost_certificates/ 目录中的所有 .pem 文件中查找泄漏

yamlfalse_secrets:
 - /lib/src/hardcoded_api_key.dart
 - /test/localhost_certificates/*.pem

以斜杠 (/) 开头的 gitignore 模式确保该模式被视为相对于包的根目录。

包可以使用在其 pub.dev 页面上显示的屏幕截图来展示其小部件或其他视觉元素。要指定要显示的包的屏幕截图，请使用 screenshots 字段。

一个包最多可以在 screenshots 字段下列出 10 个屏幕截图。请勿在本节中包含徽标或其他品牌形象。每个屏幕截图都包含一个 description 和一个 path。 description 解释了屏幕截图所描绘的内容，不超过 160 个字符。例如

yamlscreenshots:
  - description: 'This screenshot shows the transformation of a number of bytes 
  to a human-readable expression.'
    path: path/to/image/in/package/500x500.webp
  - description: 'This screenshot shows a stack trace returning a human-readable
  representation.'
    path: path/to/image/in/package.png

Pub.dev 将屏幕截图限制为以下规范

文件大小：每张图片最大 4 MB。
文件类型：png、jpg、gif 或 webp。
静态图像和动画图像均允许。

保持屏幕截图文件小巧。每次下载包都包含所有屏幕截图文件。

Pub.dev 从第一个屏幕截图生成包的缩略图。如果此屏幕截图使用动画，则 pub.dev 使用其第一帧。

包作者可以使用 topics 字段对其包进行分类。主题可用于在 pub.dev 上使用过滤器搜索时帮助发现。 Pub.dev 在包页面以及搜索结果中显示主题。

该字段由名称列表组成。例如

yamltopics:
  - network
  - http

Pub.dev 要求主题遵循以下规范

为每个包最多标记 5 个主题。
按照以下要求编写主题名称
- 使用 2 到 32 个字符。
- 仅使用小写字母数字字符或连字符 (a-z、0-9、-)。
- 不要使用两个连续的连字符 (--)。
- 以小写字母字符 (a-z) 开头名称。
- 以字母数字字符 (a-z 或 0-9) 结尾。

选择主题时，请考虑现有主题是否相关。使用现有主题标记有助于用户发现您的包。

如果包的依赖项受到安全公告的影响，则 pub 会在依赖项解析期间警告该公告。包作者可以使用 ignored_advisories 字段作为触发公告的允许列表，这些公告与包无关。

要禁止显示有关公告的警告，请将公告标识符添加到 ignored_advisories 列表。例如

yamlname: myapp
dependencies:
  foo: ^1.0.0
ignored_advisories:
 - GHSA-4rgh-jx4f-qfcq

有关更多信息，请查看安全公告。

一个包可以指示它支持其依赖项的哪些版本，但包还有另一个隐式依赖项：Dart 平台本身。 Dart 平台随着时间的推移而发展，并且一个包可能仅适用于平台的某些版本。

一个包可以使用 SDK 约束 来指定这些版本。此约束位于 pubspec 中单独的顶级 environment 字段内，并使用与依赖项相同的版本约束语法。

例如，以下约束表示此包适用于任何版本为 3.0.0 或更高版本的 Dart SDK

yamlenvironment:
  sdk: ^3.0.0

Pub 尝试查找 SDK 约束与您安装的 Dart SDK 版本兼容的包的最新版本。

省略 SDK 约束是一个错误。当 pubspec 没有 SDK 约束时，dart pub get 会失败，并显示如下消息

pubspec.yaml has no lower-bound SDK constraint.
You should edit pubspec.yaml to contain an SDK constraint:

environment:
  sdk: '^3.2.0'
  
See https://dart.ac.cn/go/sdk-constraint

Pub 支持在 environment: 字段下指定 Flutter SDK 约束

yamlenvironment:
  sdk: ^3.2.0
  flutter: '>= 3.22.0'

仅当 pub 在 flutter 可执行文件的上下文中运行时，Flutter SDK 约束才满足，并且 Flutter SDK 的 version 文件满足版本约束的下限。否则，将不会选择该包。

要发布具有 Flutter SDK 约束的包，您必须指定 Dart SDK 约束，其最低版本至少为 1.19.0，以确保旧版本的 pub 不会意外安装需要 Flutter 的包。

除非另有说明，否则本网站上的文档反映的是 Dart 3.7.1 版本。页面上次更新于 2024-12-10。查看源代码或报告页面问题。

pubspec 文件

支持的字段

示例

详情

名称

版本

描述

主页

仓库

问题跟踪器

文档

依赖项

可执行文件

平台

发布到

资助

虚假密钥

屏幕截图

主题

忽略的公告

SDK 约束

Flutter SDK 约束