項目名稱淑际,必填字端
name: new_project
版本號,非必填
若需要將項目托管在pub.dev則該字段必填稚晚。
version: 1.1.0
項目描述做祝,非必填
若需要將項目托管在pub.dev則該字段必填。
description: >-
xxxxx
項目主頁蠕啄,非必填
該項目的介紹主頁场勤,填寫域名
homepage: https://example.com/xxx
開發(fā)文檔位置,非必填
與homepage
不同介汹,若該項目還包含其他文檔,可以將文檔的地址添加到該節(jié)點下舶沛。如果項目托管在pub.dev嘹承,該節(jié)點顯示項目的API信息。
documentation: https://example.com/xxx/docs
項目的遠(yuǎn)程庫如庭,非必填
若該項目是lib或開源庫叹卷,這個配置文件用于關(guān)聯(lián)庫的來源地址,最好填寫有效的地址坪它,否則會無法關(guān)聯(lián)獲取項目骤竹。
repository: https://github.com/<user>/<repository>
問題追蹤頁面,非必填
若該項目是一個開源且隨時更新的項目往毡,可以通過填寫該屬性蒙揣,標(biāo)明該項目的問題追蹤文檔站點,如果使用pub.dev來進(jìn)行項目托管开瞭,則pub.dev將嘗試通過該字段顯示該項目的問題跟蹤鏈接懒震。若該項目托管在github,則可以將該字段填寫為github的issues
issue_tracker: https://github.com/<user>/<repository>/issues
項目的第三方插件依賴嗤详,在這個標(biāo)簽中列出了該項目正常工作所需的每一個軟件包與版本个扰。以下通過實例詳解該標(biāo)簽的詳情
dependencies:
實例1 直接寫明約束版本,若該插件是發(fā)布在https://pub.dev/ 之上葱色,IDE會直接在項目目錄下執(zhí)行flutter packages get
來下載其插件的最新版本
xxx:
實例2 該插件是在實例1的基礎(chǔ)上進(jìn)行延伸递宅,其中^1.4.0
的含義是約束了版本號,也就是在該項目中,需要使用1.4.0版本
xxx: ^1.4.0
實例3 若該插件未部署在pub.dev之上办龄,則可以通過URL來指定出插件下載的源
xxx:
hosted:
name: xxx
url: http://some-package-server.com
實例4 基于實例3烘绽,其中version表明了使用該插件的版本信息
xxx:
hosted:
name: xxx
url: http://some-package-server.com
version: ^1.4.0
實例5 若該插件是發(fā)布在git上,可以用以下方式來進(jìn)行插件獲取土榴,默認(rèn)獲取master下代碼
xxx:
git:
url: git://github.com/kean_qi/xxx.git
實例6 基于實例5诀姚,其中ref標(biāo)明獲取的分支信息
xxx:
git:
url: git://github.com/kean_qi/xxx.git
ref: some-branch
實例7 基于實例5,若插件只是在項目中的某一個目錄中玷禽,可以通過path來指定插件位置
xxx:
git:
url: git://github.com/kean_qi/xxx.git
path: path/to/kittens
實例8 若插件在本地某一目錄赫段,可以通過指定path來找到該插件
xxx:
path: /Users/username/xxx
指定版本,若該項目使用的插件需要約束版本矢赁,則方法如下
實例1 在該項目中糯笙,此插件指定版本為1.4.0
xxx: ^1.4.0
實例2 在該項目中,此插件最低版本為1.2.3
xxx: ">=1.2.3"
實例3 在該項目中撩银,此插件最低支持2.0.0版本给涕,但不支持3.0.0以上版本
xxx: ">=2.0.0 <3.0.0"
實例4 在該項目中,此插件最高支持到1.2.3以下版本
xxx: "<1.2.3"
指定Flutter SDK
實例1 項目必填項额获,指定SDK够庙,并獲取SDK最新版
flutter:
sdk: flutter
實例2 基于實例1,指定SDK版本號
flutter:
sdk: flutter
version: ">=2.0.0-dev.68.0 <3.0.0"
實例3 另外一種寫法
flutter_driver:
sdk: flutter
version: ^0.0.1
區(qū)別于dependencies標(biāo)簽抄邀,dependencies是生產(chǎn)環(huán)境依賴庫版本耘眨,dev_dependencies是開發(fā)環(huán)境依賴庫版本,該環(huán)境僅在開發(fā)調(diào)試時使用境肾。標(biāo)簽規(guī)則同dependencies剔难。
dev_dependencies:
xxx: ^1.4.0
重寫依賴包,會強(qiáng)制下載對應(yīng)依賴包奥喻,并可以對該依賴包進(jìn)行重寫偶宫。
dependency_overrides:
xxx: ^1.4.0
Dart2開始需要添加該標(biāo)簽,聲明該項目是基于dart的SDK哪個版本進(jìn)行編譯环鲤,隨著dart平臺的發(fā)展纯趋,可能在某個版本后不再向下兼容,所以這個標(biāo)簽約束了使用dart的版本
例冷离,以下約束說明此項目僅適用于2.0到3.0的dart2 SDK編譯结闸。
environment:
sdk: '>=2.0.0 <3.0.0'
可以將Dart2的可執(zhí)行腳本引入到flutter之中,作為插件使用酒朵,但前提是這些腳本均可以在命令行正常調(diào)用桦锄。
executables:
<name-of-executable>: <Dart-script-from-bin>
指定生成發(fā)布包的位置
非必填
若不填寫,則默認(rèn)使用pub.dev站點進(jìn)行發(fā)布蔫耽,但若希望阻止發(fā)布结耀,則需要聲明為none留夜。
同時此設(shè)置可以將flutter項目發(fā)布到自定義的服務(wù)器之中。
publish_to: none
項目中配置聲明方式
用于在項目中添加資源图甜、設(shè)置字體碍粥、配置插件參數(shù)等。
flutter:
# 實例1 添加資源
assets:
- images/park.jpg
#設(shè)置字體黑毅,樣式嚼摩,可以通過聲明family來設(shè)置字體分組
fonts:
- family: Schyler
fonts:
- asset: fonts/Schyler-Regular.ttf
- asset: fonts/Schyler-Italic.ttf
style: italic
- family: Trajan Pro
fonts:
- asset: fonts/TrajanPro.ttf
- asset: fonts/TrajanPro_Bold.ttf
weight: 700
其他聲明方式
實例1 定義常量
age: 22
boolitem: true
name: 'hello'
實例2 定義數(shù)組
server:
- aaaaaa
- bbbbbb
- dddddd