fsprojects / fsprojects/FSharpLint
feat: Exception best practices
Open
Nobody has claimed this yet.
- Dominant language
- F#
- Stars
- 327
- Forks
- 74
- PR merge metrics
- No merged PRs in 30d
Description
Should highlight violations when:
- NRE or StackoverflowException or OutOfMemoryException is thrown (only the runtime should throw this).
- Exception's Message or StackTrace proerties are used (they would miss exception type, recommend
ex.ToString()instead). - If
raiseis not inside atry/withblock, maybe recommend using Result type? (this should probably be a separate rule; or maybe each of the items in this list should be a different rule)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Use the issue text as the starting point and review how FSharpLint currently defines and tests lint rules. Decide whether the listed exception checks belong in separate rules, then define the violation cases and expected diagnostics. Done means the selected exception-pattern violations are detected with tests covering the agreed scope.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- fsharp
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100