Swift Package 设置 file header

今天给自己的 Swift Package 仓库新增文件的时候,发现文件头的作者、时间、copy right 等信息不太全,一时兴起研究了一下。

一般来说,给 Xcode Project 新增文件时会带上 organization name。但是单独打开 Swift Package 时,是没有办法设置 organization name 的。这样新建的文件头部就会光秃秃的,不甚美观

一番研究之后发现,可以这样设置 Swift Package 的 file header:

  1. 首先新建一个 IDETemplateMacros.plist 文件,并写入下面的内容:
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" 
 "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
 <plist version="1.0">
 <dict>
 	<key>FILEHEADER</key>
 	<string>
 //  ___FILENAME___
 //  Your Package Name
 // 
 //  Created by ___FULLUSERNAME___ on ___DATE___.
 //  Copyright © 2021 Your Name Or Company. All rights reserved.
 //</string>
 </dict>
 </plist>
  1. 把上面这个文件放到下面这个路径里面:
<Your Package Root>/.swiftpm/xcode/package.xcworkspace/xcuserdata/userName.xcuserdatad/IDETemplateMacros.plist

.swiftpm 是个隐藏文件夹

注意,package.xcworkspace 需要显示包内容,进到里面去。

file header

这样就能自定义文件头了。而且还可以参考官方文档,添加更多信息。


2023/12/6 更新

新建的 Swift Package 需要双击 Package.swift,用 Xcode 打开一下,才会出现 .swiftpm 这个文件夹。

如果觉得上面步骤很繁琐的话,可以尝试一下我写的小工具:SPCreator