feat: Adding documentation comments.
All checks were successful
CI / Run Tests (push) Successful in 2m28s
All checks were successful
CI / Run Tests (push) Successful in 2m28s
This commit is contained in:
@@ -4,9 +4,8 @@ import Dependencies
|
||||
import DependenciesMacros
|
||||
import FileClient
|
||||
|
||||
// TODO: Add edit / view routes, possibly create?
|
||||
|
||||
public extension DependencyValues {
|
||||
/// Manages interactions with `ansible-vault` command line application.
|
||||
var vaultClient: VaultClient {
|
||||
get { self[VaultClient.self] }
|
||||
set { self[VaultClient.self] = newValue }
|
||||
@@ -15,23 +14,41 @@ public extension DependencyValues {
|
||||
|
||||
@DependencyClient
|
||||
public struct VaultClient: Sendable {
|
||||
/// Run an `ansible-vault` command.
|
||||
public var run: Run
|
||||
|
||||
@DependencyClient
|
||||
public struct Run: Sendable {
|
||||
/// Decrypt an `ansible-vault` file.
|
||||
public var decrypt: @Sendable (RunOptions) async throws -> String
|
||||
/// Encrypt an `ansible-vault` file.
|
||||
public var encrypt: @Sendable (RunOptions) async throws -> String
|
||||
}
|
||||
|
||||
public struct RunOptions: Equatable, Sendable {
|
||||
|
||||
public let extraOptions: [String]?
|
||||
public let loggingOptions: LoggingOptions
|
||||
public let outputFilePath: String?
|
||||
public let quiet: Bool
|
||||
public let shell: String?
|
||||
public let vaultFilePath: String?
|
||||
/// Extra arguments / options passed to the `ansible-vault` command.
|
||||
let extraOptions: [String]?
|
||||
/// Logging options to use while running the command.
|
||||
let loggingOptions: LoggingOptions
|
||||
/// The optional output file path.
|
||||
let outputFilePath: String?
|
||||
/// Disable logging output.
|
||||
let quiet: Bool
|
||||
/// Optional shell used to call the command.
|
||||
let shell: String?
|
||||
/// The path to the vault file, if not supplied we will search the current directory for it.
|
||||
let vaultFilePath: String?
|
||||
|
||||
/// Create new run options.
|
||||
///
|
||||
/// - Parameters:
|
||||
/// - extraOptions: Extra arguments / options passed to the command.
|
||||
/// - loggingOptions: The logging options used while running the command.
|
||||
/// - outputFilePath: The optional output file path.
|
||||
/// - quiet: Disable logging output of the command.
|
||||
/// - shell: The shell used to call the command.
|
||||
/// - vaultFilePath: The vault file, if not supplied we will search in the current working directory.
|
||||
public init(
|
||||
extraOptions: [String]? = nil,
|
||||
loggingOptions: LoggingOptions,
|
||||
|
||||
Reference in New Issue
Block a user