print-api

KO | EN

gitlite — search

#react #llm #go #golang #machine-learning #rust #linux #awesome #cli #kubernetes #vue #awesome-list #security #mcp

(★ 20)

Dump the declarations of Haskell modules

print-api 최신버젼 다운로드

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

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# print-api

_(If you want to use this tool as a GitHub Workflow, check out [diff-package-api](https://github.com/Kleidukos/diff-package-api/))_

Taken from the GHC CI scripts, this tool prints a human-readable representation of the exposed interface of Haskell modules that you
can use in CI to ensure that you do not mistakenly introduce a regression.

## Installation

Binaries for the following operating systems and GHC are provided:

| GHC / OS | Ubuntu 22.04 (glibc) | Alpine 3.20 (musl) | macOS 14  |
|---|---|---|---|
| 9.12.2 | ✅ | ✅ | ✅ |
| 9.10.1 | ✅ | ✅ | ✅ |
| 9.8.4 | ✅ | ✅ | ✅ |
| 9.6.6 | ✅ | ✅ | ✅ |

### Releases

* [Pre-releases](https://github.com/Kleidukos/print-api/releases/tag/print-api-head) are provided if you need an urgent fix for a bug;
* [Official releases](https://github.com/Kleidukos/print-api/releases/latest) are available if you need stability and you don't urgently require the latest features.

If you have the [GitHub CLI](https://cli.github.com/) installed, (something like) the following does work:

```
$ gh release download --repo Kleidukos/print-api --pattern "print-api-*-$(uname -s)-$(uname -m).tar.gz" --output - | tar -x -z -C <INSTALL_DIRECTORY>
```

## Usage

Go in your project and build it with the GHC environment files enabled:

```
$ cabal build --write-ghc-environment-files=always
```

You need the appropriate `print-api-<GHC_VERSION>` in your `PATH`. That means,
if you did not obtain the executables from the GitHub Releases as described
above but build and installed `print-api` yourself, then you need to install it
for the GHC version you intend to use; For example:

```
$ git clone https://github.com/Kleidukos/print-api.git
$ cd print-api
$ cabal install --with-compiler ghc-<GHC_VERSION>
```

There is also an `install-for-ghcup-compilers.sh` script in the `print-api` repository that installs `print-api` for GHCs currently installed by GHCup.

Then run the `print-api` binary from within the source tree of your project:

```
$ print-api -p <my-package>
```

### Ignore list of modules

By passing the `--modules-ignore-list FILE` option to `print-api`, you can specify
a list of newline-delimited module names that will be ignored by `print-api`,
and shown as having been ignored in the output.

### Example

For instance in the [`text-display`](https://github.com/haskell-text/text-display) repository:

```haskell
❯ print-api -p text-display

module Data.Text.Display where
  type Display :: * -> Constraint
  class Display a where
    displayBuilder :: a -> Data.Text.Internal.Builder.Builder
    displayList :: [a] -> Data.Text.Internal.Builder.Builder
    displayPrec :: GHC.Types.Int -> a -> Data.Text.Internal.Builder.Builder
    {-# MINIMAL displayBuilder | displayPrec #-}
    {-# MINIMAL displayBuilder | displayPrec #-}
  type role OpaqueInstance phantom representational
```

print-api

print-api 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

print-api

print-api 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README