Skip to content

Latest commit

 

History

History
73 lines (48 loc) · 2.25 KB

package-template.md

File metadata and controls

73 lines (48 loc) · 2.25 KB
Raw

Package Template

Considerations and description of the content in template-package.

Partly inspired by https://github.com/mattmassicotte/PackageTemplate

Create new Package

  1. Create and clone repository named snap-<package-name>
  2. Create package (Multiplatform > Library) named Snap<PackageName>
    1. Move files from Snap<PackageName>/ to root of repository
    2. Copy files from template-package folder (make sure to include .-files)
    3. Fix names in Package.swift
  3. Create a demo project if suitable
  4. Setup GitHub page: Add Description and Topics, uncheck Packages and Deployments
  5. Add to Swift Package Index
    1. Update Badge and Documentation urls in README.md

TODO: Add Code of Conduct: https://www.contributor-covenant.org

Package Template Content

Package.swift

Some adjustments to the Package definition (see Package.swift).

Add platforms definition:

platforms: [
    .iOS(.v18), .macOS(.v15)
],

Use Swift 6

// swift-tools-version: 6.0
...
swiftLanguageModes: [.version("6")]

.gitignore

A default ignore list for packages (see .gitignore).

.spi.yml

Configuration for the Swift Package Index to build DocC documentation.

LICENSE

I chose to use the MIT License (created by Github template) because it is most commonly used in the community (see LICENSE).

Demo Project

Create a demo project if suitable and configure project to edit the package directly from the demo project:

  1. Create a project in package root, name it PackageNameDemo
  2. Add local package as dependency to the project:
    1. Open Project > Package Dependencies > Add package > "Add local"
  3. Remove unnecessary files: Assets.xcassets, Preview Content (clear DEVELOPMENT_ASSET_PATHS)
  4. Copy IDETemplateMacros.plist to demo project:
    1. From: /package-template/.swiftpm/xcode/xcshareddata/IDETemplateMacros.plist
    2. To: /SnapDemo/SnapDemo.xcodeproj/project.xcworkspace/xcshareddata/IDETemplateMacros.plist
  5. Replace all file header with the one from the previous step.
  6. Create folder "Views" and move ContentView.swift into it.