Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Amend configuration.md #608

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Amend configuration.md #608

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs/src/usage/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Configuration
selene is meant to be easily configurable. You can specify configurations for the entire project as well as for individual lints.

Configuration files are placed in the directory you are running selene in and are named **selene.toml**. As the name suggests, the configurations use the [Tom's Obvious, Minimal Language (TOML)](https://github.com/toml-lang/toml) format. It is recommended you quickly brush up on the syntax, though it is very easy.
Configuration files apply to the directory (and subdirectories) in which they are placed. So, to control how selene behaves when it lints scripts in, say, `~/myScripts` and below, place the configuration file within (the top-level of) `~/myScripts`. Each configuration file is to be called **selene.toml**. As the file suffix suggests, configuration files use the [Tom's Obvious, Minimal Language (TOML)](https://github.com/toml-lang/toml) format. It is recommended you quickly brush up on the syntax, though it is very easy.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Configuration files apply to the directory (and subdirectories) in which they are placed. So, to control how selene behaves when it lints scripts in, say, ~/myScripts and below, place the configuration file within (the top-level of) ~/myScripts.

This isn't accurate because the config doesn't apply to the scripts in the folder. It applies to the command when ran from the folder, which can lint on a different folder.


## Changing the severity of lints
You can change the severity of lints by entering the following into selene.toml:
Expand All @@ -13,13 +13,13 @@ lint_2 = "severity"
...
```

Where "severity" is one of the following:
where "severity" is one of the following:

- `"allow"` - Don't check for this lint
- `"warn"` - Warn for this lint
- `"deny"` - Error for this lint
- `"allow"` - don't check for this lint;
- `"warn"` - produce a warning when this lint is transgressed;
- `"deny"` - produce an error message when this lint is transgressed.

Note that "deny" and "warn" are effectively the same, only warn will give orange text while error gives red text, and they both have different counters.
`deny` and `warn` are near-identical in effect. The only difference are: errors are printed in red, and warnings in orange; errors increment the error counter, warnings, the warning counter.

## Configuring specific lints
You can configure specific lints by entering the following into selene.toml:
Expand Down
Loading