7.6.5 swift package-collection describe

原文链接: https://docs.swift.org/latest/documentation/packagemanagerdocs/packagecollectiondescribe/

7.6.5 swift package-collection describe

获取某个集合、或者已导入集合中某个包的元数据。

概述

这个子命令显示某个集合、或者已导入集合中某个包的元数据。结果可以选择用 --json 以 JSON 形式返回,便于集成到其他工具中。

集合的元数据与包

describe 既可用于此前已加入用户配置集合列表的集合,也可用于预览任何其他集合。

1
2
3
4
5
6
7
8
9
$ swift package-collection describe [--json] https://www.example.com/packages.json
Name: Sample Package Collection
Source: https://www.example.com/packages.json
Description: ...
Keywords: best, packages
Created At: 2020-05-30 12:33
Packages:
    https://github.com/jpsim/yams
    ...

已签名的包集合

如果集合已签名,SwiftPM 会在显示预览之前检查签名是否有效。

1
2
$ swift package-collection describe https://www.example.com/bad-packages.json
The collection's signature is invalid. If you would like to continue please rerun command with '--skip-signature-check'.

用户可以在出现错误的情况下继续预览该集合,或者通过传入 --skip-signature-check 标志预先跳过对某个包集合的签名检查:

1
$ swift package-collection describe https://www.example.com/packages.json --skip-signature-check

包的元数据

describe 也可以显示已导入集合中某个包的元数据:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
$ swift package-collection describe [--json] https://github.com/jpsim/yams
Description: A sweet and swifty YAML parser built on LibYAML.
Available Versions: 4.0.0, 3.0.0, ...
Stars: 14
Readme: https://github.com/jpsim/Yams/blob/main/README.md
Authors: @norio-nomura, @jpsim
--------------------------------------------------------------
Latest Version: 4.0.0
Package Name: Yams
Modules: Yams, CYaml
Supported Platforms: iOS, macOS, Linux, tvOS, watchOS
Supported Swift Versions: 5.3, 5.2, 5.1, 5.0
License: MIT

包版本的元数据

用户可以通过传入 --version 查看某个包版本的额外元数据:

1
2
3
4
5
6
7
$ swift package-collection describe [--json] --version 4.0.0 https://github.com/jpsim/yams
Package Name: Yams
Version: 4.0.0
Modules: Yams, CYaml
Supported Platforms: iOS, macOS, Linux, tvOS, watchOS
Supported Swift Versions: 5.3, 5.2, 5.1, 5.0
License: MIT

用法

package-collection describe [--json] <package-url>
  [--version=<version>] [--skip-signature-check]
  [--package-path=<package-path>] [--cache-path=<cache-path>]
  [--config-path=<config-path>]
  [--security-path=<security-path>]
  [--scratch-path=<scratch-path>]
  [--swift-sdks-path=<swift-sdks-path>]
  [--toolset=<toolset>...]
  [--pkg-config-path=<pkg-config-path>...]
  [--enable-dependency-cache] [--disable-dependency-cache]
  [--enable-build-manifest-caching]
  [--disable-build-manifest-caching]
  [--manifest-cache=<manifest-cache>]
  [--enable-experimental-prebuilts]
  [--disable-experimental-prebuilts] [--verbose]
  [--very-verbose|vv] [--quiet] [--color-diagnostics]
  [--no-color-diagnostics] [--disable-sandbox] [--netrc]
  [--enable-netrc] [--disable-netrc]
  [--netrc-file=<netrc-file>] [--enable-keychain]
  [--disable-keychain]
  [--resolver-fingerprint-checking=<resolver-fingerprint-checking>]
  [--resolver-signing-entity-checking=<resolver-signing-entity-checking>]
  [--enable-signature-validation]
  [--disable-signature-validation] [--enable-prefetching]
  [--disable-prefetching]
  [--force-resolved-versions|disable-automatic-resolution|only-use-versions-from-resolved-file]
  [--skip-update] [--disable-scm-to-registry-transformation]
  [--use-registry-identity-for-scm]
  [--replace-scm-with-registry]
  [--default-registry-url=<default-registry-url>]
  [--configuration=<configuration>] [--=<Xcc>...]
  [--=<Xswiftc>...] [--=<Xlinker>...] [--=<Xcxx>...]
  [--triple=<triple>] [--sdk=<sdk>] [--toolchain=<toolchain>]
  [--swift-sdk=<swift-sdk>] [--sanitize=<sanitize>...]
  [--auto-index-store] [--enable-index-store]
  [--disable-index-store]
  [--enable-parseable-module-interfaces] [--jobs=<jobs>]
  [--use-integrated-swift-driver]
  [--explicit-target-dependency-import-check=<explicit-target-dependency-import-check>]
  [--build-system=<build-system>] [--=<debug-info-format>]
  [--enable-dead-strip] [--disable-dead-strip]
  [--disable-local-rpath] [--version] [--help]
  • –json:

以 JSON 输出

  • package-url:

