mapbox / mapbox/mapbox-directions-swift

Lint for implicitly unwrapped optionals

Open
#453 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

build
Dominant language
Swift
Stars
206
Forks
99
Avg merge
7h 54m
Merged PRs (30d)
3

Description

To prevent regressions of #228 like #447, we should install [SwiftLint](https://github.com/realm/SwiftLint/) and configure it to warn on `force_unwrapping` in the four framework targets, then install Danger to surface the warning. Other linting rules and the example and test bundle targets are out of scope.

I think warning on `force_unwrapping` is a reasonable step in this repository specifically, because this project primarily encodes and decodes data and requests and receives HTTP responses. This library is designed to give the developer as much control as possible, including control over error handling, so a force-unwrap is almost never appropriate.

/cc @mapbox/navigation-ios @dmiluski

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the project configuration for the four framework targets and the existing integration point where Danger can surface warnings. Configure SwiftLint to warn on force_unwrapping and connect that warning to Danger; done means the four framework targets are covered while other rules, examples, and test bundle targets remain out of scope.

Written by the indexing model from the issue text.

Assessment

Tech stack
swift
Domain
ci-cd, tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.