MobileNativeFoundation / MobileNativeFoundation/rules_xcodeproj

Feature Request: Support provisioning of code snippets in generated Xcode projects

Open
#499 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature request
Dominant language
Swift
Stars
626
Forks
124
PR merge metrics
No merged PRs in 30d

Description

Some companies/projects provide shared code snippets checked in to source control. Right now, we perform a separate step to copy the code snippets to the appropriate location.

  cp -R \
    "${SRC_ROOT}/CodeSnippets/." \
    "${HOME}/Library/Developer/Xcode/UserData/CodeSnippets"

Granted this request is slightly orthogonal to the generation of the project. However, the generation of the project does provide a nice signal to copy the shared code snippets.

Options

  1. Do nothing and suggest clients wrap calls to the project generation in a shell script which does whatever is necessary to provision the development environment.
  2. Do nothing and suggest clients use a multirun rule to execute the project generation and run a target that copies the code snippets.
  3. Add an attribute listing the code snippets that should be copied to the user's Library directory.
  4. Provide attributes that allow a client to specify pre- and post- install hooks. The installer would then run them in the specified order before and after the installation. (NOTE: This is really just incorporating option 2 into rules_xcodeproj.)

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

The issue names no files, tests, or entry points; start by locating the generated Xcode project installation flow and its existing tests. Clarify which of the four provisioning options is wanted, then define the supported behavior and verify it with coverage for code-snippet installation.

Written by the indexing model from the issue text.

Assessment

Tech stack
ios, macos
Domain
build-system, developer-experience
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.