iOS基础知识之podspec

2022-07-04  本文已影响0人  谢二九

简介

spec描述了一个pod库的版本。它包括有关应从何处获取源、使用什么文件、要应用的构建设置以及其他一般元数据(如其名称、版本和描述)的详细信息。
官方文档:https://guides.cocoapods.org/syntax/podspec.html

详情

#
#  Be sure to run `pod spec lint XXFramework.podspec' to ensure this is a
#  valid spec and to remove all comments including this before submitting the spec.
#
#  To learn more about Podspec attributes see https://guides.cocoapods.org/syntax/podspec.html
#  To see working Podspecs in the CocoaPods repo see https://github.com/CocoaPods/Specs/
#

Pod::Spec.new do |spec|

  # ―――  Spec Metadata  ―――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
  #
  #  These will help people to find your library, and whilst it
  #  can feel like a chore to fill in it's definitely to your advantage. The
  #  summary should be tweet-length, and the description more in depth.
  #

  # 库名称
  spec.name         = "XXFramework"
  # 库版本
  spec.version      = "0.0.1"
  # 库描述
  spec.summary      = "A short description of XXFramework."

  # This description is used to generate tags and improve search results.
  #   * Think: What does it do? Why did you write it? What is the focus?
  #   * Try to keep it short, snappy and to the point.
  #   * Write the description between the DESC delimiters below.
  #   * Finally, don't worry about the indent, CocoaPods strips it!
  # 库详细介绍
  spec.description  = <<-DESC
                   DESC
  # 主页,这里要填写可以访问到的地址,不然验证不通过
  spec.homepage     = "http://EXAMPLE/XXFramework"
  # 截图
  # spec.screenshots  = "www.example.com/screenshots_1.gif", "www.example.com/screenshots_2.gif"


  # ―――  Spec License  ――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
  #
  #  Licensing your code is important. See https://choosealicense.com for more info.
  #  CocoaPods will detect a license file if there is a named LICENSE*
  #  Popular ones are 'MIT', 'BSD' and 'Apache License, Version 2.0'.
  #
  
  # 开源协议,一般选择MIT
  spec.license      = "MIT (example)"
  # spec.license      = { :type => "MIT", :file => "FILE_LICENSE" }


  # ――― Author Metadata  ――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
  #
  #  Specify the authors of the library, with email addresses. Email addresses
  #  of the authors are extracted from the SCM log. E.g. $ git log. CocoaPods also
  #  accepts just a name if you'd rather not provide an email address.
  #
  #  Specify a social_media_url where others can refer to, for example a twitter
  #  profile URL.
  #
  # 作者信息
  spec.author             = { "gurisxie" => "279483595@qq.com" }
  # Or just: spec.author    = "gurisxie"
  # spec.authors            = { "gurisxie" => "279483595@qq.com" }
  # spec.social_media_url   = "https://twitter.com/gurisxie"

  # ――― Platform Specifics ――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
  #
  #  If this Pod runs only on iOS or OS X, then specify the platform and
  #  the deployment target. You can optionally include the target after the platform.
  #
  # 平台描述
  # spec.platform     = :ios
  # spec.platform     = :ios, "5.0"

  #  When using multiple platforms
  # spec.ios.deployment_target = "5.0"
  # spec.osx.deployment_target = "10.7"
  # spec.watchos.deployment_target = "2.0"
  # spec.tvos.deployment_target = "9.0"


  # ――― Source Location ―――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
  #
  #  Specify the location from where the source should be retrieved.
  #  Supports git, hg, bzr, svn and HTTP.
  #
  
  # 项目地址,不支持ssh的地址,验证不通过,只支持HTTP和HTTPS,最好使用HTTPS
  spec.source       = { :git => "http://EXAMPLE/XXFramework.git", :tag => "#{spec.version}" }


  # ――― Source Code ―――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
  #
  #  CocoaPods is smart about how it includes source code. For source files
  #  giving a folder will include any swift, h, m, mm, c & cpp files.
  #  For header files it will include any header in the folder.
  #  Not including the public_header_files will make all headers public.
  #

  # 代码源文件地址,**/*表示Classes目录及其子目录下所有文件
  # 如果有多个目录下则用逗号分开,如果需要在项目中分组显示,这里也要做相应的设置
  spec.source_files  = "Classes", "Classes/**/*.{h,m}"
  # 可设置不包含的文件
  spec.exclude_files = "Classes/Exclude"
  # 公开头文件地
  # spec.public_header_files = "Classes/**/*.h"


  # ――― Resources ―――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
  #
  #  A list of resources included with the Pod. These are copied into the
  #  target bundle with a build phase script. Anything else will be cleaned.
  #  You can preserve files from being cleaned, please don't preserve
  #  non-essential files like tests, examples and documentation.
  #
  # 源文件地址
  # spec.resource  = "icon.png"
  # spec.resources = "Resources/*.png"

  # spec.preserve_paths = "FilesToSave", "MoreFilesToSave"


  # ――― Project Linking ―――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
  #
  #  Link your library with frameworks, or libraries. Libraries do not include
  #  the lib prefix of their name.
  #
  # 该pod依赖的系统framework,多个用逗号隔开
  # spec.framework  = "SomeFramework"
  # spec.frameworks = "SomeFramework", "AnotherFramework"
  
  # 该pod依赖的系统library,多个用逗号隔开
  # spec.library   = "iconv"
  # spec.libraries = "iconv", "xml2"


  # ――― Project Settings ――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
  #
  #  If your library depends on compiler flags you can set them in the xcconfig hash
  #  where they will only apply to your library. If you depend on other Podspecs
  #  you can include multiple dependencies to ensure it works.
  
  # 是否使用ARC,如果指定具体文件,则具体的文件使用ARC
  # spec.requires_arc = true

  # buildsetting相关设置
  # spec.xcconfig = { "HEADER_SEARCH_PATHS" => "$(SDKROOT)/usr/include/libxml2" }
  
  # 依赖关系,该项目所依赖的其他库,如果有多个需要填写多个s.dependency
  # spec.dependency "JSONKit", "~> 1.4"

  # 定义子库例子
  spec.subspec 'XXChildFramework' do |ss|
      #引入XXChildFramework中所有资源文件
       ss.source_files = 'XXChildFramework/Classes/**/*'
     #公开XXChildFramework模块中的头文件
       ss.public_header_files = 'XXChildFramework/Classes/publicHeader/*.h'
  end

