jpsim / jpsim/SourceKitten

Show more useful errors when using invalid compiler arguments

Open
#43 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Swift
Stars
2.4k
Forks
237
PR merge metrics
No merged PRs in 30d

Description

$ echo '/// YOLO\nclass YOLO {}' > yolo.swift
$ sourcekitten doc --single-file yolo.swift yolo.swift
Illegal instruction: 4
$ brew ls sourcekitten
/usr/local/Cellar/sourcekitten/0.3.1/bin/sourcekitten
[...]

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 reproducing the command shown with sourcekitten doc --single-file and the yolo.swift input, then trace how invalid compiler arguments are handled. The issue names no source files or tests, so identify the relevant command entry point and add coverage for the reproduction; done means a useful compiler-argument error is reported instead of an illegal-instruction crash.

Written by the indexing model from the issue text.

Assessment

Tech stack
swift
Domain
cli
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.