Commit Graph

43 Commits

Author SHA1 Message Date
Jens Petersen
6a053acb10 readme: fix typo of "accommodate"
[skip ci]
2020-09-04 10:26:20 +02:00
Mark Karpov
913a927f39
Tweak the readme a bit, mention Arch Linux 2020-06-29 17:36:24 +02:00
Mark Karpov
c97ba55762
Change comment style in the readme
[skip ci]
2020-06-23 11:56:43 +02:00
Mark Karpov
03e6c70a78
Mention ‘stack install’ in the readme 2020-06-21 14:54:59 +02:00
Mark Karpov
c261356bc4
Recommend lts-16.0 in the readme 2020-06-21 10:45:18 +02:00
Mark Karpov
9a3d872e33
Mention how to format a tree recursively
[skip ci]
2020-04-26 16:50:49 +02:00
Facundo Domínguez
5bffeffa05 Update design notes for CPP. 2020-04-24 23:08:37 +02:00
Mark Karpov
53f582a575
Implement experimental support for CPP 2020-04-22 14:47:09 +02:00
Mark Karpov
dde7560291 Allow disabling of Ormolu with special comments
Ormolu can be turned on and off via the special comments:

{- ORMOLU_DISABLE -}

and

{- ORMOLU_ENABLE -}

This allows us to disable formatting selectively for code between these
markers or disable it for the entire file. To achieve the latter, just put
{- ORMOLU_DISABLE -} at the very top. Note that the source code should still
be parseable even without the “excluded” part. Because of that the magic
comments cannot be placed arbitrary, but should rather enclose independent
top-level definitions.
2020-04-21 12:44:39 +02:00
Clément Hurlin
57d0d11b37 Mention a second vim integration: neoformat 2020-03-26 23:36:51 +01:00
fisx
55d8b7f8c4 Add link to vim integration to README 2020-02-18 12:59:57 +01:00
Mark Karpov
5f5a70655a Use Buildkite
Replace CircleCI with Buildkite.
2020-02-10 20:17:49 +01:00
mrkkrp
f83f6fd1da
Update links in the readme to make them work outside of GitHub
Relative links work fine on GitHub, but not on e.g. Hackage.
2019-10-22 21:58:57 +02:00
Yuriy Syrovetskiy
73b03b1b7f Add VS Code plugin link 2019-10-19 12:06:01 +02:00
mrkkrp
096c8d7f63 Update the readme
Also adds the note to ‘DESIGN.md’ stating that it's no longer being updated.
2019-10-04 11:44:21 +02:00
mrkkrp
8466d6e743 Change the style of type signatures
The commit changes how type signatures are printed. The new style looks like
this:

  foo ::
    Int ->
    Char ->
    String

This works better with foralls and other features of the type system that
will be added in the near future, like linear arrows.

In order to print Haddocks nicely (this seems to be the only acceptable
placement):

  foo ::
    -- | First argument
    Int ->
    -- | Second argument
    Char ->
    -- | Result
    String

It is often necessary to re-arrange them completely and use the “pipe style”
instead of “caret style”. It proved to be a very hard task with our older
comment-handling system, if not impossible.

Here we start parsing Haddocks so that they are treated as components of AST
and we now render them as part of rendering of those components. The
existing framework for handling comments only prints non-Haddock comments
now.

The change caused a fair number of new problems and failures which I added
new tests for.
2019-10-02 16:52:42 +02:00
Kierán Meinhardt
776d3f546c Fix small typo in readme 2019-10-01 10:21:26 +02:00
mrkkrp
db486977d7
Add an example how to use Ormolu straight from GitHub 2019-09-11 12:13:58 +02:00
mrkkrp
4109878fe6
Drop handling of operator chains from the limitation list 2019-09-11 09:36:15 +02:00
mrkkrp
5928af6360
Show how to build just Oromlu itself in the readme
Not everyone wants to build all the tests and some people find it annoying
that nix creates dozen of ‘result-’ symlinks after it.
2019-09-11 09:35:05 +02:00
mrkkrp
607ef5369a
Add more badges
[skip ci]
2019-08-31 20:31:55 +02:00
mrkkrp
c0513b3024 Use GHC 8.6.5 2019-08-28 15:44:41 +02:00
mrkkrp
6713073c5e
Update the readme mentioning current limitations
[skip ci]
2019-08-28 15:02:10 +02:00
mrkkrp
a7076c0f83
Mention the Emacs package in the readme
[skip ci]
2019-08-16 23:24:16 +02:00
mrkkrp
54749b889a
A couple of minor corrections to the readme
[skip ci]
2019-08-04 21:20:30 +02:00
mrkkrp
78e8dd830a Make sure we always get both original and formatted files 2019-07-14 13:14:55 +02:00
mrkkrp
7a9aab77b3 Add nix expression for reformatting sources of arbitrary packages
See the description in readme.
2019-07-14 13:14:55 +02:00
waddlaw
28c35cc8df Drop the mention of configuration file from readme 2019-07-08 22:30:10 +02:00
mrkkrp
7c7edb8a75
Fix a typo in the readme
[skip ci]
2019-07-02 21:29:07 +02:00
mrkkrp
05e420159a
Replace current year with the word "present"
[skip ci]

Saves a lot of effort updating all those thingies every year.
2019-07-02 21:27:45 +02:00
mrkkrp
47ffeb123d Add ‘CONTRIBUTING.md’ file to the repository 2019-05-31 16:09:35 +02:00
mrkkrp
e2a20217dd Update the readme 2019-05-31 14:43:15 +02:00
Facundo Domínguez
cce75c7840 Add stack invocation to the README. 2019-05-30 14:39:17 +02:00
Facundo Domínguez
777e0e3135 Mention how to build and how to configure in the README. #56 #55 2019-05-30 14:39:17 +02:00
mrkkrp
5f746eec91
Fix the link to license file and years there
[skip ci]
2019-05-23 19:57:32 +02:00
Mathieu Boespflug
c94805e997 Change the order of bullet points. 2019-05-23 15:58:07 +02:00
mrkkrp
ae3ea9b5b6
Mention minimal diffs in the readme
[skip ci]
2019-05-17 12:18:01 +02:00
mrkkrp
4e087ff0c3
Fix a typo
[skip ci]
2019-05-16 18:45:45 +02:00
Mark Karpov
50fd9c7759 Various fixes, thanks to Facundo
[skip ci]
2019-05-10 19:00:43 +02:00
mrkkrp
0b7d784cd6 Update the readme file
[skip ci]
2019-05-10 19:00:43 +02:00
mrkkrp
576f943e7f Implement rendering of types and type families declarations 2019-04-07 19:33:28 +02:00
mrkkrp
c9e8fed11c
Add build status badge 2018-11-25 21:10:52 +07:00
mrkkrp
dc6605107a
Initial commit 2018-11-25 20:51:22 +07:00