Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sdiehl/cabal-edit

A utility for managing Hackage dependencies and manipulating Cabal files from the command line.
https://github.com/sdiehl/cabal-edit

cabal cabal-install cli

Last synced: 1 day ago
JSON representation

A utility for managing Hackage dependencies and manipulating Cabal files from the command line.

Awesome Lists containing this project

README 

        
cabal-edit

==========



![Cabal CI](https://github.com/sdiehl/cabal-edit/workflows/Cabal%20CI/badge.svg)

![Stack CI](https://github.com/sdiehl/cabal-edit/workflows/Stack%20CI/badge.svg)



This is an extension to Haskell's package manager Cabal to allow you to add,

remove, and upgrade dependencies by modifying your cabal file from the

command line. This behaves similar to  `install --save` commands in other

package managers.



* [`cabal-edit add`](#add)

* [`cabal-edit upgrade`](#upgrade)

* [`cabal-edit upgradeall`](#upgradeall)

* [`cabal-edit remove`](#remove)

* [`cabal-edit list`](#list)

* [`cabal-edit format`](#format)

* [`cabal-edit extensions`](#extensions)

* [`cabal-edit lint`](#lint)

* [`cabal-edit latest`](#latest)

* [`cabal-edit rebuild`](#rebuild)



Usage

-----



### add



For example to setup a new project one often wants to add common dependencies

like `text` and `aeson`. We can use `cabal-edit` to automatically append these

to our dependency list and deduce the latest versions from Hackage.



```bash

$ cabal init --lib --cabal-version=3.0    



$ cabal-edit add aeson                

Adding dependency: aeson ^>=1.5 to sample.cabal



$ cabal-edit add text 

Adding dependency: text ^>=1.2 to sample.cabal

```



If we want to depend on a specific version of `aeson`, we can pass this

explicitly as an argument.



```bash

$ cabal-edit add aeson==1.4.0.0

```



Multiple packages can be passed to the add command at once. For example:



```bash

$ cabal-edit add base bytestring aeson text process filepath directory mtl transformers protolude

Adding latest dependency: base ^>=4.14 to sample.cabal

Adding latest dependency: bytestring ^>=0.10 to sample.cabal

Adding latest dependency: aeson ^>=1.5 to sample.cabal

Adding latest dependency: text ^>=1.2 to sample.cabal

Adding latest dependency: process ^>=1.6 to sample.cabal

Adding latest dependency: filepath ^>=1.4 to sample.cabal

Adding latest dependency: directory ^>=1.3 to sample.cabal

Adding latest dependency: mtl ^>=2.2 to sample.cabal

Adding latest dependency: transformers ^>=0.5 to sample.cabal

Adding latest dependency: protolude ^>=0.3 to sample.cabal

```



*Note: Dependency modification will happen over the library stanza of your Cabal

file, and not the executable sections.*



### upgrade



The upgrade command can be used to safely manipulate the version bounds for a

given library. For instance if one has a simple dependency on `text` for `1.0`

version range, like as follows:



```haskell

library

    exposed-modules:  MyLib

    default-language: Haskell2010

    build-depends:

        base >= 4.14 && <=5.0,

        text ^>= 1.0

```



We can bump the bound of this library to upgrade it to allow the latest version

from Hackage. We simply pass the `upgrade` command the name of the package (i.e.

`text`) and it will automatically figure out the appropriate version range for

the upgrade including previously version ranges. The resulting version ranges

will always have an upper bound and will conform to Hackage PVP standards.



```bash

$ cabal-edit upgrade text

Upgrading bounds for text to 1.3

```



This will produce the following modified Cabal file.



```haskell

library

    exposed-modules:  MyLib

    default-language: Haskell2010

    build-depends:

        base >=4.14 && <=5.0,

        text >=1.0 && <=1.3

```



### upgradeall



`upgradeall` behaves like `upgrade` but performs the version bound bump for all

available dependencies. This sets the upper bounds for all dependencies to the

latest available version on Hackage.



```bash

$ cabal-edit upgradeall

Upgrading bounds for Cabal to 3.3

Upgrading bounds for aeson to 1.6

Upgrading bounds for base to 4.15

Upgrading bounds for bytestring to 0.11

Upgrading bounds for ghc to 8.11

Upgrading bounds for text to 1.3

```



### remove



Remove will remove a given dependency from the file completely.



```

$ cabal-edit remove microlens

Removing depndency on microlens

```



### list



The Hackage database can be queried from the command line to search for all

available versions to use with the `list` command.



```bash

$ cabal-edit list filepath

1.0

1.1.0.0

1.1.0.1

1.1.0.2

1.1.0.3

1.1.0.4

1.2.0.0

1.2.0.1

1.3.0.0

1.3.0.1

1.3.0.2

1.4.0.0

1.4.1.0

1.4.1.1

1.4.1.2

1.4.2

1.4.2.1

```



### format



The `format` command will canonicalise the Cabal into by parsing it and running

it through the pretty printer again.



```bash

$ cabal-edit format

Formatting: sample.cabal

```



### extensions



The `extensions` command will enumerate all the default extensions enabled for

the given library. This is useful if you wish to add these headers to files

within the project.



```bash

$ cabal-edit extensions



{-# LANGUAGE LambdaCase #-}

{-# LANGUAGE BlockArguments #-}

{-# LANGUAGE RecordWildCards #-}

{-# LANGUAGE NoImplicitPrelude #-}

{-# LANGUAGE FlexibleContexts #-}

{-# LANGUAGE FlexibleInstances #-}

{-# LANGUAGE OverloadedStrings #-}

{-# LANGUAGE RankNTypes #-}

{-# LANGUAGE ScopedTypeVariables #-}

```



### lint



The `lint` command will detect common problems with your version bounds and

recommend package upgrades when available.



```bash

$ cabal-edit lint 

aeson : Consider upgrading major bound to latest version 1.6

text : Consider upgrading major bound to latest version 1.3

```



### latest



The `latest` command will return the dependency string for adding the latest

version of a given package.



```bash

$ cabal-edit latest aeson

aeson ^>=1.5

```



### rebuild



cabal-edit uses a cache of Hackage package versions internally. This is normally

built on first run and whenever the package database is older than 30 days. If

you wish to manually rebuild it after running `cabal update` then run:



```

$ cabal-edit rebuild

Done.

```



Installation

------------



Download this repository.



```bash

$ git clone [email protected]:sdiehl/cabal-edit.git

$ cd cabal-edit

```



Then install either with Stack, Cabal or Nix.



```bash

$ stack install 

$ cabal install --installdir=/home/$USER/.local/bin

$ nix-build -A cabal-edit

```



*Note: This library links directly against Cabal, so you must be using the same

version of Cabal you intend to compile your package against. It is reccomened to

use Cabal > 3.0 to support modern versioning schemes.*



Shell Completions

------------------



We can tab complete on the Hackage package index we install the local

completions for you shell. Run one of the following commands to generate the

shell completer appropriate to your shell. Then add the output to one of

`~/.zshrc`, `~/.bashrc` or `~/.config/fish/config.fish`.



```bash

$ cabal-edit --zsh-completion-script cabal-edit

$ cabal-edit --bash-completion-script cabal-edit

$ cabal-edit --fish-completion-script cabal-edit

```



This will completion against the Hackage database prefixed by name.



```

$ cabal-edit add gh

zsh: do you wish to see all 103 possibilities (15 lines)?

$ cabal-edit add ghc-pa

ghc-parmake  ghc-parser   ghc-paths

```



**bash**



```bash

_cabal-edit()

{

    local CMDLINE

    local IFS=$'\n'

    CMDLINE=(--bash-completion-index $COMP_CWORD)



    for arg in ${COMP_WORDS[@]}; do

        CMDLINE=(${CMDLINE[@]} --bash-completion-word $arg)

    done



    COMPREPLY=( $(cabal-edit "${CMDLINE[@]}") )

}



complete -o filenames -F _cabal-edit cabal-edit

```



**zsh**



```bash

#compdef cabal-edit



local request

local completions

local word

local index=$((CURRENT - 1))



request=(--bash-completion-enriched --bash-completion-index $index)

for arg in ${words[@]}; do

  request=(${request[@]} --bash-completion-word $arg)

done



IFS=$'\n' completions=($( cabal-edit "${request[@]}" ))



for word in $completions; do

  local -a parts



  # Split the line at a tab if there is one.

  IFS=$'\t' parts=($( echo $word ))



  if [[ -n $parts[2] ]]; then

     if [[ $word[1] == "-" ]]; then

       local desc=("$parts[1] ($parts[2])")

       compadd -d desc -- $parts[1]

     else

       local desc=($(print -f  "%-019s -- %s" $parts[1] $parts[2]))

       compadd -l -d desc -- $parts[1]

     fi

  else

    compadd -f -- $word

  fi

done

```



**fish**



```bash

 function _cabal-edit

    set -l cl (commandline --tokenize --current-process)

    # Hack around fish issue #3934

    set -l cn (commandline --tokenize --cut-at-cursor --current-process)

    set -l cn (count $cn)

    set -l tmpline --bash-completion-enriched --bash-completion-index $cn

    for arg in $cl

      set tmpline $tmpline --bash-completion-word $arg

    end

    for opt in (cabal-edit $tmpline)

      if test -d $opt

        echo -E "$opt/"

      else

        echo -E "$opt"

      end

    end

end



complete --no-files --command cabal-edit --arguments '(_cabal-edit)'

```



Limitations

-----------



Since this library works directly with the `PackageDescription` data structure

it cannot handle Cabal files in their full generality. Instead we directly

manipulate the internal structure used to represent the Cabal file which is not

capable of representing all surface constructs. If your Cabal file currently

uses:



* Common stanzas

* Conditional blocks

* Preprocessor definitions



These constructs will be compiled into the `PackageDescription` and inlined if

you use `cabal-edit`. This makes `cabal-edit` useful for small beginning

projects and ones that don't use advanced Cabal features.



License

-------



MIT License

Copyright (c) 2020, Stephen Diehl