Xrefcheck.Scan

Generalised repo scanner and analyser.

Documentation

type ExclusionConfig = ExclusionConfig' Identity

Type alias for ExclusionConfig' with all required fields.

data ExclusionConfig' f

Config of repositry exclusions.

Constructors

ExclusionConfig

Fields

• ecIgnore :: Field f [CanonicalRelGlobPattern]

  Files which we completely ignore.

• ecIgnoreLocalRefsTo :: Field f [CanonicalRelGlobPattern]

  Files references to which we do not verify.

• ecIgnoreRefsFrom :: Field f [CanonicalRelGlobPattern]

  Files, references in which we should not analyze.

• ecIgnoreExternalRefsTo :: Field f [Regex]

  Regular expressions that match external references we should not verify.

Instances

FromJSON ExclusionConfig

Defined in Xrefcheck.Scan

Methods

parseJSON :: Value -> Parser ExclusionConfig

parseJSONList :: Value -> Parser [ExclusionConfig]

omittedField :: Maybe ExclusionConfig

FromJSON (ExclusionConfig' Maybe)

Defined in Xrefcheck.Scan

Methods

parseJSON :: Value -> Parser (ExclusionConfig' Maybe)

parseJSONList :: Value -> Parser [ExclusionConfig' Maybe]

omittedField :: Maybe (ExclusionConfig' Maybe)

Generic (ExclusionConfig' f)

Defined in Xrefcheck.Scan

Associated Types

type Rep (ExclusionConfig' f) :: Type -> Type

Methods

from :: ExclusionConfig' f -> Rep (ExclusionConfig' f) x

to :: Rep (ExclusionConfig' f) x -> ExclusionConfig' f

type Rep (ExclusionConfig' f)

Defined in Xrefcheck.Scan

type Rep (ExclusionConfig' f) = D1 ('MetaData "ExclusionConfig'" "Xrefcheck.Scan" "xrefcheck-0.3.0-GeqFdwqv2mJ31qwgW3PUq5" 'False) (C1 ('MetaCons "ExclusionConfig" 'PrefixI 'True) ((S1 ('MetaSel ('Just "ecIgnore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Field f [CanonicalRelGlobPattern])) :*: S1 ('MetaSel ('Just "ecIgnoreLocalRefsTo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Field f [CanonicalRelGlobPattern]))) :*: (S1 ('MetaSel ('Just "ecIgnoreRefsFrom") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Field f [CanonicalRelGlobPattern])) :*: S1 ('MetaSel ('Just "ecIgnoreExternalRefsTo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Field f [Regex])))))

type FileSupport = IsSymlink -> Extension -> Maybe ScanAction

All supported ways to parse a file.

data ReadDirectoryMode

Constructors

RdmTracked

Consider files tracked by Git, obtained from "git ls-files"

RdmUntracked

Consider files that are not tracked nor ignored by Git, obtained from "git ls-files --others --exclude-standard"

RdmBothTrackedAndUtracked

Combine output from commands listed above, so we consider all files except ones that are explicitly ignored by Git

type ScanAction = FilePath -> RelPosixLink -> IO (FileInfo, [ScanError 'Parse])

Way to parse a file.

data ScanError (a :: ScanStage)

A scan error indexed by different process stages.

Within Parse, seFile has no information because the same file is being parsed.

Within Gather, seFile stores the FilePath corresponding to the file in where the error was found.

Constructors

ScanError

Fields

• seFile :: ScanStageFile a
• sePosition :: Position
• seDescription :: ScanErrorDescription

Instances

Show (ScanError 'Gather)

Defined in Xrefcheck.Scan

Methods

showsPrec :: Int -> ScanError 'Gather -> ShowS

show :: ScanError 'Gather -> String

showList :: [ScanError 'Gather] -> ShowS

Show (ScanError 'Parse)

Defined in Xrefcheck.Scan

Methods

showsPrec :: Int -> ScanError 'Parse -> ShowS

show :: ScanError 'Parse -> String

showList :: [ScanError 'Parse] -> ShowS

Eq (ScanError 'Gather)

Defined in Xrefcheck.Scan

Methods

(==) :: ScanError 'Gather -> ScanError 'Gather -> Bool

(/=) :: ScanError 'Gather -> ScanError 'Gather -> Bool

Eq (ScanError 'Parse)

Defined in Xrefcheck.Scan

Methods

(==) :: ScanError 'Parse -> ScanError 'Parse -> Bool

(/=) :: ScanError 'Parse -> ScanError 'Parse -> Bool

data ScanErrorDescription

Constructors

LinkErr

FileErr

ParagraphErr Text

UnrecognisedErr Text

Instances

Show ScanErrorDescription

Defined in Xrefcheck.Scan

Methods

showsPrec :: Int -> ScanErrorDescription -> ShowS

show :: ScanErrorDescription -> String

showList :: [ScanErrorDescription] -> ShowS

Buildable ScanErrorDescription

Defined in Xrefcheck.Scan

Methods

build :: ScanErrorDescription -> Builder

Eq ScanErrorDescription

Defined in Xrefcheck.Scan

Methods

(==) :: ScanErrorDescription -> ScanErrorDescription -> Bool

(/=) :: ScanErrorDescription -> ScanErrorDescription -> Bool

data ScanResult

Constructors

ScanResult

Fields

• srScanErrors :: [ScanError 'Gather]
• srRepoInfo :: RepoInfo

data ScanStage

Constructors

Parse

Gather

defaultCompOption :: CompOption

defaultExecOption :: ExecOption

ecIgnoreL :: forall f. Lens' (ExclusionConfig' f) (Field f [CanonicalRelGlobPattern])

ecIgnoreLocalRefsToL :: forall f. Lens' (ExclusionConfig' f) (Field f [CanonicalRelGlobPattern])

ecIgnoreRefsFromL :: forall f. Lens' (ExclusionConfig' f) (Field f [CanonicalRelGlobPattern])

ecIgnoreExternalRefsToL :: forall f. Lens' (ExclusionConfig' f) (Field f [Regex])

firstFileSupport :: [FileSupport] -> FileSupport

mkGatherScanError :: RelPosixLink -> ScanError 'Parse -> ScanError 'Gather

Promote a ScanError from the Parse stage to the Gather stage.

mkParseScanError :: Position -> ScanErrorDescription -> ScanError 'Parse

Make a ScanError for the Parse stage.

reportScanErrs :: Given ColorMode => NonEmpty (ScanError 'Gather) -> IO ()

scanRepo :: MonadIO m => ScanPolicy -> Rewrite -> FileSupport -> ExclusionConfig -> FilePath -> m ScanResult

Orphan instances

FromJSON Regex

Methods

parseJSON :: Value -> Parser Regex

parseJSONList :: Value -> Parser [Regex]

omittedField :: Maybe Regex