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

Jump to bottom

docs: mention default level #5340

Merged
merged 2 commits into from
Mar 11, 2021
Merged

docs: mention default level #5340

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7ee6e68
docs: mention default level
staabm Mar 7, 2021
92e344a
Update error_levels.md
staabm Mar 7, 2021
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
3 changes: 3 additions & 0 deletions docs/running_psalm/error_levels.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ You can run Psalm in at different levels of strictness from 1 to 8.

Level 1 is the most strict, level 8 is the most lenient.

When no level is explicitly defined, psalm defaults to level 2.
Copy link

@dbrekelmans dbrekelmans Mar 8, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

Are you sure about this? I thought psalm scans the codebase and determines the appropriate level from that. Maybe I'm confused with something else... but just checking ;)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I guess its correct, see the cited code in the PR description.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Are you sure about this? I thought psalm scans the codebase and determines the appropriate level from that.

I guess there is some kind of init command which guesses a proper default level when you use it.
I am talking about what psalm does when no level is defined in the config file at all.

In case `totallyTyped` is enabled, psalm defaults to level 1.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Since totallyTyped is deprecated we might just drop this line for simplicity sake


Some issues are [always treated as errors](#always-treated-as-errors). These are issues with a very low probability of false-positives.

At [level 1](#errors-that-only-appear-at-level-1) all issues (except those emitted for opt-in features) that Psalm can find are treated as errors. Those issues include any situation where Psalm cannot infer the type of a given expression.
Expand Down