twostraws / twostraws/Sitrep

Add ability via configuration file to additionally scan swift packages

Open
#39 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Swift
Stars
1.4k
Forks
65
Avg merge
20d 17h
Merged PRs (30d)
2

Description

Hey Paul,

As the good Swift developers we are, we strive to encapsulate reusable code into Swift Packages. Do you think that it would be easy to enhance SitRep to go inspecting Swift Package dependencies too and combine the results into a single report, maybe broken down by app / packages? My use case would be to only count lines of code that I've personally written.

I'm sure this could be done by just invoking SitRep on all of the local swift packages but that would require some addition and combining results from several runs.

Thoughts on the following?

  • Configuration to specify which Swift Package references to be interested in
  • Configuration to specify where Swift Package Manager is configured to save local copies
  • Configuration to specify path to LOCAL Swift Packages --> This is usually my workflow, develop locally, push, then have app checkout from GitHub

Contributor guide

No contributing guide indexed for this repository

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 reviewing SitRep’s existing configuration and scan/report flow, then inspect how Swift Package Manager exposes local and cached package paths. Done means a defined configuration supports the requested package sources and combines their results into one report, optionally separated by app and package.

Written by the indexing model from the issue text.

Assessment

Tech stack
swift
Domain
tooling
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.