import WorkspaceConfiguration .product(name: "WorkspaceConfiguration", package: "Workspace")
Enumeration

ProofreadingRule

A proofreading rule.

Declaration

enum ProofreadingRule

Cases

accessControl

Requires access control on every symbol in libraries and prohibits it in executables and tests.

bullets

Requires Markdown lists to use ASCII bullets and not asterisks or plus signs.

classFinality

Requires public classes to be open, final or explicitly exempt.

closureSignaturePosition

Requires closure signatures to be on the same line as the closure’s opening brace.

compatibilityCharacters

Prohibits compatiblity characters.

deprecatedTestManifests

Catches deprecated test manifests.

listSeparation

Requires that list separators such as commas only appear between list elements and never dangling at the end.

manualWarnings

Catches generic manual warnings.

markdownHeadings

Requires Markdown headings to use number signs.

marks

Catches broken syntax in source code headings.

missingImplementation

Catches unimplemented code paths marked with SDGCornerstone functions.

parameterGrouping

Requires documented parameters to be grouped.

syntaxColouring

Requires Markdown code blocks to specify a language.

unicode

Prohibits typewriter workarounds when proper Unicode characters are available.

workaroundReminders

Catches outdated workaround reminders.

Nested Types

Category

A category of proofreading rule.

Type Properties

Properties

category

The category the rule belongs to.

CaseIterable

AllCases where AllCases.Element == Self
allCases

Codable

String

macOS CentOS Ubuntu Amazon Linux