Cabal-3.10.1.0: A framework for packaging Haskell software

Copyright | Lennart Kolmodin 2008
License | BSD3
Maintainer | cabal-devel@haskell.org
Portability | portable
Safe Haskell | Safe-Inferred
Language | Haskell2010

Distribution.PackageDescription.Check

Contents

- Package Checking
  - Checking package contents

Description

This has code for checking for various problems in packages. There is one set of checks that just looks at a `PackageDescription` in isolation and another set of checks that also looks at files in the package. Some of the checks are basic sanity checks, others are portability standards that we'd like to encourage. There is a `PackageCheck` type that distinguishes the different kinds of checks so we can see which ones are appropriate to report in different situations. This code gets used when configuring a package when we consider only basic problems. The higher standard is used when preparing a source tarball and by Hackage when uploading new packages. The reason for this is that we want to hold packages that are expected to be distributed to a higher standard than packages that are only ever expected to be used on the author's own environment.

Synopsis

- data CheckExplanation
  - = ParseWarning FilePath PWarning
  - | NoNameField
  - | NoVersionField
  - | NoTarget
  - | UnnamedInternal
  - | DuplicateSections [UnqualComponentName]
  - | IllegalLibraryName PackageDescription
  - | NoModulesExposed Library
  - | SignaturesCabal2
  - | AutogenNotExposed
  - | AutogenIncludesNotIncluded
  - | NoMainIs Executable
  - | NoHsLhsMain
  - | MainCCabal1_18
  - | AutogenNoOther CEType UnqualComponentName
  - | AutogenIncludesNotIncludedExe
  - | TestsuiteTypeNotKnown TestType
  - | TestsuiteNotSupported TestType
  - | BenchmarkTypeNotKnown BenchmarkType
  - | BenchmarkNotSupported BenchmarkType
  - | NoHsLhsMainBench
  - | InvalidNameWin PackageDescription
  - | ZPrefix
  - | NoBuildType
  - | NoCustomSetup
  - | UnknownCompilers [String]
  - | UnknownLanguages [String]
  - | UnknownExtensions [String]
  - | LanguagesAsExtension [String]
  - | DeprecatedExtensions [(Extension, Maybe Extension)]
  - | MissingField CEField
  - | SynopsisTooLong
  - | ShortDesc
  - | InvalidTestWith [Dependency]
  - | ImpossibleInternalDep [Dependency]
  - | ImpossibleInternalExe [ExeDependency]
  - | MissingInternalExe [ExeDependency]
  - | NONELicense
  - | NoLicense
  - | AllRightsReservedLicense
  - | LicenseMessParse PackageDescription
  - | UnrecognisedLicense String
  - | UncommonBSD4
  - | UnknownLicenseVersion License [Version]
  - | NoLicenseFile
  - | UnrecognisedSourceRepo String
  - | MissingType
  - | MissingLocation
  - | MissingModule
  - | MissingTag
  - | SubdirRelPath
  - | SubdirGoodRelPath String
  - | OptFasm String
  - | OptViaC String
  - | OptHpc String
  - | OptProf String
  - | OptO String
  - | OptHide String
  - | OptMake String
  - | OptONot String
  - | OptOOne String
  - | OptOTwo String
  - | OptSplitSections String
  - | OptSplitObjs String
  - | OptWls String
  - | OptExts String
  - | OptRts String
  - | OptWithRts String
  - | COptONumber String String
  - | COptCPP String
  - | OptAlternatives String String [(String, String)]
  - | RelativeOutside String FilePath
  - | AbsolutePath String FilePath
  - | BadRelativePAth String FilePath String
  - | DistPoint (Maybe String) FilePath
  - | GlobSyntaxError String String
  - | RecursiveGlobInRoot String FilePath
  - | InvalidOnWin [FilePath]
  - | FilePathTooLong FilePath
  - | FilePathNameTooLong FilePath
  - | FilePathSplitTooLong FilePath
  - | FilePathEmpty
  - | CVTestSuite
  - | CVDefaultLanguage
  - | CVDefaultLanguageComponent
  - | CVExtraDocFiles
  - | CVMultiLib
  - | CVReexported
  - | CVMixins
  - | CVExtraFrameworkDirs
  - | CVDefaultExtensions
  - | CVExtensionsDeprecated
  - | CVSources
  - | CVExtraDynamic [[String]]
  - | CVVirtualModules
  - | CVSourceRepository
  - | CVExtensions CabalSpecVersion [Extension]
  - | CVCustomSetup
  - | CVExpliticDepsCustomSetup
  - | CVAutogenPaths
  - | CVAutogenPackageInfo
  - | GlobNoMatch String String
  - | GlobExactMatch String String FilePath
  - | GlobNoDir String String FilePath
  - | UnknownOS [String]
  - | UnknownArch [String]
  - | UnknownCompiler [String]
  - | BaseNoUpperBounds
  - | MissingUpperBounds [PackageName]
  - | SuspiciousFlagName [String]
  - | DeclaredUsedFlags (Set FlagName) (Set FlagName)
  - | NonASCIICustomField [String]
  - | RebindableClashPaths
  - | RebindableClashPackageInfo
  - | WErrorUnneeded String
  - | JUnneeded String
  - | FDeferTypeErrorsUnneeded String
  - | DynamicUnneeded String
  - | ProfilingUnneeded String
  - | UpperBoundSetup String
  - | DuplicateModule String [ModuleName]
  - | PotentialDupModule String [ModuleName]
  - | BOMStart FilePath
  - | NotPackageName FilePath String
  - | NoDesc
  - | MultiDesc [String]
  - | UnknownFile String (SymbolicPath PackageDir LicenseFile)
  - | MissingSetupFile
  - | MissingConfigureScript
  - | UnknownDirectory String FilePath
  - | MissingSourceControl
  - | MissingExpectedDocFiles Bool [FilePath]
  - | WrongFieldForExpectedDocFiles Bool String [FilePath]