end
###以下是上面代码的功能注解

s.name: 
名称
pod search 搜索的关键词,一定要和.podspec的名称一样,否则报错
s.version: 
版本号
s.ios.deployment_target: 
支持的pod最低版本
s.summary: 
简介
s.homepage: 
项目主页地址
s.license: 
开源协议(创建github库的时候选择的)
s.author: 
作者信息(这里随便谢谢也可以通过)
s.social_media_url: 
社交网址
s.source: 
项目的地址
s.source_files: 
需要包含的源文件
s.resource: 
资源文件,单个
s.resources: 
资源文件(含bundle)
s.vendored_frameworks: 
包含的framework,也就是我们自己制作的pod
s.requires_arc: 
是否支持ARC
s.dependency: 
依赖库,不能依赖未发布的库.如AFNetWorking
s.description: 
描述,字数要比s.summary长
s.screenshots: 
截图
s.exclude_files: 
隐藏的文件
s.public_header_files: 
公开的头文件
s.framework: 
所需的framework,单个
s.frameworks: 
所需的framework,多个用逗号隔开
s.library 
引用的静态库
s.libraries 
引用的静态库,多个用逗号隔开
s.vendored_libraries: 
引用自己生成的.a
s.vendored_frameworks: 
引用自己生成的.framework,多个用逗号隔开
s.dependency: 
依赖的库
s.ios.deployment_target 
iOS部署版本
上一篇下一篇

猜你喜欢

热点阅读