Low-level bindings to libsass for Haskell
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
Bindings Update to libsass 3.5.2 & bump version Mar 24, 2018
libsass @ 9cfe0df
tests
tools
.editorconfig Fix extra dependencies, add CHANGELOG and .editorconfig file. Apr 12, 2015
.gitattributes Add README. Apr 11, 2015
.gitignore Add stack.yaml (finally!) Dec 19, 2015
.gitmodules
.travis.yml Fix `update_nightly.sh` tool Mar 24, 2018
CHANGELOG.md
LICENSE Update README, CHANGELOG and bump version Mar 25, 2017
README.md Update to libsass 3.5.2 & bump version Mar 24, 2018
Setup.hs And adapt to support Cabal pre 1.24 Jul 18, 2018
hlibsass.cabal Update to libsass 3.5.2 & bump version Mar 24, 2018
stack-lts-11.yml Use `gmake` instead of `make` during Setup if available Jul 18, 2018
stack-lts-2.yaml
stack-lts-3.yaml Support LTS-3, LTS-6, LTS-7 and LTS-8 Mar 15, 2017
stack-lts-6.yaml
stack-lts-7.yaml Adapt `Setup.hs` to support both Cabal-1.23 and Cabal-2 Aug 6, 2017
stack-lts-8.yaml
stack-lts-9.yaml
stack-nightly.yaml Use `gmake` instead of `make` during Setup if available Jul 18, 2018
stack.yaml Use `gmake` instead of `make` during Setup if available Jul 18, 2018

README.md

hLibsass

Build Status Hackage Hackage deps

hLibsass is a low-level binding to LibSass. It provides basic types used by the library along with a FFI interface to the C API.

This is really a low-level library, if you want a high-level, more Haskell-friendly library, check out hSass.

It is available on Hackage.

hLibsass' Changelog

Documentation

This library is (mostly) 1-1 binding to LibSass. See LibSass wiki for documentation.

Static, shared or external version of LibSass?

hLibsass supports three different ways of linking with Libsass:

  1. Static, locally-built LibSass,
  2. Shared, locally-built LibSass, requires setting sharedLibsass flag,
  3. External (e.g. system package), requires setting externalLibsass flag.

The first two options rely on the LibSass being distributed with the hlibsass package and compiled during configure/build process. hLibsass is always distributed with LibSass version that is compatibile with the package.

Up until version 0.1.6.0, the first option was preferred, because LibSass has been distributed as a source package only. Development package of LibSass is now available in most Linux distributions and in Homebrew, so using it is equally good option

Using locally-built shared version of LibSass may require adjusting LD_LIBRARY_PATH or putting libsass.so somewhere in the PATH, so this option is discouraged. However, if you really want to use it that way, you may use tools/libpath.sh to set LD_LIBRARY_PATH (it extracts the library location using ghc-pkg).

externalLibsass flag has precedence over sharedLibsass.

hLibsass and LibSass version

hLibsass uses LibSass internally and therefore is quite tightly bound to LibSass. Every breaking change in LibSass C API will break hLibSass (either at compile-time or at runtime, depends on the change). For now, these combinations should work:

  • hLibsass 0.1.5.x with LibSass 3.3.2 (distributed with) and 3.4.3 (not every function is reexported, but there were no changes that would break hLibSass),
  • hLibsass 0.1.6.x with LibSass 3.4.3 (distributed with),
  • hLibsass 0.1.7.x with LibSass 3.5.2 (distributed with)
  • LibSass 3.5.x WILL have breaking changes and will result in runtime failures of hLibSass versions prior to 0.1.7.0 (and probably compile-time failures too), see LibSass releases page for more details.

Things to consider

Libsass is C++ library with C API, so in order to use it, it is necessary to provide C++ runtime. This library is linked against libstdc++ (Windows & Linux)/libc++ (macOS) automatically, so you don't have to deal with linking process.

Known limitations

GHCi not able to load hLibSass

GHC 7 is unable to load static version of native libraries (at least some of them) and therefore it rejects loading libsass.a. On Linux, you can overcome this by switch to GHC 8 (tested with 8.0.2 with LTS Haskell 8.5) or by using shared or external (also shared) version of LibSass. On macOS, GHC 8 still rejects the library (it detects unresolver/duplicated symbols), so the only solution is to use shared/external LibSass (Homebrew version works).

Copyright

Copyright (c) 2015-2018 Jakub Fijałkowski. See LICENSE for details.