Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tayloraswift/swift-package-catalog
SPM plugin for generating symbolgraphs and cataloging DocC documentation
https://github.com/tayloraswift/swift-package-catalog
docc swift swift-package-manager swift-package-plugin
Last synced: about 2 months ago
JSON representation
SPM plugin for generating symbolgraphs and cataloging DocC documentation
- Host: GitHub
- URL: https://github.com/tayloraswift/swift-package-catalog
- Owner: tayloraswift
- License: apache-2.0
- Created: 2022-03-31T23:25:28.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2022-08-11T21:52:21.000Z (over 2 years ago)
- Last Synced: 2024-09-16T16:35:26.224Z (3 months ago)
- Topics: docc, swift, swift-package-manager, swift-package-plugin
- Language: Swift
- Homepage:
- Size: 32.2 KB
- Stars: 12
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
***`package-catalog`***
`0.4.0`
[](https://swiftpackageindex.com/kelvin13/swift-package-catalog)
[](https://swiftpackageindex.com/kelvin13/swift-package-catalog)
`catalog` is a simple but powerful Swift Package Plugin for generating symbolgraphs, collecting snippets, and detecting DocC documentation resources in a project.
It’s like `swift-docc-plugin`, but it doesn’t actually build the documentation, it only generates and locates the resources required to build the documentation using the Swift Package Manager’s symbolgraph and project scanning capabilities.
`catalog` emits documentation metadata as JSON with a fairly straightforward format. Its output is designed to be easily transformed by downstream tooling that consumer, relocates, compresses, or otherwise post-processes this metadata.
as of v0.4.0, `swift-package-catalog` contains two tools:
1. `blame`
2. `catalog`
## getting started
`catalog` is a normal Swift Package Plugin, and you can use it (like any other plugin) by adding it to your `Package.swift` dependency list:
```swift
let package:Package = .init(name: "example", products: [],
dependencies:
[
.package(url: "https://github.com/kelvin13/swift-package-catalog", from: "0.4.0"),
],
targets: [])
```
## running `blame`
`blame` can be used to discover the direct consumers of a dependency. To use `blame`, pass it a list of target names:
```bash
$ swift package blame Atomics NIOCore
```
```text
direct consumers of Atomics:
0. NIOEmbedded (in 'swift-nio')
1. NIOPosix (in 'swift-nio')
direct consumers of NIOCore:
0. NIO (in 'swift-nio')
1. NIOEmbedded (in 'swift-nio')
2. NIOPosix (in 'swift-nio')
3. NIOSSL (in 'swift-nio-ssl')
4. NIOTLS (in 'swift-nio')
```
## running `catalog`
Running `catalog` with `swift package` will output all the documentation resources it managed to find, in JSON format. Behind the scenes, it will direct the SPM to generate the relevant symbolgraphs.
```
$ swift package catalog
Building for debugging...
Build complete! (0.08s)
Building for debugging...
Build complete! (0.07s)
[
{
"catalog_tools_version": 3,
"package": "swift-grammar",
"modules":
[
{
"module": "Grammar",
"dependencies": [],
"include":
[
".build/x86_64-unknown-linux-gnu/extracted-symbols/swift-grammar/Grammar"
]
}
],
"snippets":
[
]
},
{
"catalog_tools_version": 3,
"package": "swift-json",
"modules":
[
{
"module": "JSON",
"dependencies": [{"package": "swift-grammar", "modules": ["Grammar"]}],
"include":
[
".build/x86_64-unknown-linux-gnu/extracted-symbols/swift-json/JSON",
"Sources/JSON/JSON.docc"
]
}
],
"snippets":
[
{
"snippet": "LintingDictionary",
"dependencies":
[
{
"package": "swift-grammar",
"modules": ["Grammar"]
},
{
"package": "swift-json",
"modules": ["JSON"]
}
],
"sources":
[
"Snippets/LintingDictionary.swift"
]
},
{
"snippet": "BasicDecoding",
"dependencies":
[
{
"package": "swift-grammar",
"modules": ["Grammar"]
},
{
"package": "swift-json",
"modules": ["JSON"]
}
],
"sources":
[
"Snippets/BasicDecoding.swift"
]
}
]
}
]
```
> Note: Relative paths are shown for demonstration purposes. The `catalog` plugin actually emits absolute paths.
You can filter the modules `catalog` scans by passing them as positional arguments. The order does not matter.
```
$ swift package catalog JSON
Building for debugging...
Build complete! (0.07s)
[
{
"catalog_tools_version": 3,
"package": "swift-json",
"modules":
[
{
"module": "JSON",
"dependencies": [{"package": "swift-grammar", "modules": ["Grammar"]}],
"include":
[
".build/x86_64-unknown-linux-gnu/extracted-symbols/swift-json/JSON",
"sources/json.docc"
]
}
],
"snippets":
[
...
]
}
]
```
Snippets are not bound to any module, and will therefore always appear.
Target filtering is case-sensitive.
```
$ swift package catalog json
error: target 'json' is not a swift source module in this package
```
Note that multiple modules with the same name can occur in a dependency tree, as long as colliding modules are never combined into the same product. This means that the number of modules cataloged by this tool may be greater than the number of arguments passed to its invocation.