~alcinnz/haskell-stylist

ref: 3e92f6c3f8fdaca139f09b647fa6bbac57285f22 haskell-stylist/README.md -rw-r--r-- 2.5 KiB
3e92f6c3 — Adrian Cochrane Revamp XML-Conduit-Stylist API to avoid hard-dependency on Haskell Stylist. 1 year, 8 months ago

#Haskell Stylist

Generic CSS style engine for Haskell, intended to aid the development of new browser engines.

Stylish Haskell implements CSS selection and cascade (but not inheritance) independant of the CSS at-rules and properties understood by the caller. It is intended to ease the development of new browser engines, independant of their output targets.

For more interesting projects see: https://github.io/alcinnz/browser-engine-ganarchy/

#Versioning

The second major number indicates that more of CSS has been implemented within the existing API. Until then the error recovery rules will ensure as yet invalid CSS won't have any effect.

The first major number indicates any other change to the API, and might break your code.

#API

To parse a CSS stylesheet call Data.CSS.Syntax.StyleSheet.parse which returns a variant of the passed in StyleSheet. StyleSheet is a typeclass specifying methods for parsing at-rules (parseAtRule), storing parsed style rules (addRule), and optionally setting the stylesheet's priority (setPriority).

If these ultimately call down into a Data.CSS.Syntax.Style.QueryableStyleSheet you can call queryRules to find all matching style rules organized by psuedoelement. Once you have these style rules (typically by specifying a psuedoelement) you can call cascade' to resolve them into any instance of PropertyParser. To query rules not targetting a psuedoelement, you can either lookup the "" psuedoelement or use the cascade shorthand.

PropertyParser allows to declaratively (via Haskell pattern matching) specify how to parse CSS properties, and how they're impacted by CSS inheritance. It has four methods: longhand and shorthand specify how to parse CSS properties, whilst temp and inherit specifies what the default values should be.

#Contributing

You can contributed code or register "issues" to Haskell Stylist by contacting me (Adrian Cochrane) via mastodon or email..

If you're contributing code you can link me to where you're hosting your git fork, or send a patch file. Or if you simply want to ask for more features or fixes don't hesitate to contact me!

Feel free to mirror this repo elsewhere! Just tell me about it so I can watch that mirror for contributions.

#Building

  1. Install ghc and cabal-install. (Debian package names listed here)
  2. From within the git repository, run cabal install. This'll compile Stylist and all it's other dependencies.
  3. Run cabal test after every change you make.