iv-org-mirror/shard-ameba
1
0
Fork 0
mirror of https://gitea.invidious.io/iv-org/shard-ameba.git synced 2024-08-15 00:53:29 +00:00
Code Issues Projects Releases Packages Wiki Activity

Fix crystal docs

Browse source
This commit is contained in:
Vitalii Elenhaupt 2019-11-25 14:08:22 +02:00
parent 6b56c87e78
commit e8c00d171f
No known key found for this signature in database
GPG key ID: CD0BF17825928BC0
1 changed files with 4 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -71,14 +71,14 @@ Starting from 0.31.0 Crystal [supports parallelism](https://crystal-lang.org/201
It allows to run linting in parallel too. It allows to run linting in parallel too.
In order to take advantage of this feature you need to build ameba with preview_mt support: In order to take advantage of this feature you need to build ameba with preview_mt support:
``` ```sh
$ crystal build src/cli.cr -Dpreview_mt -o bin/ameba $ crystal build src/cli.cr -Dpreview_mt -o bin/ameba
$ make install $ make install
``` ```
Some quick benchmark results measured while running Ameba on Crystal repo: Some quick benchmark results measured while running Ameba on Crystal repo:
``` ```sh
$ CRYSTAL_WORKERS=1 ameba #=> 29.11 seconds $ CRYSTAL_WORKERS=1 ameba #=> 29.11 seconds
$ CRYSTAL_WORKERS=2 ameba #=> 19.49 seconds $ CRYSTAL_WORKERS=2 ameba #=> 19.49 seconds
$ CRYSTAL_WORKERS=4 ameba #=> 13.48 seconds $ CRYSTAL_WORKERS=4 ameba #=> 13.48 seconds
@ -155,7 +155,7 @@ Generate new file by running `ameba --gen-config`.
One or more rules, or a one or more group of rules can be included or excluded One or more rules, or a one or more group of rules can be included or excluded
via command line arguments: via command line arguments:
``` ```sh
$ ameba --only Lint/Syntax # runs only Lint/Syntax rule $ ameba --only Lint/Syntax # runs only Lint/Syntax rule
$ ameba --only Style,Lint # runs only rules from Style and Lint groups $ ameba --only Style,Lint # runs only rules from Style and Lint groups
$ ameba --except Lint/Syntax # runs all rules except Lint/Syntax $ ameba --except Lint/Syntax # runs all rules except Lint/Syntax
@ -170,7 +170,7 @@ and the reasoning by it being reported.
To be convenient, you can just copy-paste the `PATH:line:column` string from the To be convenient, you can just copy-paste the `PATH:line:column` string from the
report and paste behind the `ameba` command to check it out. report and paste behind the `ameba` command to check it out.
``` ```sh
$ ameba crystal/command/format.cr:26:83 # show explanation for the issue $ ameba crystal/command/format.cr:26:83 # show explanation for the issue
$ ameba --explain crystal/command/format.cr:26:83 # same thing $ ameba --explain crystal/command/format.cr:26:83 # same thing
``` ```