SwiftLintFile

public final class SwiftLintFile : Sendable
extension SwiftLintFile: Equatable, Hashable

A unit of Swift source code, either on disk or in memory.

Show on GitHub

  • The underlying SourceKitten file.

    Declaration

    Swift

    public let file: File
    Show on GitHub
  • id

    The associated unique identifier for this file.

    Declaration

    Swift

    public let id: UUID
    Show on GitHub

  • Whether or not this is a file generated for testing purposes.

    Declaration

    Swift

    public let isTestFile: Bool
    Show on GitHub

  • A file is virtual if it is not backed by a filesystem path.

    Declaration

    Swift

    public let isVirtual: Bool
    Show on GitHub

  • Creates a SwiftLintFile with a SourceKitten File.

    Declaration

    Swift

    public init(file: File, isTestFile: Bool = false, isVirtual: Bool = false)

    Parameters

    file

    A file from SourceKitten.
    isTestFile

    Mark the file as being generated for testing purposes only.
    isVirtual

    Mark the file as virtual (in-memory).
    Show on GitHub

  • Creates a SwiftLintFile by specifying its path on disk. Fails if the file does not exist.

    Declaration

    Swift

    public convenience init?(path: String, isTestFile: Bool = false)

    Parameters

    path

    The path to a file on disk. Relative and absolute paths supported.
    isTestFile

    Mark the file as being generated for testing purposes only.
    Show on GitHub

  • Creates a SwiftLintFile by specifying its path on disk. Unlike the SwiftLintFile(path:) initializer, this one does not read its contents immediately, but rather traps at runtime when attempting to access its contents.

    Declaration

    Swift

    public convenience init(pathDeferringReading path: String)

    Parameters

    path

    The path to a file on disk. Relative and absolute paths supported.
    Show on GitHub

  • Creates a SwiftLintFile that is not backed by a file on disk by specifying its contents.

    Declaration

    Swift

    public convenience init(contents: String, isTestFile: Bool = false)

    Parameters

    contents

    The contents of the file.
    isTestFile

    Mark the file as being generated for testing purposes only.
    Show on GitHub

  • The path on disk for this file.

    Declaration

    Swift

    public var path: String? { get }
    Show on GitHub

  • The file’s contents.

    Declaration

    Swift

    public var contents: String { get }
    Show on GitHub

  • A string view into the contents of this file optimized for string manipulation operations.

    Declaration

    Swift

    public var stringView: StringView { get }
    Show on GitHub

  • The parsed lines for this file’s contents.

    Declaration

    Swift

    public var lines: [Line] { get }
    Show on GitHub

Hashable Conformance