doctest-discover

KO | EN

gitlite — search

#python #hacktoberfest #ai #golang #go #android #machine-learning #rust #deep-learning #linux #cli #kubernetes #vue #mcp

doctest-discover

(★ 36)

Easy way to run doctests via cabal

doctest-discover 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# PROJECT NO LONGER MAINTAINED. MIGHT CONSIDER A REWRITE IN THE FUTURE

# doctest-discover [![build status](https://travis-ci.org/karun012/doctest-discover.png)](https://travis-ci.org/karun012/doctest-discover)

* Do you have to maintain a list of source files that cabal needs to use to run [doctests](https://hackage.haskell.org/package/doctest)?

doctest-discover (inspired by [hspec-discover](https://hackage.haskell.org/package/hspec-discover)) makes it easy to run doctests via [cabal](http://www.haskell.org/cabal/).

doctest-discover is published on [hackage](https://hackage.haskell.org/package/doctest-discover)

The only thing you need to do is create a driver file with one line (let's call it *doctest-driver.hs*):

```haskell
{-# OPTIONS_GHC -F -pgmF doctest-discover #-}
```

Use it as the main for the test-suite in your cabal file: 
```cabal
test-suite cooler-doctests
  default-language:   Haskell2010
  type:               exitcode-stdio-1.0
  ghc-options:        -threaded
  main-is:            doctest-driver.hs
  build-depends:      base >4 && <5, doctest, doctest-discover
  HS-Source-Dirs:     test
```

doctest-discover is used as a pre-processor. Since there is nothing to pre-process in the file, it builds a temporary file with the code needed to run doctests via cabal.

## Configuration
Configuration has to be specified in a json file. Make sure you put the config file in the root directory of your project.

To use a config file, change your driver to add the config file name with the -optF flag.
```haskell
{-# OPTIONS_GHC -F -pgmF doctest-discover -optF config.json #-}
```

### Ignoring files
```json
{
    "ignore": ["foo.hs", "bar.hs", "baz.hs"]
}
```

### Source folders
```json
{
    "ignore": ["foo.hs", "bar.hs", "baz.hs"],
    "sourceFolders": ["src", "src/foobar", "someOtherSource"]
}
```

## Contributors
[Richard Cook](https://github.com/rcook)

doctest-discover

doctest-discover 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

doctest-discover

doctest-discover 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README