Library Product

WorkspaceConfiguration

The root API used in configuration files.

Declaration

.library(name: "WorkspaceConfiguration")

Overview

Workspace can be configured by placing a Swift file named Workspace.swift in the project root.

The contents of a configuration file might look something like this:

import WorkspaceConfiguration /* Exernal packages can be imported with this syntax: import [module] // [package], [url], [version], [product] */ import SDGControlFlow // SDGCornerstone, https://github.com/SDGGiesbrecht/SDGCornerstone, 0.10.0, SDGControlFlow let configuration = WorkspaceConfiguration() configuration.optIntoAllTasks() configuration.supportedPlatforms = [.macOS, .windows, .ubuntu, .android] configuration.documentation.currentVersion = Version(1, 0, 0) configuration.documentation.projectWebsite = URL(string: "project.uk") configuration.documentation.documentationURL = URL(string: "project.uk/Documentation") configuration.documentation.repositoryURL = URL(string: "https://github.com/User/Project") configuration.documentation.api.yearFirstPublished = 2017 configuration.documentation.localisations = ["🇬🇧EN", "🇺🇸EN", "🇨🇦EN", "fr", "es"] configuration.documentation.api.copyrightNotice = Lazy<[LocalisationIdentifier: StrictString]>( resolve: { configuration in return [ "🇬🇧EN": "Copyright #dates \(configuration.documentation.primaryAuthor!).", "🇺🇸EN": "Copyright #dates \(configuration.documentation.primaryAuthor!).", "🇨🇦EN": "Copyright #dates \(configuration.documentation.primaryAuthor!).", "fr": "Droit d’auteur #dates \(configuration.documentation.primaryAuthor!).", "es": "Derecho de autor #dates \(configuration.documentation.primaryAuthor!).", ] }) configuration.documentation.primaryAuthor = "John Doe"

Modules

WorkspaceConfiguration

The root API used in configuration files.

macOS CentOS Ubuntu Amazon Linux