- data PackageCheck
  - = PackageBuildImpossible {
    - explanation :: CheckExplanation
    }
  - | PackageBuildWarning {
    - explanation :: CheckExplanation
    }
  - | PackageDistSuspicious {
    - explanation :: CheckExplanation
    }
  - | PackageDistSuspiciousWarn {
    - explanation :: CheckExplanation
    }
  - | PackageDistInexcusable {
    - explanation :: CheckExplanation
    }
- checkPackage :: GenericPackageDescription -> Maybe PackageDescription -> [PackageCheck]
- checkConfiguredPackage :: PackageDescription -> [PackageCheck]
- wrapParseWarning :: FilePath -> PWarning -> PackageCheck
- ppPackageCheck :: PackageCheck -> String
- checkPackageFiles :: Verbosity -> PackageDescription -> FilePath -> IO [PackageCheck]
- checkPackageContent :: (Monad m, Applicative m) => CheckPackageContentOps m -> PackageDescription -> m [PackageCheck]
- data CheckPackageContentOps m = CheckPackageContentOps {
  - doesFileExist :: FilePath -> m Bool
  - doesDirectoryExist :: FilePath -> m Bool
  - getDirectoryContents :: FilePath -> m [FilePath]
  - getFileContents :: FilePath -> m ByteString
  }
- checkPackageFileNames :: [FilePath] -> [PackageCheck]

# Package Checking

data CheckExplanation Source #

Explanations of `PackageCheck`'s errors/warnings.

Constructors

