Commit Graph

56 Commits

Author SHA1 Message Date
Kasper Møller Andersen
ae15334993
Slim down the README (#5)
Thanks a lot @KasMA1990 

* Slim down the README

This removes almost a fourth of the words in it :)

* Further cleanup of README

* Better highlight that elm-review is built to be extensible
2020-04-01 20:13:34 +02:00
Jeroen Engels
7046137121 Document module and project rules 2020-02-25 19:47:06 +01:00
Jeroen Engels
9209e26bcd Add functions that allow exceptions for rules 2020-02-25 16:48:20 +01:00
Jeroen Engels
d2f2ffa2cd Rename Multi/Single to Project/Module 2020-01-20 08:34:52 +01:00
Jeroen Engels
cf344cb904 Rename project to elm-review 2019-09-28 17:18:51 +02:00
Jeroen Engels
2b37947669 Mention you can search for rules using elm-search 2019-09-20 13:44:43 +02:00
Jeroen Engels
01b9b4a546 Add trailing slashes to links to the packages website
Otherwise, internal links in the linked pae will give a 404 error
2019-09-18 12:04:33 +02:00
Jeroen Engels
7af85f37cd Remove mentions of elm-lint install and recommend using elm install instead 2019-09-18 11:49:33 +02:00
Jeroen Engels
23bba24185 Wording change: it's -> it is 2019-09-17 19:56:15 +02:00
Jeroen Engels
5130f9c0e1 Add an example of the report in the README 2019-08-30 01:33:57 +02:00
Jeroen Engels
bf1f1d2380 Fix "across" typo accross the whole project 2019-08-29 22:45:28 +02:00
Jeroen Engels
e72773085d Add checking for new APIs in the checklist for when to write a rule 2019-08-28 19:01:18 +02:00
Jeroen Engels
9580d59e80 Remove mention that the package contains rules 2019-08-28 09:24:54 +02:00
Jeroen Engels
f631255bbd Add guidelines on writing automatic fixes 2019-08-27 15:26:05 +02:00
Jeroen Engels
d1877a1fed Reword the short description of the project 2019-08-23 13:52:59 +02:00
Jeroen Engels
6b3c635bb5 Reword the project's short description 2019-08-22 12:00:17 +02:00
Jeroen Engels
c1562aa81b Remove the rules from the README, and write why there are no built-in rules 2019-08-22 11:42:43 +02:00
Jeroen Engels
9463d89a32 Add comments in the example of the "write your own rule" section 2019-08-22 11:04:59 +02:00
Jeroen Engels
354a876ce0 Rework documentation about configuration 2019-08-22 10:43:53 +02:00
Jeroen Engels
4831498a57 Add travis badge 2019-08-01 09:30:40 +02:00
Jeroen Engels
e1146c634f Reword parts of the README 2019-07-28 19:36:12 +02:00
Jeroen Engels
58e4ef5954 Remove the FAQ and move out some questions 2019-07-28 19:30:34 +02:00
Jeroen Engels
6763340cb8 Add section on when to write or enable a rule 2019-07-28 19:20:23 +02:00
Jeroen Engels
68b3b72f8d Update calls to Rule.error in documentation 2019-07-28 10:27:46 +02:00
Jeroen Engels
f4cd561c20 Tiny documentation changes 2019-07-28 10:27:46 +02:00
Jeroen Engels
a70013ca24 Remove the concept of Severity 2019-07-25 14:37:10 +02:00
Jeroen Engels
e569ea4d5d Add new motivation for writing a rule 2019-07-25 12:49:16 +02:00
Jeroen Engels
f3fb8c59b9 Remove the "project aim and status" section 2019-07-24 23:25:48 +02:00
Jeroen Engels
f726d61d71 Add reasons for the rules/configuration being in Elm 2019-07-24 23:23:57 +02:00
Jeroen Engels
7a2bc49d41 Explain rationale behind not having a way to disable a rule locally 2019-07-24 23:20:10 +02:00
Jeroen Engels
6f26e13714 Remove rule DefaultPatternPosition
The compiler now forbids redundant patterns 👍
2019-07-08 22:23:27 +02:00
Jeroen Engels
3f6cc7c3e7 Add rule NoUnusedTypeConstructors 2019-07-05 01:21:30 +02:00
Jeroen Engels
0755f0ec6f Update project status in README 2019-06-28 00:03:07 +02:00
Jeroen Engels
c3ceccc3dd Move Error to Lint.Rule 2019-06-28 00:03:07 +02:00
Jeroen Engels
fbbb70749b Move LintResult from Lint.Error to TestUtil 2019-06-26 11:51:48 +02:00
Jeroen Engels
692ebf2406 Simplify DefaultPatternPosition's configuration 2019-06-25 23:51:43 +02:00
Jeroen Engels
3ef7e6f5ab Update the README.md a lot 2019-06-25 23:51:43 +02:00
Jeroen Engels
bf8c6a4b76 Add rule NoExtraBooleanComparison 2019-06-24 00:49:58 +02:00
Jeroen Engels
42ba9fc47b Add license file 2018-11-05 19:07:41 +01:00
Jeroen Engels
c9b5731e17 Remove awkward sentence about good/bad rules 2017-06-19 09:36:55 +02:00
Jeroen Engels
b34e3c766c Fix link to elm-lint package documentation 2017-06-19 00:49:37 +02:00
Jeroen Engels
f5c69e2eec Rewrite README 2017-06-19 00:30:59 +02:00
Jeroen Engels
11b37494a9 Add rule ElmTest.NoDuplicateTestBodies 2017-06-18 20:58:08 +02:00
Jeroen Engels
5eee6e50e1 Add SimplifyPropertyAccess rule 2017-06-11 19:43:02 +02:00
Jeroen Engels
09460f741b Remove license in README 2017-01-29 22:53:31 +01:00
Jeroen Engels
a64a719cdf Add documentation for every rule inside the source 2017-01-29 22:50:48 +01:00
Jeroen Engels
0710792368 Add documentation 2017-01-29 21:35:00 +01:00
Jeroen Engels
da3f260ece Add NoNestedLet rule 2017-01-24 23:33:16 +01:00
Jeroen Engels
a9b17d8bfa Add NoUselessIf rule 2017-01-23 20:09:37 +01:00
Jeroen Engels
2b3a3e5a88 Add DefaultPatternPosition rule 2017-01-22 23:50:00 +01:00