diff --git a/CHANGELOG.md b/CHANGELOG.md index 591a49a..d66aa9e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,10 +4,17 @@ Change log smuggler uses [PVP Versioning][1]. The change log is available [on GitHub][2]. +0.1.0 +===== + +* [#29](https://github.com/kowainik/smuggler/issues/29) + Improve documentation. +* [#43](https://github.com/kowainik/smuggler/issues/43) + Remove `cabal.project` (there's no need in it anymore). + 0.0.0 ===== * Initially created. [1]: https://pvp.haskell.org [2]: https://github.com/kowainik/smuggler/releases - diff --git a/README.md b/README.md index ee44298..e35eb08 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,45 @@ # smuggler +![smuggler-logo](https://user-images.githubusercontent.com/4276606/45937457-c2715c00-bff2-11e8-9766-f91051d36ffe.png) [![Hackage](https://img.shields.io/hackage/v/smuggler.svg)](https://hackage.haskell.org/package/smuggler) [![Build status](https://secure.travis-ci.org/kowainik/smuggler.svg)](https://travis-ci.org/kowainik/smuggler) [![MPL-2.0 license](https://img.shields.io/badge/license-MPL--2.0-blue.svg)](https://github.com/kowainik/smuggler/blob/master/LICENSE) -Haskell Compiler Plugin which removes unused imports automatically. +> “So many people consider their work a daily punishment. Whereas I love my work +> as a translator. Translation is a journey over a sea from one shore to the +> other. Sometimes I think of myself as a smuggler: I cross the frontier of +> language with my booty of words, ideas, images, and metaphors.” +> +> ― Amara Lakhous, Clash of Civilizations Over an Elevator in Piazza Vittorio -## Build instructions +Haskell Source Plugin which removes unused imports automatically. + +## How to use + +Add `smuggler` to the dependencies of your project. Then add the following +compiler options: + +``` +-fplugin=Smuggler.Plugin +``` + +## For contributors Requirements: -* `ghc >= ghc-8.6.1-alpha2` +* `ghc-8.6.1` -### Build project +### Cabal: How to build? ```shell $ cabal new-update -$ cabal new-build --allow-newer +$ cabal new-build +``` + +#### Stack on MacOS: How to build? + +```shell +$ STACK_YAML=stack-mac-8.6.1.yaml stack build ``` ### Run tests diff --git a/cabal.project b/cabal.project deleted file mode 100644 index c98012a..0000000 --- a/cabal.project +++ /dev/null @@ -1,10 +0,0 @@ -with-compiler: /opt/ghc/8.6.1/bin/ghc -packages: . - -repository head.hackage - url: http://head.hackage.haskell.org/ - secure: True - root-keys: 07c59cb65787dedfaef5bd5f987ceb5f7e5ebf88b904bbd4c5cbdeb2ff71b740 - 2e8555dde16ebd8df076f1a8ef13b8f14c66bad8eafefd7d9e37d0ed711821fb - 8f79fd2389ab2967354407ec852cbe73f2e8635793ac446d09461ffb99527f6e - key-threshold: 3 \ No newline at end of file diff --git a/smuggler.cabal b/smuggler.cabal index d67f3c9..430bfbb 100644 --- a/smuggler.cabal +++ b/smuggler.cabal @@ -1,7 +1,14 @@ +cabal-version: 2.0 name: smuggler -version: 0.0.1 -synopsis: Smuggling -description: GHC compiler plugin which helps to manage imports +version: 0.1.0 +synopsis: GHC Source Plugin that helps to manage imports +description: + == Usage + . + Add @smuggler@ to the dependencies of your project. + . + Then add the following options: @-fplugin=Smuggler.Plugin@ + homepage: https://github.com/kowainik/smuggler bug-reports: https://github.com/kowainik/smuggler/issues license: MPL-2.0 @@ -13,7 +20,6 @@ category: Development, Refactoring build-type: Simple extra-doc-files: README.md , CHANGELOG.md -cabal-version: 2.0 tested-with: GHC == 8.6.1 source-repository head @@ -30,14 +36,14 @@ library -- Smuggler.Import -- Smuggler.Name - build-depends: base >= 4.9 && < 5 - , bytestring >= 0.10 - , containers >= 0.5 - , filepath >= 1.4 - , ghc >= 8.6.0 - , ghc-exactprint >= 0.5.7.0 - , hash-store >= 0.1.0 - , unordered-containers >= 0.2.7 + build-depends: base >= 4.12 && < 5 + , bytestring ^>= 0.10 + , containers >= 0.5 && < 0.7 + , filepath ^>= 1.4 + , ghc ^>= 8.6.0 + , ghc-exactprint ^>= 0.5.8.0 + , hash-store ^>= 0.1.0 + , unordered-containers ^>= 0.2.7 -- Debug dependencies; in separate section to easy comment before release -- , fmt @@ -56,11 +62,11 @@ library default-language: Haskell2010 -executable smuggler +executable play-smuggler hs-source-dirs: app main-is: Main.hs ghc-options: -Wall -threaded -rtsopts -with-rtsopts=-N - -fplugin=Smuggler.Plugin +-- -fplugin=Smuggler.Plugin build-depends: base , smuggler