发布Flutter packages到pub.dev

1. 创建packages

flutter create --template=package flutter_easy_use_tools

2. 实现功能

lib下创建src文件夹,src文件下的文件是不对外开放的,开放则通过flutter_easy_use_tools.dart来对外开放。

library flutter_easy_use_tools;

export 'src/extension/string_extension.dart';
export 'src/utils/num_util.dart';
export 'src/utils/string_util.dart';
export 'src/widgets/custom_inner_shadow.dart';
image.png
3. 检查pubspec.yaml
name: flutter_easy_use_tools
description: A new Flutter project.
version: 0.0.1
homepage: https://github.com/yuanzhiying/flutter_easy_use_tools
4. 验证packages

$ flutter packages pub publish --dry-run

$ flutter packages pub publish --dry-run
Publishing flutter_easy_use_tools 0.0.1 to https://pub.flutter-io.cn:
|-- .gitignore
|-- .metadata
|-- CHANGELOG.md
|-- LICENSE
|-- README.md
|-- lib
|   |-- extension
|   |   '-- string_extension.dart
|   |-- flutter_easy_use_tools.dart
|   '-- widgets
|       '-- custom_inner_shadow.dart
|-- pubspec.yaml
'-- test
    '-- flutter_easy_use_tools_test.dart

Package has 0 warnings.

5. 发布packages

执行flutter packages pub publish,点击其中链接浏览器打开授权,需要登录谷歌账号。

先用命令测试能否访问谷歌:$ curl www.google.com

$ flutter packages pub publish
Publishing flutter_easy_use_tools 0.0.1 to https://pub.flutter-io.cn:
|-- .gitignore
|-- .metadata
|-- CHANGELOG.md
|-- LICENSE
|-- README.md
|-- lib
|   |-- extension
|   |   '-- string_extension.dart
|   |-- flutter_easy_use_tools.dart
|   '-- widgets
|       '-- custom_inner_shadow.dart
|-- pubspec.yaml
'-- test
    '-- flutter_easy_use_tools_test.dart

Publishing is forever; packages cannot be unpublished.
Policy details are available at https://pub.dev/policy

Do you want to publish flutter_easy_use_tools 0.0.1 (y/N)? y
Pub needs your authorization to upload packages on your behalf.
In a web browser, go to https://accounts.google.com/o/oauth2/auth?access_type=offline&approval_prompt=force&response_type=code&client_id=818368855108-8grd2eg9tj9f38os6f1urbcvsq399u8n.apps.googleusercontent.com&redirect_uri=http%3A%2F%2Flocalhost%3A58974&code_challenge=Nc8EH9vceyITk7SeK9H9iEXvcPTlLxzBLhFWE9zwnm0&code_challenge_method=S256&scope=openid+https%3A%2F%2Fwww.googleapis.com%2Fauth%2Fuserinfo.email
Then click "Allow access".

Waiting for your authorization...

发布成功的情况:

$ flutter packages pub publish
Publishing flutter_easy_use_tools 0.0.1 to https://pub.dartlang.org:
|-- .gitignore
|-- .metadata
|-- CHANGELOG.md
|-- LICENSE
|-- README.md
|-- lib
|   |-- extension
|   |   '-- string_extension.dart
|   |-- flutter_easy_use_tools.dart
|   '-- widgets
|       '-- custom_inner_shadow.dart
|-- pubspec.yaml
'-- test
    '-- flutter_easy_use_tools_test.dart
Downloading vector_math 2.1.0...

Publishing is forever; packages cannot be unpublished.
Policy details are available at https://pub.dev/policy

Do you want to publish flutter_easy_use_tools 0.0.1 (y/N)? y
Uploading...
Successfully uploaded package.

如果使用了代理,则需要在客户端上执行终端代理命令:
我的代理命令如下:
export HTTP_PROXY=http://127.0.0.1:1081; export HTTPS_PROXY=http://127.0.0.1:1081; export ALL_PROXY=socks5://127.0.0.1:1080

执行完之后,再执行发布命令。

6. 查看自己发布的packages

使用谷歌账号,登录网站:https://pub.dev/

查看自己发布的插件:


image.png

搜索自己发布的插件:


image.png

7. 更新插件

编写完新的插件代码后:
① 修改pubspec.yaml文件中的version: 0.0.1version: 0.0.2

image.png

CHANGELOG.md增加更新日志,最新版本在最上面。

image.png
image.png

③ 修改README.md文件。
④ 提交git代码,添加tag
$ flutter packages pub publish 重新发布。

8. 为插件添加example

packages目录下,创建example项目。
添加插件到example

dependencies:
  flutter:
    sdk: flutter

  flutter_easy_use_tools:
    path: ../

example中使用:

import 'package:flutter_easy_use_tools/flutter_easy_use_tools.dart';

packages页面查看:

image.png

9. 插件问题完善

在我的插件后台可以看到插件不完善和不规范的地方,可以完善以提高评分。


image.png

image.png

代码格式化执行命令:flutter format .

$ flutter format .
Formatting directory .:
Unchanged example/lib/main.dart
Unchanged example/test/widget_test.dart
Unchanged lib/flutter_easy_use_tools.dart
Formatted lib/src/extension/string_extension.dart
Formatted lib/src/utils/num_util.dart
Formatted lib/src/utils/string_util.dart
Formatted lib/src/widgets/custom_inner_shadow.dart
Unchanged test/flutter_easy_use_tools_test.dart

10. 避免通过package:flutter_easy_use_tools/src/...方式来使用插件。

应该通过插件提供的对外文件来使用:
import 'package:flutter_easy_use_tools/flutter_easy_use_tools.dart';

image.png
image.png

11. 为packages创建文档

使用 dart doc 可以为 Library 生成 API 文档。
dartdoc 解析源文件去查找使用 /// 语法标注的文档注释。
进入packages根目录,执行dart doc .命令。

$ dart doc .
Documenting flutter_easy_use_tools...

dartdoc failed: Top level package requires Flutter but FLUTTER_ROOT environment variable not set.

执行失败。
查看FLUTTER_ROOT

$ echo $FLUTTER_ROOT

添加FLUTTER_ROOT

image.png

添加FLUTTER_ROOT,执行,查看。

$ source ~/..bash_profile

$ echo $FLUTTER_ROOT
/Users/yuanzhiying/fvm/versions/stable
$ dartdoc
Documenting flutter_easy_use_tools...
Initialized dartdoc with 393 libraries in 48.6 seconds
Generating docs for library flutter_easy_use_tools from package:flutter_easy_use_tools/flutter_easy_use_tools.dart...
  warning: flutter_easy_use_tools has no library level documentation comments, from flutter_easy_use_tools: (file:///Users/yuanzhiying/github/flutter_easy_use_tools/lib/flutter_easy_use_tools.dart:1:9)
Validating docs...
Found 1 warning and 0 errors.
Documented 1 public library in 2.6 seconds
Success! Docs generated into /Users/yuanzhiying/github/flutter_easy_use_tools/doc/api
image.png
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,922评论 6 497
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,591评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,546评论 0 350
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,467评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,553评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,580评论 1 293
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,588评论 3 414
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,334评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,780评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,092评论 2 330
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,270评论 1 344
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,925评论 5 338
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,573评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,194评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,437评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,154评论 2 366
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,127评论 2 352

推荐阅读更多精彩内容