Skip to content

Latest commit

 

History

History
56 lines (43 loc) · 2.6 KB

CONTRIBUTING.md

File metadata and controls

56 lines (43 loc) · 2.6 KB
Raw

Contributing to Lambda Soup

Lambda Soup is developed on GitHub. All feedback is welcome – open a GitHub issue, or send me an email at antonbachin@yahoo.com.

Some ideas

The library is at a very early stage in development, and several things need improvement. Here are a few examples:

  • It is likely that a lot of commonly-needed helpers are missing (see the Convenience section and others in the documentation). I would like to add whatever people need often. Some existing functions might benefit from having optional parameters.
  • The 'a nodes type may need to be generalized to a general lazy sequence 'a sequence, and then replaced with 'a node sequence. This may make the interface more flexible – but I wish OCaml had a standard lazy sequence type.
  • The CSS parser should probably be rewritten. It is currently a hand-coded recursive descent parser. For the most part, it supports a superset of the CSS grammar. However, it does not support strange numbers such as in :nth-child(-5n-12). Its behavior can be made more conformant and less surprising in a few corner cases. Perhaps it can also be made faster.
  • The selector matcher is a naive first implementation. There may well be a lot of performance improvements to be made.
  • Lambda Soup could extend CSS with parent, ancestor, previous sibling, and adjacent previous sibling combinators. These are the natural inverses of the standard combinators. There are also some potentially useful extensions in jQuery, such as :has, that Lambda Soup could borrow.
  • Lambda Soup could also support XPath for selection. XPath does seem to be much less familiar to people, on average, however.

Of course, this is aside from any bugs that may be found :)

Developing

Clone the repository locally, or run opam source --dev-repo --pin lambdasoup.

The library source is organized as follows:

  • src/: main source, i.e. src/soup.mli and src/soup.ml.
  • test/: unit tests in test.ml, a performance test, and a reverse dependency ("integration") test.
  • docs/: files related to the ocamldoc documentation, such as extra HTML and the postprocessing script.

To run tests, run make test. This requires the ounit package.

To generate docs, run make docs.

Make a branch off master, make your changes, rebase over master (if you have to) when done, and submit a pull request :)