tutorial_package_example 0.0.3

  • Readme
  • Changelog
  • Example
  • Installing
  • 46

Manual de publicar pacotes Pub.Dev

Conteúdo #

  1. Passo à passo
  2. Aprender
  3. Contribuir
  4. Licença

Passo-à-passo #

1. Criar package #

  flutter create --template=package nome_do_pacote

2. Publicar o pacote no GitHub #

3. pubspec.yaml: #

alt_text

Preencher o cabeçalho do pubspec.yaml, por exemplo:


name: nome_do_pacote
description: Package criado para tutorial de publicação no pub.dev
version: 0.0.1
author: Ricardo Raymundo<ricardo_scott94@hotmail.com>
homepage: https://github.com/RicardoRaymundo/nome_do_pacote

É preciso definir sua versão inicial seguindo o padrão de Versionamento Semântico:

MAJOR.MINOR.PATCH = 0.0.0

  • Versão Maior(MAJOR): quando fizer mudanças incompatíveis na API.
  • Versão Menor(MINOR): quando adicionar funcionalidades mantendo compatibilidade.
  • Versão de Correção(PATCH): quando corrigir falhas mantendo compatibilidade.

4. CHANGELOG.md: #

alt_text

Em CHANGELOG.md são registradas as versões do pacote, exemplo:

**## [_Versão_] - Data de alteração**

*Explicações sobre as alterações

5. LICENSE #

alt_text

  • Escolher uma licença open source em choosealicense.com
  • Neste tutorial é usada a licença MIT
  • Registrar a licença no arquivo LICENSE na raiz do pacote

6. Código do pacote #

alt_text

Implementar o código fonte do pacote na pasta lib. Código utilizado

7. Criando o exemplo #

  1. Criar uma aplicação Flutter na pasta exemplo do pacote

alt_text

  1. Importar o package no pubspec.yaml da aplicação

    dependencies:

     ...
     
     nome_do_pacote:
       path: ../
    
    ...  
  1. Publicar o pacote em pub.dev

    Executar o seguinte comando para verificar se há falhas:

```
flutter packages pub publish --dry-run
```
Execute o comando para publicar o pacote:
```
flutter packages pub publish
```
Confirme a publicação pelo seu email e então o pacote está finalmente publicado!

9. Atualizando o pacote #

https://dart.dev/tools/pub/publishing

Antes de executar o comando de atualizar pacote, é preciso atualizar sua versão seguindo o padrão de Versionamento Semântico:

Para atualizar o pacote:

    pub publish

10. Colaboradores #

Para permitir que outros desenvolvedores colaborem:

    pub uploader add ciclano@gmail.com

Para escolher especificamente o pacote para adicionar um colaborador:

    pub uploader --package=package_name add deltrano@example.com

Para remover colaboradores:

    pub uploader remove fulano@hotmail.com

Aprender #

https://medium.com/flutter-community/how-to-create-publish-and-manage-flutter-packages-b4f2cd2c6b90

https://medium.com/nonstopio/create-flutter-package-and-publish-to-dart-packages-timer-button-8a407440a5da

https://dart.dev/guides/libraries/create-library-packages

https://dart.dev/tools/pub/publishing

https://flutter.dev/docs/development/packages-and-plugins/developing-packages

Contribuir #

Contribuições são sempre muito bem vindas! Não precisam ser somente através de desenvolvimento de código, qualquer ajuda com ideias, sugestões, melhorias na documentação e doações são sempre muito apreciadas!

Participe da comunidade Projeto que Vale e colabore da forma que achar melhor.

Licença #

MIT License

Copyright (c) 2018 PROJETO QUE VALE

É concedida permissão, gratuitamente, a qualquer pessoa que obtenha uma cópia deste software e dos arquivos de documentação associados (o "Software"), para negociar o Software sem restrições, incluindo, sem limitação, os direitos de uso, cópia, modificação e fusão , publicar, distribuir, sublicenciar e / ou vender cópias do Software, e permitir que as pessoas a quem o Software é fornecido o façam, sujeitas às seguintes condições:

O aviso de copyright acima e este aviso de permissão devem ser incluídos em todas as cópias ou partes substanciais do Software.

O SOFTWARE É FORNECIDO "NO ESTADO EM QUE SE ENCONTRA", SEM NENHUM TIPO DE GARANTIA, EXPRESSA OU IMPLÍCITA, INCLUINDO, MAS NÃO SE LIMITANDO ÀS GARANTIAS DE COMERCIALIZAÇÃO, ADEQUAÇÃO A UM FIM ESPECÍFICO E NÃO VIOLAÇÃO. EM NENHUMA CIRCUNSTÂNCIA, OS AUTORES OU PROPRIETÁRIOS DE DIREITOS DE AUTOR PODERÃO SER RESPONSABILIZADOS POR QUAISQUER REIVINDICAÇÕES, DANOS OU OUTRAS RESPONSABILIDADES, QUER EM ACÇÃO DE CONTRATO, DELITO OU DE OUTRA FORMA, DECORRENTES DE, OU EM CONEXÃO COM O SOFTWARE OU O USO OU OUTRAS NEGOCIAÇÕES NO PROGRAMAS.

[Versão] - Data de alteração

  • Explicações sobre as alterações

[0.0.3] - 19/11/2019.

  • README.md atualizado e padronizado

[0.0.2] - 19/11/2019.

  • Algo foi atualizado

[0.0.1] - 18/11/2019.

  • Pacote criado no pub dev

example/README.md

example #

Código de exemplo do pacote deste tutorial

Getting Started #

This project is a starting point for a Flutter application.

A few resources to get you started if this is your first Flutter project:

For help getting started with Flutter, view our online documentation, which offers tutorials, samples, guidance on mobile development, and a full API reference.

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  tutorial_package_example: ^0.0.3

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter pub get

Alternatively, your editor might support flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:tutorial_package_example/tutorial_package_example.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
0
Health:
Code health derived from static analysis. [more]
99
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
82
Overall:
Weighted score of the above. [more]
46
Learn more about scoring.

We analyzed this package on Jan 16, 2020, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.7.0
  • pana: 0.13.4
  • Flutter: 1.12.13+hotfix.5

Health issues and suggestions

Document public APIs. (-1 points)

4 out of 4 API elements have no dartdoc comment.Providing good documentation for libraries, classes, functions, and other API elements improves code readability and helps developers find and use your API.

Maintenance suggestions

Package is pre-v0.1 release. (-10 points)

While nothing is inherently wrong with versions of 0.0.*, it might mean that the author is still experimenting with the general direction of the API.

The package description is too short. (-8 points)

Add more detail to the description field of pubspec.yaml. Use 60 to 180 characters to describe the package, what it does, and its target use case.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.1.0 <3.0.0
flutter 0.0.0
Transitive dependencies
collection 1.14.11 1.14.12
meta 1.1.8
sky_engine 0.0.99
typed_data 1.1.6
vector_math 2.0.8
Dev dependencies
flutter_test