diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,11 @@ +Copyright Vanessa McHale (c) 2018 + +Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. + +2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. + +3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/README.md b/README.md new file mode 100644 --- /dev/null +++ b/README.md @@ -0,0 +1,6 @@ +# shake-ext + +Several extensions to [shake](http://shakebuild.com/), including facilities for +building ATS and Haskell. + +This package is very much experimental at the moment. diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/cabal.project.local b/cabal.project.local new file mode 100644 --- /dev/null +++ b/cabal.project.local @@ -0,0 +1,7 @@ +constraints: shake-ext +development +with-compiler: ghc-8.2.2 +tests: True +benchmarks: True +documentation: True +haddock-hoogle: True +haddock-internal: True diff --git a/shake-ext.cabal b/shake-ext.cabal new file mode 100644 --- /dev/null +++ b/shake-ext.cabal @@ -0,0 +1,39 @@ +name: shake-ext +version: 0.1.0.0 +synopsis: Helper functions for linting with [shake](http://shakebuild.com/) +description: This package provides several linters out of the box, as well as several helper functions for build ATS projects. +homepage: https://hub.darcs.net/vmchale/shake-ext +license: BSD3 +license-file: LICENSE +author: Vanessa McHale +maintainer: vamchale@gmail.com +copyright: Copyright: (c) 2018 Vanessa McHale +category: Development +build-type: Simple +extra-doc-files: README.md +extra-source-files: stack.yaml + , cabal.project.local +cabal-version: 1.18 + +Flag development { + Description: Enable `-Werror` + manual: True + default: False +} + +library + hs-source-dirs: src + exposed-modules: Development.Shake.FileDetect + , Development.Shake.Linters + build-depends: base >= 4.7 && < 5 + , shake + default-language: Haskell2010 + if flag(development) + ghc-options: -Werror + if impl(ghc >= 8.0) + ghc-options: -Wincomplete-uni-patterns -Wincomplete-record-updates -Wcompat + ghc-options: -Wall + +source-repository head + type: darcs + location: https://hub.darcs.net/vmchale/shake-ext diff --git a/src/Development/Shake/FileDetect.hs b/src/Development/Shake/FileDetect.hs new file mode 100644 --- /dev/null +++ b/src/Development/Shake/FileDetect.hs @@ -0,0 +1,46 @@ +module Development.Shake.FileDetect + ( getAts + , getSats + , getHats + , getYml + , getToml + , getHs + , getHappy + , getAlex + ) where + +import Data.Semigroup ((<>)) +import Development.Shake + +getYml :: Action [FilePath] +getYml = getAll ["yaml", "yml", "yamllint"] + +getToml :: Action [FilePath] +getToml = getAll ["toml"] + +getHs :: Action [FilePath] +getHs = getAll ["hs", "hs-boot", "hsig", "lhs"] + +getHappy :: Action [FilePath] +getHappy = getAll ["y", "yl"] + +getAlex :: Action [FilePath] +getAlex = getAll ["x"] + +get :: String -> Action [FilePath] +get = getAll . pure + +getAll :: [String] -> Action [FilePath] +getAll ss = getDirectoryFiles "" (("//*." ++) <$> ss) + +getSats :: Action [FilePath] +getSats = get "sats" + +getDats :: Action [FilePath] +getDats = get "dats" + +getHats :: Action [FilePath] +getHats = get "hats" + +getAts :: Action [FilePath] +getAts = (<>) <$> getDats <*> getSats diff --git a/src/Development/Shake/Linters.hs b/src/Development/Shake/Linters.hs new file mode 100644 --- /dev/null +++ b/src/Development/Shake/Linters.hs @@ -0,0 +1,30 @@ +-- findExecutable + +module Development.Shake.Linters ( tomlcheck + , yamllint + , hlint + , shellcheck + , ghc + , module Development.Shake.FileDetect + ) where + +import Development.Shake +import Development.Shake.FileDetect + +checkFiles :: String -> [FilePath] -> Action () +checkFiles str = mapM_ (cmd_ . ((str ++ " ") ++)) + +shellcheck :: [FilePath] -> Action () +shellcheck = checkFiles "shellcheck" + +ghc :: Action () +ghc = checkFiles "ghc -Wall -Werror -Wincomplete-uni-patterns -Wincomplete-record-updates -fno-code" =<< getHs + +tomlcheck :: Action () +tomlcheck = checkFiles "tomlcheck --file" =<< getToml + +hlint :: Action () +hlint = checkFiles "hlint" =<< getHs + +yamllint :: Action () +yamllint = checkFiles "yamllint -s" =<< getYml diff --git a/stack.yaml b/stack.yaml new file mode 100644 --- /dev/null +++ b/stack.yaml @@ -0,0 +1,9 @@ +--- +resolver: lts-10.3 +packages: + - '.' +extra-deps: [] +flags: + shake-ext: + development: false +extra-package-dbs: []