iv-org-mirror
/
shard-ameba
mirror of https://gitea.invidious.io/iv-org/shard-ameba.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Tweak `README.md`

This commit is contained in:
Sijawusz Pur Rahnama 2022-12-08 14:15:59 +01:00
parent db3ef762b9
commit 1261f4ba6d
1 changed files with 21 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
README.md
View File

@ -19,21 +19,21 @@
- [About](#about) - [About](#about)
- [Usage](#usage) - [Usage](#usage)
* [Watch a tutorial](#watch-a-tutorial) - [Watch a tutorial](#watch-a-tutorial)
* [Autocorrection](#autocorrection) - [Autocorrection](#autocorrection)
* [Explain issues](#explain-issues) - [Explain issues](#explain-issues)
* [Run in parallel](#run-in-parallel) - [Run in parallel](#run-in-parallel)
- [Installation](#installation) - [Installation](#installation)
* [As a project dependency:](#as-a-project-dependency) - [As a project dependency:](#as-a-project-dependency)
* [OS X](#os-x) - [OS X](#os-x)
* [Docker](#docker) - [Docker](#docker)
* [From sources](#from-sources) - [From sources](#from-sources)
- [Configuration](#configuration) - [Configuration](#configuration)
* [Sources](#sources) - [Sources](#sources)
* [Rules](#rules) - [Rules](#rules)
* [Inline disabling](#inline-disabling) - [Inline disabling](#inline-disabling)
- [Editors & integrations](#editors--integrations) - [Editors \& integrations](#editors--integrations)
- [Credits & inspirations](#credits--inspirations) - [Credits \& inspirations](#credits--inspirations)
- [Contributors](#contributors) - [Contributors](#contributors)
## About ## About
@ -201,8 +201,8 @@ In this example we define default globs and exclude `src/compiler` folder:
``` yaml ``` yaml
Globs: Globs:
- **/*.cr - "**/*.cr"
- !lib - "!lib"
Excluded: Excluded:
- src/compiler - src/compiler
@ -245,18 +245,17 @@ One or more rules or one or more group of rules can be disabled using inline dir
time = Time.epoch(1483859302) time = Time.epoch(1483859302)
time = Time.epoch(1483859302) # ameba:disable Style/LargeNumbers, Lint/UselessAssign time = Time.epoch(1483859302) # ameba:disable Style/LargeNumbers, Lint/UselessAssign
time = Time.epoch(1483859302) # ameba:disable Style, Lint time = Time.epoch(1483859302) # ameba:disable Style, Lint
``` ```
## Editors & integrations ## Editors & integrations
* Vim: [vim-crystal](https://github.com/rhysd/vim-crystal), [Ale](https://github.com/w0rp/ale) - Vim: [vim-crystal](https://github.com/rhysd/vim-crystal), [Ale](https://github.com/w0rp/ale)
* Emacs: [ameba.el](https://github.com/crystal-ameba/ameba.el) - Emacs: [ameba.el](https://github.com/crystal-ameba/ameba.el)
* Sublime Text: [Sublime Linter Ameba](https://github.com/epergo/SublimeLinter-contrib-ameba) - Sublime Text: [Sublime Linter Ameba](https://github.com/epergo/SublimeLinter-contrib-ameba)
* VSCode: [vscode-crystal-ameba](https://github.com/crystal-ameba/vscode-crystal-ameba) - VSCode: [vscode-crystal-ameba](https://github.com/crystal-ameba/vscode-crystal-ameba)
* Codacy: [codacy-ameba](https://github.com/codacy/codacy-ameba) - Codacy: [codacy-ameba](https://github.com/codacy/codacy-ameba)
* GitHub Actions: [github-action](https://github.com/crystal-ameba/github-action) - GitHub Actions: [github-action](https://github.com/crystal-ameba/github-action)
## Credits & inspirations ## Credits & inspirations