ParseWarning FilePath PWarning |
NoNameField |
NoVersionField |
NoTarget |
UnnamedInternal |
DuplicateSections [UnqualComponentName] |
IllegalLibraryName PackageDescription |
NoModulesExposed Library |
SignaturesCabal2 |
AutogenNotExposed |
AutogenIncludesNotIncluded |
NoMainIs Executable |
NoHsLhsMain |
MainCCabal1_18 |
AutogenNoOther CEType UnqualComponentName |
AutogenIncludesNotIncludedExe |
TestsuiteTypeNotKnown TestType |
TestsuiteNotSupported TestType |
BenchmarkTypeNotKnown BenchmarkType |
BenchmarkNotSupported BenchmarkType |
NoHsLhsMainBench |
InvalidNameWin PackageDescription |
ZPrefix |
NoBuildType |
NoCustomSetup |
UnknownCompilers [String] |
UnknownLanguages [String] |
UnknownExtensions [String] |
LanguagesAsExtension [String] |
DeprecatedExtensions [(Extension, Maybe Extension)] |
MissingField CEField |
SynopsisTooLong |
ShortDesc |
InvalidTestWith [Dependency] |
ImpossibleInternalDep [Dependency] |
ImpossibleInternalExe [ExeDependency] |
MissingInternalExe [ExeDependency] |
NONELicense |
NoLicense |
AllRightsReservedLicense |
LicenseMessParse PackageDescription |
UnrecognisedLicense String |
UncommonBSD4 |
UnknownLicenseVersion License [Version] |
NoLicenseFile |
UnrecognisedSourceRepo String |
MissingType |
MissingLocation |
MissingModule |
MissingTag |
SubdirRelPath |
SubdirGoodRelPath String |
OptFasm String |
OptViaC String |
OptHpc String |
OptProf String |
OptO String |
OptHide String |
OptMake String |
OptONot String |
OptOOne String |
OptOTwo String |
OptSplitSections String |
OptSplitObjs String |
OptWls String |
OptExts String |
OptRts String |
OptWithRts String |
COptONumber String String |
COptCPP String |
OptAlternatives String String [(String, String)] |
RelativeOutside String FilePath |
AbsolutePath String FilePath |
BadRelativePAth String FilePath String |
DistPoint (Maybe String) FilePath |
GlobSyntaxError String String |
RecursiveGlobInRoot String FilePath |
InvalidOnWin [FilePath] |
FilePathTooLong FilePath |
FilePathNameTooLong FilePath |
FilePathSplitTooLong FilePath |
FilePathEmpty |
CVTestSuite |
CVDefaultLanguage |
CVDefaultLanguageComponent |
CVExtraDocFiles |
CVMultiLib |
CVReexported |
CVMixins |
CVExtraFrameworkDirs |
CVDefaultExtensions |
CVExtensionsDeprecated |
CVSources |
CVExtraDynamic [[String]] |
CVVirtualModules |
CVSourceRepository |
CVExtensions CabalSpecVersion [Extension] |
CVCustomSetup |
CVExpliticDepsCustomSetup |
CVAutogenPaths |
CVAutogenPackageInfo |
GlobNoMatch String String |
GlobExactMatch String String FilePath |
GlobNoDir String String FilePath |
UnknownOS [String] |
UnknownArch [String] |
UnknownCompiler [String] |
BaseNoUpperBounds |
MissingUpperBounds [PackageName] |
SuspiciousFlagName [String] |
DeclaredUsedFlags (Set FlagName) (Set FlagName) |
NonASCIICustomField [String] |
RebindableClashPaths |
RebindableClashPackageInfo |
WErrorUnneeded String |
JUnneeded String |
FDeferTypeErrorsUnneeded String |
DynamicUnneeded String |
ProfilingUnneeded String |
UpperBoundSetup String |
DuplicateModule String [ModuleName] |
PotentialDupModule String [ModuleName] |
BOMStart FilePath |
NotPackageName FilePath String |
NoDesc |
MultiDesc [String] |
UnknownFile String (SymbolicPath PackageDir LicenseFile) |
MissingSetupFile |
MissingConfigureScript |
UnknownDirectory String FilePath |
MissingSourceControl |
MissingExpectedDocFiles Bool [FilePath] |
WrongFieldForExpectedDocFiles Bool String [FilePath] |

#### Instances

Instances details

Show CheckExplanation Source # |
Instance details Defined in Distribution.PackageDescription.Check Methods showsPrec :: Int -> CheckExplanation -> ShowS Source # show :: CheckExplanation -> String Source # showList :: [CheckExplanation] -> ShowS Source #
Eq CheckExplanation Source # |
Instance details Defined in Distribution.PackageDescription.Check Methods (==) :: CheckExplanation -> CheckExplanation -> Bool # (/=) :: CheckExplanation -> CheckExplanation -> Bool #
Ord CheckExplanation Source # |

Instance details

Defined in Distribution.PackageDescription.Check

Methods

compare :: CheckExplanation -> CheckExplanation -> Ordering #

(<) :: CheckExplanation -> CheckExplanation -> Bool #

(<=) :: CheckExplanation -> CheckExplanation -> Bool #

(>) :: CheckExplanation -> CheckExplanation -> Bool #

(>=) :: CheckExplanation -> CheckExplanation -> Bool #

max :: CheckExplanation -> CheckExplanation -> CheckExplanation #

min :: CheckExplanation -> CheckExplanation -> CheckExplanation #