要获取信息的包或集合的 URL。

  • –version=<version>:

要获取信息的包的版本。

  • –skip-signature-check:

如果集合已签名则跳过签名检查。

  • –package-path=<package-path>:

指定要操作的包路径(默认为当前目录)。这会先切换工作目录,然后再执行其他任何操作。

  • –cache-path=<cache-path>:

指定共享缓存目录的路径。

  • –config-path=<config-path>:

指定共享配置目录的路径。

  • –security-path=<security-path>:

指定共享安全目录的路径。

  • –scratch-path=<scratch-path>:

指定自定义的临时构建目录路径。(默认 .build)

  • –swift-sdks-path=<swift-sdks-path>:

包含已安装 Swift SDK 的目录路径。

  • –toolset=<toolset>:

指定为目标平台构建时使用的工具集 JSON 文件。可以多次使用该选项来指定多个工具集。各个工具集会按指定顺序合并为当前构建的单个最终工具集。

  • –pkg-config-path=<pkg-config-path>:

指定搜索 pkg-config .pc 文件的替代路径。可以多次使用该选项来指定多个路径。

  • –enable-dependency-cache|disable-dependency-cache:

获取依赖时使用共享缓存。

  • –enable-build-manifest-caching|disable-build-manifest-caching:

  • –manifest-cache=<manifest-cache>:

Package.swift 清单的缓存模式。有效取值:shared(共享缓存)、local(包的构建目录)、none(禁用)

  • –enable-experimental-prebuilts|disable-experimental-prebuilts:

是否对宏使用预编译的 swift-syntax 库。

  • –verbose:

提高详细程度,包含信息性输出。

  • –very-verbose|vv:

提高详细程度,包含调试输出。

  • –quiet:

降低详细程度,只包含错误输出。

  • –color-diagnostics|no-color-diagnostics:

在向 TTY 输出时启用或禁用彩色诊断信息。默认情况下,连接到 TTY 时启用彩色诊断,否则禁用。

  • –disable-sandbox:

执行子进程时禁用沙箱。

  • –netrc:

即使在其他凭据存储更优先的情况下也使用 netrc 文件。

  • –enable-netrc|disable-netrc:

从 netrc 文件加载凭据。

  • –netrc-file=<netrc-file>:

指定 netrc 文件的路径。

  • –enable-keychain|disable-keychain:

在 macOS 钥匙串中查找凭据。

  • –resolver-fingerprint-checking=<resolver-fingerprint-checking>:

  • –resolver-signing-entity-checking=<resolver-signing-entity-checking>:

  • –enable-signature-validation|disable-signature-validation:

验证从注册表下载的已签名包发布的签名。

  • –enable-prefetching|disable-prefetching:

  • –force-resolved-versions|disable-automatic-resolution|only-use-versions-from-resolved-file:

只使用 Package.resolved 文件中的版本,如果该文件已过期则解析失败。

  • –skip-update:

在解析期间跳过从远程更新依赖。

  • –disable-scm-to-registry-transformation:

禁用从源代码管理到注册表的转换。

  • –use-registry-identity-for-scm:

在注册表中查找源代码管理依赖,并尽可能使用它们的注册表标识,以帮助在两种来源之间去重。

  • –replace-scm-with-registry:

在注册表中查找源代码管理依赖,并尽可能改用注册表来获取它们,而不是用源代码管理。

  • –default-registry-url=<default-registry-url>:

要使用的默认注册表 URL,用于替代 registries.json 配置文件。

  • –configuration=<configuration>:

以指定配置构建

  • –=<Xcc>:

把标志传递给所有 C 编译器调用。

  • –=<Xswiftc>:

把标志传递给所有 Swift 编译器调用。

  • –=<Xlinker>:

把标志传递给所有链接器调用。

  • –=<Xcxx>:

把标志传递给所有 C++ 编译器调用。

  • –triple=<triple>:

  • –sdk=<sdk>:

  • –toolchain=<toolchain>:

  • –swift-sdk=<swift-sdk>:

筛选构建时要使用的特定 Swift SDK。

  • –sanitize=<sanitize>:

打开针对错误行为的运行时检查,可能取值:address、thread、undefined、scudo。

  • –auto-index-store|enable-index-store|disable-index-store:

启用或禁用构建期间建立索引的特性。

  • –enable-parseable-module-interfaces:

  • –jobs=<jobs>:

构建过程中并行启动的任务数量。

  • –use-integrated-swift-driver:

  • –explicit-target-dependency-import-check=<explicit-target-dependency-import-check>:

一个标志,表明本次构建应检查各个目标是否只导入它们显式声明的依赖。

  • –build-system=<build-system>:

  • –=<debug-info-format>:

要使用的调试信息格式。

  • –enable-dead-strip|disable-dead-strip:

禁用/启用链接器的死代码剥离。

  • –disable-local-rpath:

默认不再把 $ORIGIN/@loader_path 加入 rpath。

  • –version:

显示版本。

  • –help:

显示帮助信息。