yonaskolb / yonaskolb/XcodeGen

`headerVisibility` should default to `project` for dynamic framework targets

Open
#1,244 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Swift
Stars
8.8k
Forks
908
Avg merge
17d 14h
Merged PRs (30d)
2

Description

It currently defaults to public for any header, but this does not match Xcode's behavior, which is to assign any newly created .h file to project visibility in a dynamic framework's Headers Build Phase:
image

This could easily allow an accidental exposure of API not meant for public consumption, which is a bad spot for an SDK to be in, as once that version is released, if adhering to semver, fixing that visibility would require a major version bump.

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 tracing how XcodeGen assigns headerVisibility for headers in dynamic framework targets and compare the generated Headers Build Phase with Xcode's behavior. Done means newly created headers default to project visibility rather than public without changing intended public headers.

Written by the indexing model from the issue text.

Assessment

Tech stack
swift
Domain
build-system
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.