data PackageCheck Source #

Results of some kind of failed package check.

There are a range of severities, from merely dubious to totally insane. All of them come with a human readable explanation. In future we may augment them with more machine readable explanations, for example to help an IDE suggest automatic corrections.

Constructors

PackageBuildImpossible | This package description is no good. There's no way it's going to build sensibly. This should give an error at configure time.

Fields

- explanation :: CheckExplanation

PackageBuildWarning | A problem that is likely to affect building the package, or an issue that we'd like every package author to be aware of, even if the package is never distributed.

Fields

- explanation :: CheckExplanation

PackageDistSuspicious | An issue that might not be a problem for the package author but might be annoying or detrimental when the package is distributed to users. We should encourage distributed packages to be free from these issues, but occasionally there are justifiable reasons so we cannot ban them entirely.

Fields

- explanation :: CheckExplanation

PackageDistSuspiciousWarn | Like PackageDistSuspicious but will only display warnings rather than causing abnormal exit when you run 'cabal check'.

Fields

- explanation :: CheckExplanation

PackageDistInexcusable | An issue that is OK in the author's environment but is almost certain to be a portability problem for other environments. We can quite legitimately refuse to publicly distribute packages with these problems.

Fields

- explanation :: CheckExplanation

#### Instances

Instances details

Show PackageCheck Source # |
Instance details Defined in Distribution.PackageDescription.Check Methods showsPrec :: Int -> PackageCheck -> ShowS Source # show :: PackageCheck -> String Source # showList :: [PackageCheck] -> ShowS Source #
Eq PackageCheck Source # |
Instance details Defined in Distribution.PackageDescription.Check Methods (==) :: PackageCheck -> PackageCheck -> Bool # (/=) :: PackageCheck -> PackageCheck -> Bool #
Ord PackageCheck Source # |

Instance details

Defined in Distribution.PackageDescription.Check

Methods

compare :: PackageCheck -> PackageCheck -> Ordering #

(<) :: PackageCheck -> PackageCheck -> Bool #

(<=) :: PackageCheck -> PackageCheck -> Bool #

(>) :: PackageCheck -> PackageCheck -> Bool #

(>=) :: PackageCheck -> PackageCheck -> Bool #

max :: PackageCheck -> PackageCheck -> PackageCheck #

min :: PackageCheck -> PackageCheck -> PackageCheck #

checkPackage :: GenericPackageDescription -> Maybe PackageDescription -> [PackageCheck] Source #

Check for common mistakes and problems in package descriptions.

This is the standard collection of checks covering all aspects except for checks that require looking at files within the package. For those see `checkPackageFiles`.

It requires the `GenericPackageDescription` and optionally a particular configuration of that package. If you pass `Nothing` then we just check a version of the generic description using `flattenPackageDescription`.

checkConfiguredPackage :: PackageDescription -> [PackageCheck] Source #

wrapParseWarning :: FilePath -> PWarning -> PackageCheck Source #

Wraps `ParseWarning` into `PackageCheck`.

ppPackageCheck :: PackageCheck -> String Source #

Pretty printing `PackageCheck`.

## Checking package contents

checkPackageFiles :: Verbosity -> PackageDescription -> FilePath -> IO [PackageCheck] Source #

Sanity check things that requires IO. It looks at the files in the package and expects to find the package unpacked in at the given file path.

checkPackageContent :: (Monad m, Applicative m) => CheckPackageContentOps m -> PackageDescription -> m [PackageCheck] Source #

Sanity check things that requires looking at files in the package. This is a generalised version of `checkPackageFiles` that can work in any monad for which you can provide `CheckPackageContentOps` operations.

The point of this extra generality is to allow doing checks in some virtual file system, for example a tarball in memory.

data CheckPackageContentOps m Source #

A record of operations needed to check the contents of packages. Used by `checkPackageContent`.

Constructors

CheckPackageContentOps |

Fields

- doesFileExist :: FilePath -> m Bool
- doesDirectoryExist :: FilePath -> m Bool
- getDirectoryContents :: FilePath -> m [FilePath]
- getFileContents :: FilePath -> m ByteString

checkPackageFileNames :: [FilePath] -> [PackageCheck] Source #

Check the names of all files in a package for portability problems. This should be done for example when creating or validating a package tarball.